Skip to main content
Skip table of contents

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. Please refer to the Placeholders section of this document for a list of placeholders that can be used.

Event Name

Description

Swp08Router.switchFailed

Triggered when router switch failed.

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

Triggered when router switch was successful and switching was triggered by VidiControl (and not via external switch, panel, etc).

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

Triggered when router successfully switched and the switch was triggered externally (via panel, etc. VidiControl did not initiate the switch.)

CODE 
[
   {
      "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

Triggered when a chunk has been successfully deleted.

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

Triggered when a chunk has been successfully changed.

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"
        }
      ]
    }
  },
  {
    "action": "notifyCustom",
    "input": {
      "operation": "updateMetaData"
    }
  }
]

VidiControl.chunkCreated

Triggered when a chunk has been successfully created.

CODE 
[
   {
      "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

Triggered when an item (VidiCore) has been successfully created.

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

Triggered when the executiontime of a command is timed out.

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

Triggered when a command refers to an invalid (deleted or orphaned) device.

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

Triggered when the device responds with an error while command execution.

CODE 
[
   {
      "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

Triggered when the device attached to the command is currently offline.

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

Triggered when the device attached to the command is in state ‘Deleted’.

CODE 
[
   {
      "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

Triggered when the device does not respond (caused by connection issues, misconfiguration etc).

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

Triggered when the state of a command changed caused by command execution.

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

Triggered when the state of a chunk changed caused by command execution.

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"
            }
         ]
      }
   }
]

VidiControl.deviceStateChanged

Triggered when the state of a device was changed.

JSON 
[
    {
        "action": "notifyClient",
        "input": {
            "TimeStamp": "{-{Placeholder_TimeStamp}-}",
            "DeviceId": "{-{Placeholder_ExternalDeviceId}-}",
            "DeviceState": "{-{Placeholder_DeviceState}-}",
            "UpdateNeeded": true,
            "MessageType": "{-{Placeholder_MessageType}-}",
            "Emitter": "{-{Placeholder_Emitter}-}",
            "Severity": "Information",
            "Message": [
                {
                    "Lang": "en_US",
                    "Text": "Device state has changed"
                }, 
                {
                    "Lang": "de_DE",
                    "Text": "Zustand von einem Device hat sich geändert"
                }
            ]
        }
    }
]

VidiControl.recurrenceChanged

Triggered when a recurrence object was changed.

JSON 
[
  {
    "action": "notifyClient",
    "input": {
      "TimeStamp": "{-{Placeholder_TimeStamp}-}",
      "BookingDefinitionId": "{-{{-{Placeholder_ExternalBookingDefinitionId}-}}-}",
      "UpdateNeeded": true,
      "MessageType": "{-{Placeholder_MessageType}-}",
      "Emitter": "{-{Placeholder_Emitter}-}",
      "Severity": "Information",
      "Message": [
        {
          "Lang": "en_US",
          "Text": "The recurrence definition has been updated"
        },
        {
          "Lang": "de_DE",
          "Text": "Die Wiederholungsdefinition wurde geändert"
        }
      ]
    }
  }
]

VidiControl.recurrenceDeleted

Triggered when a recurrence object was deleted.

JSON 
[
  {
    "action": "notifyClient",
    "input": {
      "TimeStamp": "{-{Placeholder_TimeStamp}-}",
      "BookingDefinitionId": "{-{{-{Placeholder_ExternalBookingDefinitionId}-}}-}",
      "UpdateNeeded": true,
      "MessageType": "{-{Placeholder_MessageType}-}",
      "Emitter": "{-{Placeholder_Emitter}-}",
      "Severity": "Information",
      "Message": [
        {
          "Lang": "en_US",
          "Text": "The recurrence definition has been deleted"
        },
        {
          "Lang": "de_DE",
          "Text": "Die Wiederholungsdefinition wurde gelöscht"
        }
      ]
    }
  }
]

VidiControl.vidiCoreRelationChanged

Triggered when a child/parent releation in vidiCore was changed

JSON 
[
  {
    "action": "notifyClient",
    "input": {
      "TimeStamp": "{-{Placeholder_TimeStamp}-}",
      "ChunkId": "{-{Placeholder_ExternalChunkId}-}",
      "BookingDefinitionId": "{-{Placeholder_ExternalBookingDefinitionId}-}",
      "VcItemId": "{-{Placeholder_VCItemId}-}",
      "VcCollectionId": "{-{Placeholder_VCCollectionId}-}",
      "VcParentCollectionId": "{-{Placeholder_VCParentCollectionId}-}",
      "VcRelationType": "{-{Placeholder_VCRelationType}-}",
      "UpdateNeeded": true,
      "MessageType": "{-{Placeholder_MessageType}-}",
      "Emitter": "{-{Placeholder_Emitter}-}",
      "Severity": "Information",
      "Message": [
        {
          "Lang": "en_US",
          "Text": "VidiCore relation has been changed"
        },
        {
          "Lang": "de_DE",
          "Text": "VidiCore-Beziehung wurde geändert"
        }
      ]
    }
  }
]

VidiControl.virtualChunkDeleted

Triggered when a virtual chunk was deleted

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

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

CODE 
[{"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. Example for Update Metadata on VidiControl.chunkChanged event:

CODE 
[
  {
    "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"
        }
      ]
    }
  },
  {
    "action": "notifyCustom",
    "input": {
      "operation": "updateMetaData"
    }
  }
]

