Publish Event

A Publish Event is a type of Task that publishes a Universal Event to Universal Controller using the Universal Controller API.

This Task type allows you to notify Universal Controller of transfer lifecycle events or trigger downstream automation workflows.

Before You Begin

End-to-End Setup

To configure and run a Publish Event Task as part of a Pipeline Workflow, you must also configure the Universal Event Integration.

For setup instructions, see Universal Event Integration.

Execution Context

Publish Event Tasks publish Universal Events to Universal Controller through the Universal Controller API. Therefore, the Task execution environment must have network access to the Universal Controller API endpoint.

Adding a Publish Event Task

To add a Publish Event Task, follow these steps:

1. From the Sidebar, select Configuration > Tasks.
2. Click Add Task.
3. Complete the details for the new Publish Event Task, using the Field Descriptions table as a guide.
4. Click Add.

Field Descriptions

The following table describes the fields that are configured for the Task:

Name	Description	Specifications	Required
Name	The name of the Task.	Must be unique. Must follow the Standard Naming Pattern.	Yes
Description	The description of the Task.		No
Business Service	Assigning a Business Service to this Task restricts updating, deleting, and other actions so only Users with the same Business Service can perform them (role permissions still apply). For details, see Business Services.	Only Users with the System Administrator, Domain Administrator, or Pipeline Management role can assign Business Services to Tasks. Select an already-created Business Service. To select it, your User must have that Business Service already assigned.	No
Type	The type of Task to execute.	Select Publish Event.	Yes
Timeout (Seconds)	Specifies a timeout value for the Task runtime. The Task will fail if the timeout threshold is met.	Default is 60 seconds.	Yes
Event Business Services	A comma-separated list of Business Service Names for the Universal Event membership.	Must reference already-created Business Service on Universal Controller. Leave empty to skip the assignment to Business Service(s).	No
Event Name (Overrides Default)	Specifies the name of the Universal Event Template.	Must reference an already-created Universal Event Template on Universal Controller. Leave empty to use the uac.event_name argument value.	No
Event Credentials (Overrides Default)	Select the Username and Password credential for the Universal Controller API.	Must reference an already-created Username and Password. Leave empty to use the uac.username and uac.password argument values.	No

Editing a Publish Event Task

To edit a Publish Event Task, follow these steps:

1. From the Sidebar, select Configuration > Tasks.
2. Click the Name field of the Publish Event Task you want to edit.
3. Click Edit above the Publish Event Task details.
4. Edit the Publish Event Task details, using the Field Descriptions table as a guide.
5. Click Update.

Managing a Publish Event Task

Viewing Task Details

To view the details of a Publish Event Task, follow these steps:

1. From the Sidebar, select Configuration > Tasks.
2. Click the Name of the Task you want to view.

Task Metadata

Task details include all parameters given in the Field Descriptions table, plus the following read-only metadata:

Name	Description
UUID	Universally Unique Identifier of this Task.
Version	Version number of the configuration. Every change increases the number.
Created	Date and time this Task was created.
Updated	Date and time this Task was last updated.

Assigning a Publish Event Task to a Pipeline

Publish Event Tasks are not executed independently. A Publish Event Task runs only when it is assigned to a Pipeline Workflow and Workflows are enabled on the Pipeline.

The Pipeline Workflow defines when a Publish Event Task is executed (triggered) during the transfer lifecycle. A Publish Event Task can be referenced by multiple Pipelines and may be used in different Workflow triggers.

For more details, see Assigning a Task to a Pipeline.

Monitoring Executed Tasks

Each Task execution is recorded as a Task Instance, which includes execution details such as status.

Task Instances can be reviewed on the Task Instances Dashboard for monitoring, troubleshooting, and auditing.

Deleting a Publish Event Task

To delete a Publish Event Task, follow these steps:

1. From the Sidebar, select Configuration > Tasks.
2. Click the Name of the Publish Event Task you want to delete.
3. Click Delete above the Publish Event Task details.
4. You will be asked to confirm the deletion. Click Delete.

warning

UDMG prevents the deletion of a Configuration Item if it is currently referenced by another Configuration Item (i.e., Pipeline). The Configuration Item must be edited or the reference removed before you can delete the Task. Deletion cannot be undone.