Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

System Profile Change Example
<!--MsgId is the unique id of the message being sent -->
<!--ProfileId is the unique id of the system profile which will become activated -->
<?xml version="1.0" encoding="utf-8"?>
<SystemProfileCommand MsgTimeStamp="2019-02-01T12:14:01+00:00" MsgId="1" ProfileId="1" xmlns="ICDNAV001-SystemProfileCommand">
  <Sender SenderId="SenderId1" NetworkAddress="NetworkAddress1" NetworkPort="1" />
</SystemProfileCommand>

System Profile Command Element

The external trigger command instruction provides the ability to trigger an action in Witness based on the provided trigger Id and Enable state. Different actions can be associated with different Ids. In addition the command includes a timeout option allowing the state of the trigger to be automatically reversed after the specified timeout.

System Profile Command Attributes

Attributes

Description

Type

Notes

MsgId

Unique message Id

Long

This must be globally unique across all message types 

MsgTimeStamp

Date and time that the message was sent

DateTime


ProfileId

Id of the profile which is required to become active

Integer

This is the Id of the system profile that will become the active system profile. It is the UserId of the profile as configured in Witness

Network Sender Element

Each incoming message can include an optional Sender element. This must include the IP address and port that the client is using to send instructions.

If the Sender element is included the NetworkAddress value will be checked against the subscriber IP address and the command rejected if they do not match. 

In addition the Sender element is included in the Command Reply. This is a duplicate of the incoming details (i.e. the subscribers IP address and port). The subscriber can use this to verify that they authored the message.

If a message contains the profile Id of the currently active profile then the profile change message will be ignored and no action taken and the message response will indicate a failure.

Related information

  • No labels