Documents

Whether they be insurance quotes, financial reports, or utility bills, most people use some sort of document during their daily lives. Documents are used to deliver useful information in a specific format, often with some kind of branding or house style applied.

KnowledgeKube lets you associate documents with a specific model, causing them to be uploaded to the model's repository. The model can then make use of these documents, typically by allowing end users to access them in some way.

Uploaded documents are bound to a single model . If you want more than one model to be able to access a particular document, you will need to upload a distinct copy to each one.

When a document has been uploaded, it is known as a Document Item. Every KnowledgeKube document item is given a unique Keyword, although this can be changed if necessary. A document item's keyword is used any time you need the host model to refer to the item in some way.

To access a list of documents in the current model, click in the Definition tab to open the Manage Documents dialog.

The Manage Documents screen lets you view and modify documents in the current model.

You can filter this list by typing a search term into the Filter field and then pressing Enter. Any item whose name does not include the search term will be hidden.

Filtering the list of documents in your model.

You can make changes to the list using buttons in the window's toolbar.

Use these buttons to add, edit and remove documents in your model.

These buttons are covered in their own topics associated with this section. The remaining buttons in the toolbar relate to Source Control and shared image items in documents.

Source control and shared document image items.

These buttons allow you to do the following:

Name Description
Check Out Document Click to check the selected document item out to you. This button will not be available if the item is already checked out. When a document item is first created, it will automatically be checked out to the person that created it.
Check In Document Click to check the selected document item in. A dialog box will appear, prompting you to enter a check-in comment and, optionally, a reference. After completing the fields provided and clicking Check In, the selected item will be checked back in, making it available to other users. This button will not be available if you do not have the selected item checked out.
View Check In History Click to open the History window for the selected document item. This window contains a complete list of check-in entries for the item, including who has checked it in, when the check-in occurred, and the comments and reference provided during check-in. This window is for information only, and pressing the OK button will close it.
Shared Document Image Items Click to open the Shared Document Items window, which lets you upload and manage images that can be displayed in one or more KnowledgeKube documents in the same repository.

To learn about the Types of documents you can add in your model, refer to the following topics:

Description Further Reading
Definition of static documents. Static Documents
Definition of dynamic documents. Dynamic Documents