Add a Linked UI Connection

A linked UI connection identifies the URL to connect to, and its parameters so you can use the connection in a human task.

1. In a process application, click Add.
2. In the Add component pane, expand UIs, and select Linked UI.
3. Enter a title for the linked UI connection in the Title field, and click Create.
4. Open the new connection.
5. In the Endpoint field, provide the base URL of the UI you want to connect to.

   Note:

   You can also provide path or template parameters while specifying the linked URL, for example, https://www.linkedui.com/{instanceId}.

6. Under Connection parameters, add required query parameters for the URL.

   In addition to these parameters, the task ID parameter is passed with the value corresponding to the task ID.

7. Under What data is going to be exchanged?, add custom payload attributes that you'll use to send/receive data from the linked application. Unlike query parameters, here you can add complex business data types as well.

   Note:

   Through these attributes, you can use the data from a linked UI in any task within a process. However, you must perform a POST operation using the REST API to save the changes made to the payload attributes in the linked UI.

8. Exit the linked UI components using the breadcrumbs.

9. Implement the linked UI in a structured or dynamic process.

   See Use a Linked UI in a Human Task.

   As part of implementation, configure data associations and assign values to path parameters, query parameters, and payload attributes from within a process. The final URL invoked will have the following format:

   https://www.linkedui.com/{instanceId}?permitId={permitid}&taskId={taskid}

   Note:

   You can edit the base URL of the linked UI while activating your application.