5 Service Sets ToC Previous Next

5.12 MonitoredItem Service Set ToC Previous Next

5.12.5 SetTriggering ToC Previous Next

5.12.5.1 Description ToC

This Service is used to create and delete triggering links for a triggering item. The triggering item and the items to report shall belong to the same Subscription.

Each triggering link links a triggering item to an item to report. Each link is represented by the MonitoredItem id for the item to report. An error code is returned if this id is invalid.

See 5.12.1.6 for a description of the triggering model.

5.12.5.2 Parameters ToC

Table 78 defines the parameters for the Service.

Table 78 – SetTriggering Service Parameters

Name Type Description
Request    
   requestHeader Request Header Common request parameters (see 7.28 for RequestHeader definition).
   subscriptionId IntegerId The Server-assigned identifier for the Subscription that contains the triggering item and the items to report (see 7.14 for IntegerId definition).
   triggeringItemId IntegerId Server-assigned id for the MonitoredItem used as the triggering item.
   linksToAdd [] IntegerId The list of Server-assigned ids of the items to report that are to be added as triggering links. The list of linksToRemove is processed before the linksToAdd.
   linksToRemove [] IntegerId The list of Server-assigned ids of the items to report for the triggering links to be deleted. The list of linksToRemove is processed before the linksToAdd.
     
Response    
   responseHeader Response Header Common response parameters (see 7.29 for ResponseHeader definition).
   addResults [] StatusCode List of StatusCodes for the items to add (see 7.34 for StatusCode definition). The size and order of the list matches the size and order of the linksToAdd parameter specified in the request.
   addDiagnosticInfos [] Diagnostic Info List of diagnostic information for the links to add (see 7.8 for DiagnosticInfo definition). The size and order of the list matches the size and order of the linksToAdd request parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request.
   removeResults [] StatusCode List of StatusCodes for the items to delete. The size and order of the list matches the size and order of the linksToRemove parameter specified in the request.
   removeDiagnosticInfos [] Diagnostic Info List of diagnostic information for the links to delete. The size and order of the list matches the size and order of the linksToRemove request parameter. This list is empty if diagnostics information was not requested in the request header or if no diagnostic information was encountered in processing of the request.

5.12.5.3 Service results ToC

Table 79 defines the Service results specific to this Service. Common StatusCodes are defined in 7.34.

Table 79 – SetTriggering Service Result Codes

Symbolic Id Description
Bad_NothingToDo See Table 177 for the description of this result code.
Bad_TooManyOperations See Table 177 for the description of this result code.
Bad_SubscriptionIdInvalid See Table 177 for the description of this result code.
Bad_MonitoredItemIdInvalid See Table 178 for the description of this result code.

5.12.5.4 StatusCodes ToC

Table 80 defines values for the results parameters that are specific to this Service. Common StatusCodes are defined in Table 178.

Table 80 – SetTriggering Operation Level Result Codes

Symbolic Id Description
Bad_MonitoredItemIdInvalid See Table 178 for the description of this result code.

Previous Next