{"id":42929,"date":"2018-12-07T10:57:55","date_gmt":"2018-12-07T02:57:55","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=42929"},"modified":"2024-07-09T10:35:04","modified_gmt":"2024-07-09T02:35:04","slug":"event","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/sentinel-studio\/component-logic-functions\/event\/","title":{"rendered":"Event"},"content":{"rendered":"\n

The Event components are used to indicate the triggering of an event and\/or a change in the state of the currently processed entity.<\/p>\n

Raise Event<\/h2>\n

The Raise Event component allows you to raise an event at the timestamp of the data point it is processing, however it does not change the state of the entity.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Don't perform action(s) for events<\/p>\n

The event is raised and is shown in Sentinel reports, but no actions are called.<\/p>\n

Metadata Keys<\/p>\n

Allows you to add additional data to the event, which can be viewed in the event report for the monitor in Sentinel. Click the \"Click here to add new item\" bar to add a new key. A key represents the data it is recording and should be named accordingly. For example, add the key Temp to represent temperature. When you add a key, it appears as an input on the component. Typically, you would get the value from an input data stream, such as Get Single<\/a>.<\/p>\n

Note: If metadata keys are added, they must be connected to another component.<\/p>\n

\"\" \"\"<\/p>\n

Inputs<\/p>\n

You may connect any or all of the input pins for the Raise Event component to run.<\/p>\n

Flow \"\"<\/a><\/p>\n

The component that causes the event to be raised should be connected to the flow pin for this component. This pin is optional and you may choose to connect the trigger to the in pin instead.<\/p>\n

in \"\"<\/a><\/p>\n

The input pin is optional and is used to record the timestamp. If an input is not supplied, the timestamp of the Primary Input is used.<\/p>\n

Outputs<\/p>\n

Flow\u00a0\"\"<\/a><\/p>\n

The output pin is a flow pin that directs the process flow but does not pass any data. This pin is optional and is only followed if an error does not occur. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, two events may be raised.<\/p>\n

An event is raised when the expression is evaluated as true (Temp <= 100). The timestamp defaults to that of the primary input (Temp). No state change occurs and the process finishes.<\/p>\n

An event is raised when the expression is evaluated as false (Temp >100). When this occurs, an event is raised and the state of the entity changes to Above. The timestamp defaults to that of the primary input (Temp). The temperature is then recorded in ISS Logger.<\/p>\n

\"\"<\/a><\/p>\n

Raise Event and Change State<\/h2>\n

The Raise Event and Change State component is one of the main components you will use in a user process.<\/p>\n

It allows you to raise an event at the timestamp of the data point it is processing, and changes the state of the monitored entity.<\/p>\n

\"\"<\/p>\n

Module Properties<\/p>\n

State<\/p>\n

Type the name of the state that is caused by the event being raised. This is displayed in the middle of the component in the Logic Editor<\/a>. E.g:<\/p>\n

\"\"<\/p>\n

Don't perform action(s) for events<\/p>\n

The event is raised and is shown in Sentinel reports, but no actions are called.<\/p>\n

Metadata Keys<\/p>\n

Allows you to add additional data to the event, which can be viewed in the event report for the monitor in Sentinel. Click the \"Click here to add new item\" bar to add a new key. A key represents the data it is recording and should be named accordingly. For example, add the key Temp to represent temperature. When you add a key, it appears as an input on the component. Typically, you would get the value from an input data stream, such as Get Single<\/a>.<\/p>\n

Note: If metadata keys are added, they much be connected to another component.<\/p>\n

\"\" \"\"<\/p>\n

Process Properties<\/p>\n

Default State<\/p>\n

You can specify one of the states in the process to be the default or \"normal\" state for the process.<\/p>\n

Inputs<\/p>\n

Flow\u00a0\"\"<\/a><\/p>\n

The component that causes the state to change should be connected to the flow pin for this component. The timestamp of this value is used to raise the event at this point in time. This pin is optional and you may choose to connect the trigger to the in pin instead.<\/p>\n

in\u00a0\"\"<\/a><\/p>\n

This input is optional and is used to record the timestamp. If an input is not supplied, the timestamp of the Primary Input is used.<\/p>\n

For a connection to this pin to be valid, the attached component must have a timestamp associated with it, but the data type can be numeric or string. For example, attaching a constant<\/a> will not be valid because a constant does not have an associated timestamp.<\/p>\n

Not connecting this input pin will produce a warning, however the process will still be valid.<\/p>\n

Outputs<\/p>\n

R\u00a0\"\"<\/a><\/p>\n

If the state changes, the process follows this path. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

NR\u00a0\"\"<\/a><\/p>\n

If the state does not change, the process follows this path. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, two event states may be raised.<\/p>\n

An event is raised when the expression is evaluated as true (Temp <= Temp2). When this occurs, an event is raised and the state of the entity changes to Below. The timestamp defaults to that of the primary input (Temp).<\/p>\n

An event is raised when the expression is evaluated as false (Temp >Temp2). When this occurs, an event is raised and the state of the entity changes to Above. <\/strong>The timestamp defaults to that of the primary input (Temp). The temperature is then recorded in ISS Logger.<\/p>\n

\"\"<\/a><\/p>\n

Raise Event with Auxiliary Data<\/h2>\n

The Raise Event with Auxiliary Data<\/em><\/strong> component allows you to raise an event at the timestamp of the data point it is processing; however it does not change the state of the entity.<\/p>\n

This component is similar to the Raise Event<\/em> component, with the added capability for specifying Auxiliary Data<\/em> for the event.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Don't perform action(s) for events<\/p>\n

The event is raised and is shown in Sentinel reports, but no actions are called.<\/p>\n

Metadata Keys<\/p>\n

This property allows you to add additional data to the event, which can be viewed in the event report for the monitor in Sentinel. Click the \"Click here to add new item\" bar to add a new key. A key represents the data it is recording and should be named accordingly. For example, add the key Temp to represent temperature. When you add a key, it appears as an input on the component. Typically, you would get the value from an input data stream, such as Get Single<\/a>.<\/p>\n

Note: If metadata keys are added, they must be connected to another component.<\/p>\n

\"C:\\Users\\gxl1129\\AppData\\Local\\Temp\\SNAGHTML5e213c14.PNG\"<\/a><\/p>\n

Inputs<\/p>\n

You may connect any or all of the input pins for the Raise Event with Auxiliary Data<\/em> component to run.<\/p>\n

Flow\u00a0\"\"<\/a><\/p>\n

The component that causes the event to be raised should be connected to the flow pin for this component. This pin is optional and you may choose to connect the trigger to the in pin instead.<\/p>\n

in\u00a0\"\"<\/a><\/p>\n

The input pin is optional and is used to record the timestamp. If an input is not supplied, the timestamp of the Primary Input is used.<\/p>\n

T\u00a0\"\"<\/a><\/p>\n

The template pin specifies the name of the template which is used to get the attributes and their data points, for auxiliary data. These are saved with the event. If you don\u2019t connect anything to the template pin, then the primary template is used by the process.<\/p>\n

P\u00a0\"\"<\/a><\/p>\n

The prefix pin is optional and is used to prefix the auxiliary data name, as part of the event data.<\/p>\n

Outputs<\/p>\n

Flow\u00a0\"\"<\/a><\/p>\n

The output pin is a flow pin that directs the process flow but does not pass any data. This pin is optional and is only followed if an error does not occur. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, two events may be raised.<\/p>\n

An event is raised when the expression is evaluated as true (Temperature > 50). The timestamp defaults to that of the primary input (Temperature). Attributes of the template selected for the auxiliary data (Aux Template<\/em>) are saved with current data from the time of the event. Attribute names are prefixed by the selected prefix (Aux Prefix<\/em>) value. No state change occurs and the process finishes.<\/p>\n

An event is raised when the expression is evaluated as false (Temperature <= 50). The timestamp defaults to that of the primary input (Temperature). Attributes of the template selected for the auxiliary data (Aux Template<\/em>) are saved with current data from the time of the event. Attribute names are prefixed by the selected prefix (Aux Prefix<\/em>) value. No state change occurs and the process finishes.<\/p>\n

\"\"<\/a><\/p>\n

Example of a Sentinel Event with Auxiliary Data<\/p>\n

Here, event details (in Sentinel) show the auxiliary data values (1<\/strong>), while the auxiliary data attribute names are prefixed by the selected value (2<\/strong>) (Prefix_).<\/p>\n

\"C:\\Users\\gxl1129\\AppData\\Local\\Temp\\SNAGHTML5ece8ce5.PNG\"<\/a><\/p>\n

Raise Event with Auxiliary Data and Change State<\/h2>\n

The Raise Event with Auxiliary Data and Change State component is similar to the Raise Event and Change State<\/em> component, but with the added capability for specifying Auxiliary Data<\/em> for the event.<\/p>\n

It allows you to raise an event at the timestamp of the data point it is processing, and changes the state of the monitored entity.<\/p>\n

\"\"<\/p>\n

Module Properties<\/p>\n

State<\/p>\n

Type the name of the state that is caused by the event being raised. This is displayed in the middle of the component in the Logic Editor<\/a>. E.g:<\/p>\n

\"\"<\/p>\n

Don't perform action(s) for events<\/p>\n

The event is raised and is shown in Sentinel reports, but no actions are called.<\/p>\n

Metadata Keys<\/p>\n

Allows you to add additional data to the event, which can be viewed in the event report for the monitor in Sentinel. Click the \"Click here to add new item\" bar to add a new key. A key represents the data it is recording and should be named accordingly. For example, add the key Temp to represent temperature. When you add a key, it appears as an input on the component. Typically, you would get the value from an input data stream, such as Get Single<\/a>.<\/p>\n

Note: If metadata keys are added, they must be connected to another component.<\/p>\n

\"C:\\Users\\gxl1129\\AppData\\Local\\Temp\\SNAGHTML5ebb9492.PNG\"<\/a><\/p>\n

Process Properties<\/p>\n

Default State<\/p>\n

You can specify one of the states in the process to be the default or \"normal\" state for the process.<\/p>\n

Inputs<\/p>\n

Flow\u00a0\"\"<\/a><\/p>\n

The component that causes the state to change should be connected to the flow pin for this component. The timestamp of this value is used to raise the event at this point in time. This pin is optional and you may choose to connect the trigger to the in pin instead.<\/p>\n

in\u00a0\"\"<\/a><\/p>\n

This input is optional and is used to record the timestamp. If an input is not supplied, the timestamp of the Primary Input is used.<\/p>\n

For a connection to this pin to be valid, the attached component must have a timestamp associated with it, but the data type can be numeric or string. For example, attaching a constant will not be valid because a constant does not have an associated timestamp. Not connecting this input pin will produce a warning, however the process will still be valid.<\/p>\n

T \"\"<\/a><\/p>\n

The template pin specifies the name of the template which is used to get the attributes and their data points, for auxiliary data. These are saved with the event. If you don\u2019t connect anything to the template pin, then the primary template is used by the process.<\/p>\n

P\u00a0\"\"<\/a><\/p>\n

The prefix pin is optional and is used to prefix the auxiliary data name, as part of the event data.<\/p>\n

Outputs<\/p>\n

R\u00a0\"\"<\/a><\/p>\n

If the state changes, the process follows this path. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

NR\u00a0\"\"<\/a><\/p>\n

If the state does not change, the process follows this path. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, two event states may be raised.<\/p>\n

An event is raised when the expression is evaluated as true (Temperature > 50). When this occurs, an event is raised and the state of the entity changes to Above. The timestamp defaults to that of the primary input (Temperature). Attributes of the template selected for the auxiliary data (Aux Template<\/em>) are saved with current data from the time of the event. Attribute names are prefixed by the selected prefix (Aux Prefix<\/em>) value. The process finishes.<\/p>\n

An event is raised when the expression is evaluated as false (Temperature <= 50). When this occurs, an event is raised and the state of the entity changes to Below. <\/strong>The timestamp defaults to that of the primary input (Temperature). Attributes of the template selected for the auxiliary data (Aux Template<\/em>) are saved with current data from the time of the event. Attribute names are prefixed by the selected prefix (Aux Prefix<\/em>) value. The process finishes.<\/p>\n

\"\"<\/a><\/p>\n

Reset State<\/h2>\n

The Reset State component resets the state of the entity so that the process can start afresh, at the Process First component.<\/p>\n

It can be used with the Monitor Version Changed<\/a> component to clear the previous state.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

This component has no additional properties.<\/p>\n

Inputs<\/p>\n

Flow\u00a0\"\"<\/a><\/p>\n

The component that causes the event to be raised should be connected to the flow pin for this component.<\/p>\n

Outputs<\/p>\n

Flow\u00a0\"\"<\/a><\/p>\n

The output pin is a flow pin that directs the process flow but does not pass any data. This pin is optional and is only followed if an error does not occur. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, Reset State will reset the state of the entity when the monitor version has changed.<\/p>\n

\"\"<\/a><\/p>\n

Related: Sentinel Studio Primers<\/a>,\u00a0Creating a User Process<\/a>, Usage Examples<\/a><\/p>\n

 <\/p>\n","protected":false},"excerpt":{"rendered":"

The Event components in Sentinel Studio are used to indicate the triggering of an event and\/or a change in the state of the currently processed entity.<\/p>\n

Read more<\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":43390,"parent":42147,"menu_order":5,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[9],"tags":[698,783,714,741,696,780,781,782,726,694],"class_list":["post-42929","page","type-page","status-publish","has-post-thumbnail","hentry","category-tech-ref","tag-components-sentinel","tag-event-report","tag-events","tag-monitor","tag-process-component","tag-raise-event","tag-reset-state","tag-state-change","tag-studio-sentinel","tag-user-process","Version-4-6-1","Product-sen"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/42929","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/comments?post=42929"}],"version-history":[{"count":2,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/42929\/revisions"}],"predecessor-version":[{"id":67974,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/42929\/revisions\/67974"}],"up":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/42147"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media\/43390"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=42929"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=42929"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=42929"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}