AMQP message annotations - SmartPlant Foundation - IM Update 42 - Help - Hexagon

SmartPlant Foundation Extensibility

Language
English
Product
SmartPlant Foundation
Search by Category
Help

AMQP message annotations can provide further information about the server event and allows for event filtering without having to deserialize the payload, as follows:

Reply-To: The URL of the server that sent the event message.

Message-ID: The unique identifier (UID) of the event message.

Content-Type: The content type of the payload.

Subject: The information about the event which allows the subscriber to evaluate whether the event is of interest or not:

Component

Description

Subject component 1

The product. For example, SPF

Subject component 2

The server name. For example, SPFServer

Subject component 3

The event type. For example, OnCreated

Subject component 4 and so on

A value that depends on the value type. For example, PL_PlantA/SPFFolder/IObject,ISPFFolder

  • The components of the subject value are separated by a forward slash /.

  • The first three components are always the same regardless of the event type.

Object Event Subject Definition:

The Object Event Subject Definition is made up of the following:

Product/ServerName/EventType/ConfigUID/ClassDefUID/InterfaceDefUIDs

For example, this results on the following Subject Definition:

SPF/SPFServer/OnCreated/PL_PlantA/SPFFolder/IObject,ISPFFolder

Object Update Event Subject Definition:

The Object Event Subject Definition is made up of the following:

Product/ServerName/EventType/ConfigUID/ClassDefUID/InterfaceDefUIDs/UpdatedProperties

For example, this results on the following Subject Definition:

SPF/SPFServer/OnUpdated/PL_APIPlantA/SPFFolder/ISPFFTRItem,ISPFExportableItem,ISPFSubscribableItem,ISPFOwnedObj,ISPFWorkflowItem,ISPFFolder,ISPFSupportItem,IObject/IObject|LastUpdatedDate,IObject|Description

Relationship Event Subject Definition:

The Object Event Subject Definition is made up of the following:

Product/ServerName/EventType/ConfigUID/RelDefUID/InterfaceDefUIDs

Relationship Update Event Subject Definition:

The Object Event Subject Definition is made up of the following:

Product/ServerName/EventType/ConfigUID/RelDefUID/InterfaceDefUIDs/UpdatedProperties

Custom Process Step Event Subject Definition:

The Custom Process Step Event Subject Definition is made up of the following:

Product/ServerName/EventType/ConfigUID/ WorkflowStepClassName

For example, this results in the following Subject Definition:

SPF/SPFServer/Execute/PL_PlantA/ExampleProcessStepClassName