Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [EnsLib] >  [Workflow] >  [FormEngine]
Private  Storage   

class EnsLib.Workflow.FormEngine extends %RegisteredObject

Provides the API for managing form associated with Workflow tasks.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
8


Summary

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnSubmit %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject DrawActionButton DrawHTMLField DrawHTMLForm
HasForm ProcessSubmit ShowAcceptButton ShowActionButtons


Methods

• classmethod %OnSubmit(pSubmit As %ZEN.Submit, Output pMsg As %String) as %Status
Submit handler: this is called by the SubmitHandler on the Zen page handling the submit.
• classmethod DrawActionButton(pAction As EnsLib.Workflow.ActionDefinition, pEnabled As %Boolean = 1)
• classmethod DrawHTMLField(pName As %String, pValue As %String = "", pType As %String = "String", pCaption As %String = "") as %Status
Write out HTML for a specific field. Type is "String",
• classmethod DrawHTMLForm(pTask As EnsLib.Workflow.TaskResponse, pURL As %String = "") as %Status
Writes out HTML for the associated form to the current device.
• classmethod HasForm(pTask As EnsLib.Workflow.TaskResponse) as %Boolean
Determines if this Task has an associated form.
• classmethod ProcessSubmit(pTask As EnsLib.Workflow.TaskResponse) as %Status
Request to save the task form.
• classmethod ShowAcceptButton(pItem As EnsLib.Workflow.Worklist) as %Status
Display Accept Button for this an item.
• classmethod ShowActionButtons(pItem As EnsLib.Workflow.Worklist) as %Status
Displays defined action buttons for a worklist item.


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.