Breadcrumbs

EventType

EventTypes are system events being distributed over ActiveMq when certain events happen. These can be configured via API or via Configuration UI.

VidiControl Product Events

This list shows all VidiControl product events. There may be more, adapter-specific events.

Event Name

Description

Consumer

Swp08Router.switchFailed


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Error",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"Switch failed from inport {-{Placeholder_InportLabel}-} to outport {-{Placeholder_OutportLabel}-}"
            },
            {
               "Lang":"de_DE",
               "Text":"Schaltung fehlgeschlagen Eingang {-{Placeholder_InportLabel}-} zu Ausgang {-{Placeholder_OutportLabel}-}"
            }
         ]
      }
   }
]

Swp08Router.switchSuccess


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Information",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"Switch from inport {-{Placeholder_InportLabel}-} to outport {-{Placeholder_OutportLabel}-}"
            },
            {
               "Lang":"de_DE",
               "Text":"Schaltung von Eingang {-{Placeholder_InportLabel}-} zu Ausgang {-{Placeholder_OutportLabel}-}"
            }
         ]
      }
   }
]

Swp08Router.switchExternal

7

ProxyAPI

 
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Warning",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"External switch from inport {-{Placeholder_InportLabel}-} to outport {-{Placeholder_OutportLabel}-}"
            },
            {
               "Lang":"de_DE",
               "Text":"Externe Schaltung von Eingang {-{Placeholder_InportLabel}-} zu Ausgang {-{Placeholder_OutportLabel}-}"
            }
         ]
      }
   }
]

VidiControl.chunkDeleted


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "UpdateNeeded":true,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Information",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"The chunk has been deleted"
            },
            {
               "Lang":"de_DE",
               "Text":"Der Chunk wurde gelöscht"
            }
         ]
      }
   }
]

VidiControl.chunkChanged


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "UpdateNeeded":true,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Information",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"The chunk has been changed"
            },
            {
               "Lang":"de_DE",
               "Text":"Der Chunk wurde verändert"
            }
         ]
      }
   }
]

VidiControl.chunkCreated


ProxyAPI

 
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "UpdateNeeded":true,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Information",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"The chunk has been created"
            },
            {
               "Lang":"de_DE",
               "Text":"Der Chunk wurde erzeugt"
            }
         ]
      }
   }
]

VidiControl.vidiCoreItemCreated


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "VcItemId":"{-{Placeholder_VCItemId}-}",
         "UpdateNeeded":true,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Information",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"VidiCore item has been created"
            },
            {
               "Lang":"de_DE",
               "Text":"VidiCore item wurde erzeugt"
            }
         ]
      }
   }
]

VidiControl.commandExecutionTimeOutError


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "CommandId":"{-{Placeholder_ExternalCommandId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Error",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"Command could not be executed because of timeout."
            },
            {
               "Lang":"de_DE",
               "Text":"Command konnte wegen timeout nicht ausgeführt werden."
            }
         ]
      }
   }
]

VidiControl.commandExecutionInvalidDeviceError


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "CommandId":"{-{Placeholder_ExternalCommandId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Error",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"invalid device."
            },
            {
               "Lang":"de_DE",
               "Text":"Ungültiges Gerät."
            }
         ]
      }
   }
]

VidiControl.commandExecutionDeviceStatusError


ProxyAPI

 
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "CommandId":"{-{Placeholder_ExternalCommandId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Error",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"Device status error."
            },
            {
               "Lang":"de_DE",
               "Text":"Gerätestatusfehler."
            }
         ]
      }
   }
]

VidiControl.commandExecutionDeviceOffline


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "CommandId":"{-{Placeholder_ExternalCommandId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Error",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"Device offline."
            },
            {
               "Lang":"de_DE",
               "Text":"Gerät offline."
            }
         ]
      }
   }
]

VidiControl.commandExecutionDeviceDeleted


ProxyAPI

 
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "CommandId":"{-{Placeholder_ExternalCommandId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Error",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"Device deleted."
            },
            {
               "Lang":"de_DE",
               "Text":"Gerät gelöscht."
            }
         ]
      }
   }
]

