How to Generate Documentation for Workflow in OnBase

Wondering how to generate documentation for an already existing workflow in OnBase? This blog and the demo video below will show you how.

Generating Documentation for Workflow in OnBase

How to Generate Documentation for Workflow in OnBase

OnBase Studio has the ability to generate documentation based on the configuration of life cycles. Let’s dive into the various steps that’ll let you do just that.

1. To start off, you want to select your life cycle.
2. To create documentation for a life cycle, either click the create documentation button on the lifecycle ribbon group, or right-click on the life cycle in the repositories pane with the Workflow Tab and select “create documentation.”
3. Select either “Administration Guide” or “User Guide”. If you created a custom template, that template will be available for selection as well. For this video example, we selected “Administration Guide”. Then, click “next.”
4. Know that multiple life cycles can be included in a document. If you had a life cycle selected, that lifecycle would display in the top. You can add a life cycle by selecting the life cycle from the drop down list and clicking “add.”

If you select multiple life cycle, each life cycle is documented in a separate section in the generated document. Know that you can arrange the life cycles you have added using the sort alphabetically, and the move up and move down buttons. You can also remove life cycles from the documentation generation by selecting the life cycles you want to remove, and clicking “remove.”

5. When the appropriate life cycles are selected, click “next.”
6. Enter the appropriate solution parameters. Administration Guides have the following parameters: solution name and user forms location. On the other hand, user guides only have the solution name parameter. The solution name parameter is the name of the solution, and it 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. We decided to call ours documentation for the video example.
7. Then click next and choose one or both of the following options to store generated documents: File name saves the document to the specified file. Click browse and specify the location and file name to use it to save the generated document.

The archive document archives the document in OnBase. You can select a document type and enter a description for the generated document. If you want the document to display after generation, select the displayed generated document option. Click “finish.”

8. If you navigate to the directory, you can see that the guide has been saved in the documents, and you’re finished.

Want to Expand your OnBase Knowledge?

Bookmark our Question Corner playlist on YouTube. Every other week, we add a new OnBase demo led by experts from the Naviant Customer Success Team. Each demo is 3-10 minutes long and answers questions frequently asked by OnBase users like you.

View Playlist

Want More Content Like This?

Subscribe to the Naviant Blog. Each Thursday, we’ll send you a recap of our latest info-packed blog so you can be among the first to access the latest trends and expert tips on workflow, intelligent automation, the cloud, and more.