Creating the Integration Widget in Trimble Unity Respond or Cityworks Respond - Creating the Integration Widget in Trimble Unity Respond or Cityworks Respond - To enable document management between OnBase and Trimble Unity Respond or Cityworks Respond, configure the OnBase integration widget in Trimble Unity Style or Cityworks Style. This widget enables the direct retrieval and import of task-related documents from OnBase as well as access to Plan Review projects in the Unity Client. - OnBase - Integration for Trimble Unity - OnBase/Integration-for-Trimble-Unity/Foundation-26.1/Integration-for-Trimble-Unity-and-Cityworks/Trimble-Unity-Respond-and-Cityworks-Respond/Configuration/Creating-the-Integration-Widget-in-Trimble-Unity-Respond-or-Cityworks-Respond - Foundation 26.1 - Foundation 26.1

Integration for Trimble Unity and Cityworks

Platform
OnBase
Product
Integration for Trimble Unity
Release
Foundation 26.1
License
ft:lastPublication
2026-09-11T18:09:29.335000
ft:locale
en-US

To enable document management between OnBase and Trimble Unity Respond or Cityworks Respond, configure the OnBase integration widget in Trimble Unity Style or Cityworks Style. This widget enables the direct retrieval and import of task-related documents from OnBase as well as access to Plan Review projects in the Unity Client.

To create the OnBase integration widget in Trimble Unity or Cityworks:

  1. Do one of the following:
    • If using Trimble Unity Respond, access the Trimble Unity Respond portal as a Trimble administrator by entering your Trimble URL in a browser.
    • If using Cityworks Respond, access the Cityworks Respond portal as a Cityworks administrator by entering your Cityworks URL in a browser.
  2. Log on using your credentials.
  3. From the side menu, select My Apps > Style.
    The Trimble Unity Style or Cityworks Style window is displayed.
  4. From the Plugin drop-down list, select Respond.
  5. From the Profile drop-down list, select the profile where you want the widget to be displayed.
  6. From the Layout drop-down list, select the name of the layout to which a widget should be added.
    The OnBase integration widget can be placed in the following layouts:
    • Work Order Edit
    • Service Request Edit
    • Inspection Edit
    • Case Object - Detail
  7. From the Control Details section in the lower-left corner of the page, select Insert Widget.
    A new widget is displayed at the bottom of the Controls section.
  8. Double-click the new widget.
    The widget configuration dialog box is displayed.
  9. From the Widget Type drop-down list, select Link.
  10. In the Widget Name field, modify the widget's name.
  11. In the TYPESCRIPT section, enter code for the integration widget.
    Note: A complete sample TypeScript file can be found in Hyland Community or provided by Hyland Support.

    The provided TypeScript code invokes the Application Client Connector and DocPop URLs for the OnBase Web Server to establish integration between Trimble Unity Respond or Cityworks Respond and OnBase. For more information on these modules, see the Application Client Connector and DocPop documentation.

  12. In the CSS section, enter code for the integration widget.
    Note: A complete sample CSS file can be found in Hyland Community or provided by Hyland Support.
  13. Click Save.
    All the changes are saved.
  14. Click Close.
    The configured button is added to the Control Details list in the lower-left corner of the page.
The integration widget is created in the form of the View Documents and Import Documents buttons and displayed on each task in Trimble Unity Respond or Cityworks Respond. The Open in Plan Review button is displayed only when viewing PLL cases.

To activate the Open in Plan Review button functionality, configure the Unity Client configuration file. For more information on this procedure, see Configuring the Unity Client Configuration File.

After the OnBase integration widget is configured, the integration between OnBase and Trimble Unity Respond or Cityworks Respond is successfully established. To use this integration, see Usage.