Implementing UI Actions compatible with both UI16 and Workspace

RyoyaFukuda
Tera Contributor

yesterday

Hi all.
I'm currently facing a challenge regarding the implementation of form UI Actions that function correctly in both UI16 (the classic UI) and Workspace (e.g., Agent Workspace).

What I want to achieve:
I aim to create a UI Action that performs client-side input validation and displays a confirmation dialog when a record's specific state changes, followed by server-side record update processing.

Specific requirement example:

  • On an Incident form, when the "Resolve" button is clicked, check if a Resolution Note has been entered.
  • If the check passes, display a final confirmation dialog to the user.
  • If the user confirms, change the Incident status to "Resolved" on the server-side and save the record.

My current understanding and challenges:

  • There are cases where the behavior of client-side APIs like g_form in UI Action client scripts may differ between UI16 and Workspace (e.g., how messages are displayed, availability of certain methods).
  • I would prefer to use the same codebase as much as possible for both environments, while branching the processing only when necessary for environment-specific behaviors.

Questions:

  1. What are the best practices for implementing a UI Action (form button) that includes client-side scripting and is compatible with both UI16 and Workspace?
  2. Specifically, for client-side input validation and confirmation dialogs, could you advise on compatible scripting methods across both environments, or recommended approaches for environment detection and branching?
    • Is it appropriate to use g_form.isWorkspace() for this purpose?
    • What would be a good strategy for distinguishing between message display methods (g_form.addErrorMessage, alert, etc.)?
  3. If a UI Action alone is insufficient or if more advanced control is needed on the Workspace side, should I consider combining it with Workspace Client Scripts (WSCS) or exploring other approaches (e.g., using UX Framework components)? If so, what considerations should I keep in mind?

Any implementation examples, relevant official documentation, or existing solutions you may know of would be greatly appreciated.

Thank you in advance for your kind assistance.

0 Helpfuls