OnBase Studio has the ability to generate documentation based the configuration of life cycles. OnBase Studio includes administration and user guide templates. Alternatively, you can create your own Microsoft Word templates that OnBase Studio can use.
To create documentation for a life cycle:
-
With the life cycle selected, either click the Create Documentation button on the Life Cycle ribbon group within the Workflow ribbon group or right-click on the life cycle in the Repositories pane within the Workflow tab and select Create Documentation.
- Select either Administration Guide or User Guide. If you created a custom template, that template will be available for selection, as well.
-
Click Next.
-
Multiple life cycles can be included in a document. If you had a life cycle selected, that life cycle will display in the top, selected box. You can add a life cycle by selecting the life cycle from the drop-down list and clicking Add. If you select multiple life cycles, each life cycle is documented in a separate section in the generated document.
Tip:
You can arrange the life cycles you have added using the Sort Alphabetically, Move Up, and Move Down buttons. You can remove life cycles from the documentation generation by selecting the life cycles you want to remove and clicking Remove.
-
When the appropriate life cycles are selected, click Next.
-
Enter the appropriate solution parameters. Administration guides have the following parameters: Solution Name and User Forms Location. User guides have the Solution Name parameter.
The Solution Name parameter is the name of the solution. The Solution Name is the title displayed on the first page of the generated document.
The User Forms Location is the path to where user forms are stored for the solution.
-
Click Next.
-
Choose one or both of the following options to store the generated document:
-
File Name- Saves the document to the specified file. Click Browse and specify the location and filename to use to save the generated document.
-
Archive Document- Archives the document in OnBase. Select a Document Type and enter a Description for the generated document.
-
- If you want the document to display after generation, select the Display generated document option.
-
Click Finish.
Note:
You do not need Microsoft Word to generate documents, but you do need it to view generated documents.
Note:Icons in documentation are limited to a maximum height of 1 inch.