Integrate an External UI with the Process Task List

If you’ve configured a human task to use an external UI instead of a web form, the external form is displayed when you select the task in the runtime task list.

If an external form is used for a human task, then the associated external application must provide the action buttons for the task. In addition, when an action is performed within the task, the external UI must make the corresponding REST API call to the Process server and also fire an appropriate JavaScript event to update the runtime task list. The process task list listens to these events and refreshes accordingly.

The following table lists all the JavaScript events an external UI must implement for successful integration with the process task list:

Event	Description	Example Syntax
loaded	The external form sends a loaded event, so that the parent can calculate formHeight.	{source:externalForm, event:loaded, data: {formHeight : 600,showCloseIcon : true,showResizeIcon : true} }
reload	The external form requests to reload itself, without refreshing the task list.	{source:externalForm, event:reload, data: FUTURE}
close	The external form requests to close itself, without refreshing task the list.	{source:externalForm, event:close, data: FUTURE}
done	The external form requests to close itself after an action, and it also requests to refresh the task list.	{source:externalForm, event:done, data: {actionId : ACTION_ID}}

To configure a human task with an external UI, see:

• Use an External UI to Display Task Information for structured processes.

• Associate an External UI for dynamic processes.