VidiControl.unknownCommandExecutionError


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "CommandId":"{-{Placeholder_ExternalCommandId}-}",
         "UpdateNeeded":false,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Error",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"unknown command execution error."
            },
            {
               "Lang":"de_DE",
               "Text":"Unbekannter Ausführungsfehler."
            }
         ]
      }
   }
]

VidiControl.commandStatusChanged


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "CommandId":"{-{Placeholder_ExternalCommandId}-}",
         "UpdateNeeded":true,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Information",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"The status of the command has changed"
            },
            {
               "Lang":"de_DE",
               "Text":"Der Command Status hat sich geändert"
            }
         ]
      }
   }
]

VidiControl.chunkStatusChanged


ProxyAPI
JSON
[
   {
      "action":"notifyClient",
      "input":{
         "TimeStamp":"{-{Placeholder_TimeStamp}-}",
         "ChunkId":"{-{Placeholder_ExternalChunkId}-}",
         "UpdateNeeded":true,
         "MessageType":"{-{Placeholder_MessageType}-}",
         "Emitter":"{-{Placeholder_Emitter}-}",
         "Severity":"Information",
         "Message":[
            {
               "Lang":"en_US",
               "Text":"The status of the chunk has changed"
            },
            {
               "Lang":"de_DE",
               "Text":"Der Chunk Status hat sich geändert"
            }
         ]
      }
   }
]

Content JSON Datastructure

The Content object consists of two fields, action and input. Depending on the action, the input structure may vary.

The Content JSON structure is defined in the configuration depending on the message consumer needs. All examples below show the frontend needs.

Actions

In this section, the different action values with their corresponding input structures are described. It is allowed to configure unlimited actions per event. Even several actions of the same type are allowed.


NotifyClient

Consumer of this action is the ProxyAPI to notify web clients about an update.

Action: notifyClient

Input:

Field

Type

Description

Example

Timestamp

string


{-{Placeholder_TimeStamp}-}

ChunkId

string


{-{Placeholder_ExternalChunkId}-}

UpdatedNeeded

boolean

Whether the GUI should be updated regarding this event.

true

MessageType

string


{-{Placeholder_MessageType}-}

Emitter

string


{-{Placeholder_Emitter}-}

Severity

string

The severity of the the Message. Possible Values: Information, Warning, Error

Information

Message

object

Message to be displayed in different languages

 
[{"Lang":"en_US","Text":"The status of the chunk has changed"},
{"Lang":"de_DE","Text":"Der Chunk Status hat sich geändert"}]


StartWorkflow

Action: startWorkflow

Input:

Field

Type

Description

Example

Name

string

The name of the Workflow to start

WF_Import

Version

string

The version of the workflow to start

latest

Data

object

this field contains a list of parameters with name, type and values
JSON
"Data": 
    {
        "Parameters": [
            {
                "Name": "RecordingSession", 
                "Value": "{-{Placeholder_RecordingsSession}-}",
                "Type": "string"
            },
            {
                "Name": "ItemId",
                "Value": "{-{Placeholder_VCItemId}-}",
                "Type": "string"}],
                "Metadata": null,
                "Priority": null
            }
        }
    }]


NotifyCustom

Consumer of this action is the ActiveMq topic to notify external moules listening.

Action: notifyCustom

Input can be freely configured and depends on the actual configuration and consumer.

Placeholders

These Placeholders in the system are substituted with their current value:

Placeholder

Example Value

{-{Placeholder_ExternalBookingDefinitionId}-}

CM0B

{-{Placeholder_ExternalBookingId}-}

CYOB

{-{Placeholder_ExternalChunkId}-}

JHG3

{-{Placeholder_ExternalCommandId}-}

UZGS

{-{Placeholder_VCCollectionId}-}

COLLECTION-VX-654241

{-{Placeholder_VCItemId}-}

ITEM-VX-5746

{-{Placeholder_VCSequenceItemId}-}

ITEM-VX-6732

{-{Placeholder_MessageType}-}

chunkStatusChanged

{-{Placeholder_ExternalDeviceId}-}

oNo

{-{Placeholder_DeviceState}-}

Online, Offline, Deleted

{-{Placeholder_Emitter}-}

ChunkProcessor

{-{Placeholder_TimeStamp}-}

2022-11-03T12:08:31.5434113Z