Skip to main content

Administrative Tools for OnBase integration

Viewing Documents created as part of a form submission​

The Forms module provides an administrative interface for viewing details of any forms that have been submitted. For forms which create Documents in OnBase, the ribbon at the top of the page shows the ids of the Documents which were created.

OnBase Document ids in Received Forms interface

If the OnBase Quick Access Viewer URL is configured within Integrations Hub, within the Actions menu on that page, there will also be a link to view each created Document in OnBase, which will open (in a new browser tab) the Document to view in Quick Access Viewer.

OnBase Document links in Received Forms interface

Viewing WorkView Objects created as part of a form submission​

The Forms module provides an administrative interface for viewing details of any forms that have been submitted. For forms which create Objects in WorkView, the ribbon at the top of the page shows the keys of the Objects which were created.

WorkView Object keys in Received Forms interface

Troubleshooting​

When viewing a form submission in the Received Forms interface, the Logs tab allows administrators to view the actions that have been executed on submission of the form, including any actions which create or update Documents or WorkView Objects in OnBase.

The list view will indicate for each action whether it succeeded or failed, and clicking the View details link will provide more information which can be helpful for diagnosing any issues such as connectivity with OnBase, incorrect form mappings and/or insufficient validation within the form.

Received Forms action logs

Where possible, the last request made to the OnBase API in order to execute the action will be logged, and in the case of an error being received from that request, the response from the API will also be logged.

Example failed action part 1

...

Example failed action part 2

Often the OnBase API does not return detailed error messages in API responses to aid diagnosis a failed request. In this scenario it is often necessary to run OnBase Diagnostics Console whilst the relevant action is being carried out through the Jadu Central instance, in order to track down the actual error being thrown in OnBase. It is also worth noting that some errors triggered via the API do not get filtered onto the "Errors" tab of Diagnostics Console, but may still be present in the overall trace.

Common issues​

Unable to create a Filter Configuration for a specific Filter​

Check that the Filter has been added to a Filter Bar (within WorkView) that the API user has access to.

Unable to create/upload Documents with an error logged similar to the below​

Typical error log when OnBase Temp File Service is not installed / configured correctly This error is often seen when the OnBase Temp File Service is not installed or configured correctly, this is required by the OnBase REST API to enable upload of Documents. Please refer to Hyland's documentation for how to set this up.

Attribute isn't appearing to map to or getting the error "Requested Class with provided attributes was not found" when creating or updating a WorkView object​

An attribute must be added to a WorkView View or Filter that the API user has access to.

An attribute must also be "mutable", which OnBase defines as:

"If the Attribute is not through a relationship, on an external class that allows edits, not the target of a Class Trigger, and not a calculated Attribute."

Changes made in OnBase Configuration or Studio are not seen in Jadu​

Ensure you have "reset the OnBase server cache" (or recycled the relevant Application pools).

Configuration data (Document Types, Keyword Types, WorkView Applications/Classes/Filters, etc.) are cached in Jadu to reduce the number of OnBase API requests needed and improve performance. This is a time-based cache with the amount of time to cache data for, configured within Integrations Hub. If you do not wish to wait for this time to elapse, re-saving the integration settings will clear the cache immediately, however please be aware that this will increase the number of OnBase API requests until the caches have been re-populated, so you may want to avoid doing it during peak usage (of both the portal and OnBase).