Page tree
Skip to end of metadata
Go to start of metadata

Summary: this page describes how to use the Document-It feature.

Introduction

The Document-It feature allows you to add detailed documentation to a view and also to specific objects or nodes. This documentation is in addition to tags or comments that you can add to your views:

Adding documentation to views using the UI

In all views/modes, you can add one Document per object/node or group of nodes. It is also possible to add one Document per view/application.

To add a Document on an object/node or group of nodes, first select the items you want to Document in the view, then use the left hand menu item:

If you want to add a Document at view/application level, click the Add a document view in the Investigate panel:

The document popup will be displayed - fill in the title, description (i.e. the text you want to add) and optionally a Tag. You can add tags that you have already created using the  icon in the left menu bar, or create the tags directly in the Document:

You can also choose a colour for your Document:

Click Save when complete:

The document is then minimized:

≥ 2.13

to the Documents tab on the right hand side - selecting the entry in the right hand panel will re-display the document:

≤ 2.12

to the bottom left of the screen and can be re-displayed by clicking it:

Bulk importing documentation via .CSV file

It is possible (in CAST Imaging ≥ 2.13) to bulk import documentation using a pre-prepared .CSV file for individual objects. See Admin Center - Bulk importing documents or tags via .CSV file.

Adding documentation to a group of nodes

When you add a Document to a group of nodes, the nodes that were selected will all be highlighted when the Document is redisplayed:

Adding clickable links to documents

Available in ≥ 2.9.0.

It is possible to add a clickable link (or links) in a document:

To add a link, use standard HTML markup as follows:

<a href="https://www.mylink.com">My Link</a>

For example:

Viewing existing documents

You can view existing documents that have been added to a view by selecting the Documents option in the right hand panel:

When a document (in the list) is clicked, it will open the document and if it is an object level document, the associated nodes will be highlighted:

When a node is clicked, the associated document will be highlighted if the document list is open:

To view documents associated with a node even when the Right panel is closed, right click on the context menu of the node and select 'Documents'. This opens the right panel and document/s associated with the seleted node is highlighted.

 

The search bar  enables you to search for a document based on the following:

  • Title
  • Description
  • Tags

Updating or deleting existing documentation

Open the existing documentation, make your changes and then click Save:

Add new nodes/objects/groups of objects to an existing documentation 

You can add new nodes/objects/groups of objects to an existing documentation as follows:

  • Open the existing documentation
  • Hold the CTRL key down and select the additional nodes/objects/groups of objects
  • Make any changes to the documentation itself (this is not required)
  • Click the Save button in the Documentation window to save the changes

Searching existing documentation

It is possible to use the global search function to search documentation that has already been added. See User Guide - Search for items.


  • No labels