Skip to main content

Event

An Event task in Orkes Conductor is a system task used to publish an event into one of the supported eventing systems. The supported eventing models include:

Pre-requisites:

Definitions​

An example configuration of publishing an event to Confluent Kafka:

   {
"name": "event",
"taskReferenceName": "event_ref",
"type": "EVENT",
"sink": "kafka_confluent:John-Test:topic-name",
"inputParameters": {}
}

Input Parameters​

ParameterDescription
sinkProvide the event queue sink. The UI drop-down lists the message broker integrations added to the Conductor cluster by default. Choose the required integration and add the topic/queue name along with the sink.

For example, the drop-down lists the sink for the above example as kafka_confluent:John-Test. Edit the sink manually to include the topic name, making it kafka_confluent:John-Test:topic-name.
inputParametersProvide the required input parameters so the task execution will be sent as the payload to the event sink.

Additional System Inputs to Payload​

Conductor will add the following parameters to the payload, ensuring these fields are not present in the original payload as they will be overwritten during execution:

  • workflowInstanceId - Workflow ID from where this event was sent.
  • workflowType - Name of the workflow definition.
  • workflowVersion - Version of the workflow definition.
  • correlationId - Correlation ID of the workflow execution.

For example,

Given the following task definition:

   {
"name": "event_task",
"taskReferenceName": "event_task_ref",
"type": "EVENT",
"sink": "kafka:external_event_name",
"inputParameters": {
"myKey": "myValue",
"myNumber": 100
}
}

The execution will produce the following output:

    {
"myKey": "myValue",
"myNumber": 100,
"workflowInstanceId" : "967b19ae-10d1-4b23-b0e7-ae324524dac0",
"workflowType" : "my-workflow-name",
"workflowVersion" : "1",
"correlationId" : "fbdcafd2-69c7-4b75-8dd1-653e33d48746",
}

Output Parameters​

The task will produce the payload it sent as the output.

Examples



  1. Add task type EVENT.
  2. Select the sink type from the integrations added to the cluster.
  3. Add the topic name along with the sink.
  4. Provide the required input parameters.

Adding event task