Working with Documents

Documents (Definitions > Documents) provide a convenient space for you to keep notes. For example, you can use them to store:

  • Procedures

  • Pseudocode

  • High-level design notes

The tabs available are as follows.

  • Document: Lets you name the Document and specify a Format.

  • Content: Lets you upload or enter content.

  • Documentation: The standard Documentation screen.

Referring to Documents from Other Objects

You might want to refer to a Document by its path in some situations. For example:

  • When sending an email, you can supply the email body by specifying the path of the Document that contains it.

  • You can document an Object in a Document, and then specify the Document's path in the Object's Documentation tab. This allows you to (for example) document the Object with HTML instead of plain text. When the Object is selected, the Document displays as a clickable link in the Detail View.

You can specify the full path of a Document like so:

doc:[<doc_partition>:][/<partition>.<application>]*/<name>.<extension>

The components of the path are:

  • <doc_partition>: The Partition of the Document. Defaults to GLOBAL.
  • <partition>: The Partition of the Application that contains the Document (if any).
  • <application>: The name of the Application. Applications are hierarchical, and all Applications in the hierarchy must be specified.
  • <name>: The Name of the Document.
  • <extension>: The Document's filename extension. This should match the Format specified for the Document.

So, for example, a Document that is not in a Partition (or in the GLOBAL Partition) and not in an Application might have a path like this:

doc:/DocumentName.html

If a Document is in the REDWOOD partition, and inside a nested Application, it might have a path like this:

doc:REDWOOD:/ParentApplication/ChildApplication/DocumentName.html

To see the full path of a Document, select it in the Documents screen and then look at the Full Path entry in the Detail View.