Azure plug-in structure

In this topic you can find information about configuring AzureEvents event sources and AzureEvents event conditions.

Configuring a Azure event source

A ServiceBusQueue event source that receives Azure event types can be configured in the following way:
connectionString
  • Type: string
  • minlength: 1
  • maxlength: 1000
  • isPassword
  • Required*
The Service Bus Shared Access Signature token used to connect to the Service Bus Queue you want to receive events from.
namespace
  • Type: string
  • minlength: 1
  • maxlength: 1000
  • Required*
The namespace of the queue you want to receive events from.
Note: While neither the connectionString or namespace values are individually required, you need to provide at least one of them.
queueName
  • Type: string
  • minlength: 1
  • maxlength: 1000
  • Required
The name of the Service Bus Queue you want to receive events from.

Example

The following is an example of a generic type event source configured to receive Azure event types:
$eventsource

EVENT_SOURCE /Azure1
DESCRIPTION "Azure testing"
PLUGIN AzureEvents
TYPE ServiceBusQueueEvent
CONFIGURATION {

      "connectionString": "connectionStringvalue",
      "namespace": "namespacevalue",
      "queueName": "queueNamevalue",

         }
END

Azure event condition

Azure event type conditions can be configured in workflows specifying the following required properties:
  • Name
    Restriction: If you want to start the event condition name with the prefix "in", ensure that the name is enclosed within double quotes.
  • Type
  • Event source
Note: When defining event conditions, all the relative fields are case insensitive
You can also specify any number of properties that filter the events received from the event source:
Message
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message body to enable filtering of events that either match or do not match the specified input.
contentType
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message content type to enable filtering of events that either match or do not match the specified input.
partitionKey
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message partition key to enable filtering of events that either match or do not match the specified input.
messageId
  • Filtering allowed
The ServiceBusQueue message ID to enable filtering of events that either match or do not match the specified input.
Subject
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message subject to enable filtering of events that either match or do not match the specified input.
correlationId
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message correlation ID to enable filtering of events that either match or do not match the specified input.
to
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message to property value to enable filtering of events that either match or do not match the specified input.
applicationProperties
  • Type: map
  • Operator: KEY_VALUE("keyvalue")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: false
  • Case sensitive: false
Specify the ServiceBusQueue message custom properties to enable filtering of events that either match or do not match the specified input.
replyTo
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message reply to property value to enable filtering of events that either match or do not match the specified input.
enqueuedSequenceNumber
  • Filtering allowed
The ServiceBusQueue message enqueued sequence number property value to enable filtering of events that either match or do not match the specified input.
expireAt
  • Filtering allowed
The ServiceBusQueue message expring time property value to enable filtering of events that either match or do not match the specified input.
timeToLive
  • Filtering allowed
The ServiceBusQueue message time to live duration property value to enable filtering of events that either match or do not match the specified input.
State
  • Type: string
  • Operator: EQ("=") or NE("!=")
  • minlength: 1
  • maxlength: 1000
  • Wildcard allowed: true
  • Multiple filters: false
  • Single predicate: true
  • Case sensitive: false
Specify the ServiceBusQueue message state to enable filtering of events that either match or do not match the specified input.
scheduledEnqueueTime
  • Filtering allowed
The ServiceBusQueue message enqueue date time property value to enable filtering of events that either match or do not match the specified input.
sequenceNumber
  • Filtering allowed
The ServiceBusQueue message sequence number property value to enable filtering of events that either match or do not match the specified input.

Example

The following is an example of a workflow with two Azure event conditions:
$jobstream

WORKFLOW /WS_AGT_1#/WF_EVT_TRIGGER_AZURE
  DESCRIPTION "Event driven workflow azure"
  TRIGGER TRIGGER_2 DESCRIPTION "Sample event trigger" TIMEOUT PT1M CONDITIONS
    NAME EC_AZURE TYPE "AzureEvents/ServiceBusQueueEvent" SOURCE /AZURE1 FILTERS partitionKey = keyExample
    NAME EC_AZURE2 TYPE "AzureEvents/ServiceBusQueueEvent" SOURCE /AZURE1 FILTERS message = hello
  ENDTRIGGER
:
END