Configuring the Script for Client Side API Script Button - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Premier

WorkView

Platform
OnBase
Product
WorkView
Release
Foundation 24.1
License
Premier

Once an action button associated with a blank client side API action is added to the view, you can configure the script associated with the button. To configure the script:

  1. Select the Scripts tab in the Properties pane.
  2. The OnClick option is the only option available in the Scripts drop-down list.
  3. Set Handler Type to Script.
  4. Click Add. A Javascript Client-Side Action - OnClick tab will display.
  5. Enter the script into the tab.
    Note:

    When setting a boolean value, only True and False are valid values.

DOM manipulation is unsupported. There is nothing stopping access to the DOM and manipulating the HTML directly. Doing this may cause complications when upgrading to new versions of OnBase. Each version changes may be made to the HTML/CSS structure of the views to make sure various browsers are supported. If you access the DOM and rely on certain CSS classes or structures to be in place, these may change in a newer version that breaks your logic.

Directly overriding out CSS classes and styles is not supported. Instead a new class should be created and then applied to elements in the Designer.

Leveraging the internal version of JQuery is unsupported. Several toolkits/frameworks are used for views; jQuery being the most widely known. It is not recommended to use jQuery (see the previous note about DOM manipulation) because the css/html structure/etc may change with new versions. jQuery will be updated with new releases of OnBase. This may cause your scripts to no longer work if they leveraged unsupported jQuery methods.