Placeholders

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

Not all placeholders are available in all events. Some placeholders are only available for Swp08Router events.

Events which do not belong to a physical chunk or command are not supporting placeholders depending on a chunk (e.g. VidiControl.virtualChunkDeleted, VidiControl.DeviceStateChanged)

Placeholder

Scope

Example Value

{-{Placeholder_ExternalBookingDefinitionId}-}

All

CM0B

{-{Placeholder_ExternalBookingId}-}

All

CYOB

{-{Placeholder_ExternalChunkId}-}

All

JHG3

{-{Placeholder_ExternalCommandId}-}

All

UZGS

{-{Placeholder_VCCollectionId}-}

All

COLLECTION-VX-654241

{-{Placeholder_VCItemId}-}

All

ITEM-VX-5746

{-{Placeholder_VCSequenceItemId}-}

All

ITEM-VX-6732

{-{Placeholder_MessageType}-}

All

chunkStatusChanged

{-{Placeholder_Emitter}-}

All

ChunkProcessor

{-{Placeholder_ErrorMessage}-}

All

Error while executing …

{-{Placeholder_ErrorType}-}

All

chunkStatusChanged

{-{Placeholder_TimeStamp}-}

All

2022-11-03T12:08:31.5434113Z

{-{Placeholder_ChunkExecutionState}-}

All

Pending

{-{Placeholder_InportLabel}-}

Swp08Router.*

Source_002

{-{Placeholder_OutportLabel}-}

Swp08Router.*

FEED22

{-{Placeholder_ExternalInportId}-}

Swp08Router.*

AG

{-{Placeholder_ExternalOutportId}-}

Swp08Router.*

0B

{-{Placeholder_ExternalDeviceId}-}

VidiControl.DeviceStateChanged

oNo

{-{Placeholder_DeviceState}-}

VidiControl.DeviceStateChanged

Online, Offline, Deleted

{-{Placeholder_VirtualChunkId}-}

VidiControl.virtualChunkDeleted

vid-M2b-Gw8l5G

{-{Placeholder_VCParentCollectionId}-}

VidiControl.vidiCoreRelationChanged

COLLECTION-VX-654241

{-{Placeholder_VCRelationType}-}

VidiControl.vidiCoreRelationChanged

CollectionRemovedFromParentCollection

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.

Contact Support Close