Scripting - WorkView - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - Premier - external - Premier - OnBase/WorkView/Foundation-24.1/WorkView/Best-Practices/Scripting - 2025-10-15

WorkView

Platform
OnBase
Product
WorkView
Release
Foundation 24.1
License
Premier
ft:locale
en-US
  • Avoid scripting. Always use existing functionality and contact Hyland Software if a feature that requires scripting is reoccurring. Do not script what OnBase can already do. OnBase has a rich native functionality. Prior to writing a script, ensure that existing functionality cannot already accomplish the task.

  • Use names instead of IDs in scripts. When writing scripts, refer to items (attribute, class, filter, application, action, etc) by name rather than ID. This ensures that the same item is referenced if you export/import or clone the application.

  • Add detail header comments to scripts. When writing application, class, or action level scripts add application, class, and action name to the header of the script. Adding this information in the script will make it easier to troubleshoot issues.

  • Use the HasValue property to determine if a value is null. When performing a query in the Unity API, use the HasValue property to check if value exists when getting AttributeValue or FilterColumnValue. Doing this ensures that an exception is not thrown and that expected results are returned.

  • Set the noopener tag for hyperlinks linked back to Application Builder or WorkView Client. If the user logs out of the main Web Client window after launching windows with these modules, the Web Client might not detect that fields were changed and log the user out without prompting to save the changes. To avoid the potential issues, set the noopener option for the hyperlinks.