Documenting Code, Procedures, and Messages with Documents
You use documents to document procedures or other objects. Documents can also be used for informational messages about down-times, for example. You can use the rich text editor, which needs to be installed once after installation and possibly after upgrades. You can also upload existing documents in various formats, the client computer must have the software to view and/or edit the file. You must make sure that you set the correct mime-type, so that the browser on the client system can open the correct program for the file.
You specify the full path of documents in other objects as follows:
doc:[<doc_partition>:][/<partition>.<application>]*/<name>.<extension>
<doc_partition>- partition of the document; defaults toGLOBAL.<partition>- the partition an application.<application>- the name of an application; since applications are hierarchical, an application can have a parent (and child) application, all applications in the hierarchy must be specified.<name>- the name of the document.<extension>- document extension, depends on the format.
Tabs and Fields
| Tab | Field | Description |
|---|---|---|
| Document | Partition | The partition of the document. |
| Document | Name | The name of the document. |
| Document | Application | The application of the document. |
| Document | Description | The description of the document. |
| Document | Format | The format of the document; the mime-type of the format will define the editor that will be used, if any. |
| Documentation | Documentation | A comment about the document or any other information. |
| Content | Content / Upload | Allows you to upload or edit a file, depending on the chosen format. |
Rich Text Editor
When editing a HTML Document, a link is shown to install the editor if it is not already installed. When you choose this link, the following text is shown:
A third party Rich Text Editor can be installed on your system subject to your agreement to the license terms
at http://ckeditor.com/license.
After agreeing to the license the editor will be installed on your system from http://support.redwood.com. When new versions of the text editor are available, scheduler-administrators will be notified upon login.
Installation requires a connection to the Internet and access to http://support.redwood.com from the server. See support note 96428 for a procedure that can be used if the java server cannot access the internet.
Informational Messages
The message of the day is displayed when users log in to Redwood Server.
You create a document named MessageOfTheDay in the Redwood application in the format HTMLText to display the message at login time. The contents of the Comment tag will be used as the message text, a More link will automatically link to the contents of the message of the day document.
The length of the Comment field is unlimited, the message will be rendered on one line, with a scroll bar if the length of the message exceeds the available space in the user's browser.
Example
A log in message about the downtime of the PR1 system.
| Tab | Field | Value |
|---|---|---|
| Document | Partition | GLOBAL |
| Document | Name | MessageOfTheDay |
| Document | Application | Redwood |
| Document | Format | HTMLText |
| Documentation | Documentation | Greetings, the PR1 system will be unavailable from 15:00 August 21st until 9:00 August 22nd. System Administration Team |
Context-Menu
| Action | Description |
|---|---|
| Edit | Edit the document |
| Edit Security | Edit the security of the document |
| Delete | Delete the document |
| Show permalinks | Show links that can be used from third party applications to link to the |
| Add to navigation bar | Add the current object to the navigation bar. |
| New | Create a new document |
Finding Documents
You can search for documents using filters and the Search Documents box on the Documents tab. This box is known as the IntelliSearch box and located under your username on the top right-hand side of the user interface. Filters allow you to specify a list of objects with static criteria. IntelliSearch allows you to specify complex queries in a simple way using prefixes. Prefixes are used to specify which property you are searching in and have short as well as long syntaxes. For example, if you want to display all documents with the term document in the comment, you would use the search criteria as follows:
c:document
You can search more than one property, as follows:
c:document n:JV
note
No spaces should be entered before or after the colon (:).
See the Advanced Object Search for more information.
The following table illustrates the available prefixes for queues:
| Prefixes | Description |
|---|---|
| n, name | searches the name property |
| c, comment | searches the documentation property |
| d, description | searches the description property |
| a, application | searches the application property |
| cb, changedbefore | (internal) search for documents that changed before a certain ISO-8601 period |
Security
| Privilege | Description |
|---|---|
| Document.Create | Create documents |
| Document.Delete | Delete documents |
| Document.Edit | Edit documents |
| Document.View | Access documents |
You can grant privileges on two levels, Access and Admin; a privilege granted on Admin level allows the grantee to grant the privilege to other users. These privileges can be granted per partition or system-wide.
The Security tab allows you to specify which users can access, edit, and delete the document.
See Also
Message of the day motd