{"id":42937,"date":"2018-12-07T15:51:31","date_gmt":"2018-12-07T07:51:31","guid":{"rendered":"http:\/\/localhost\/help\/?page_id=42937"},"modified":"2024-07-09T10:40:50","modified_gmt":"2024-07-09T02:40:50","slug":"text","status":"publish","type":"page","link":"https:\/\/oihelp.corporate.ifs.com\/help\/sentinel\/sentinel-studio\/component-logic-functions\/text\/","title":{"rendered":"Text"},"content":{"rendered":"\n

The Text components provide a way of working with text (strings), and can manipulate text to produce various outputs.<\/p>\n

=<\/h2>\n

The =<\/strong> component checks to see if the value of the first Mixed or Text pin is equal to the value of the second Mixed or Text pin. If it is, a value of true is forwarded to the output pin. If not, a value of false is forwarded to the output pin.<\/p>\n\n\n\n
Text:
\n<\/strong>
\n\"\"<\/strong><\/td>\n		Boolean:
\n<\/strong>
\n\"\"<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Properties<\/p>\n

Case sensitive comparison<\/p>\n

This check box, if selected, allows strings to be compared on the basis of upper and lower-case letters. For example, String <\/strong>will be considered as being different to string<\/strong>. This only applies to the Text category.<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin.<\/p>\n

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

A value for comparison. For mixed data types, both of the inputs must be of the same data type (e.g. numbers, date times, Booleans, or time periods). This input is required. Not connecting this pin will produce an error.<\/p>\n

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

Text values for comparison. Case sensitivity is determined by the component properties. This input is required. Not connecting this pin will produce an error.<\/p>\n

Outputs<\/p>\n

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

A true or false value. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, the =<\/strong> component checks to see if the temperature is equal to 28. If it is, an event is raised and the state of the entity changes to Normal. Otherwise, an event is raised and the state of the entity changes to Warning.<\/p>\n

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

\u2260<\/h2>\n

The \u2260<\/strong> component checks to see if the value of the first Mixed or Text pin is not equal to the value of the second Mixed or Text pin. If it is not equal, a value of true is forwarded to the output pin. Otherwise, a value of false is forwarded to the output pin.<\/p>\n\n\n\n
Text:
\n<\/strong>
\n\"\"<\/strong><\/td>\n		Boolean:
\n<\/strong>
\n\"\"<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Properties<\/p>\n

Case sensitive comparison<\/p>\n

This check box, if selected, allows strings to be compared on the basis of upper and lower-case letters. For example, String <\/strong>will be considered as being different to string<\/strong>. This only applies to the Text category.<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin.<\/p>\n

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

A value for comparison. For mixed data types, both of the inputs must be of the same data type (e.g. numbers, date times, Booleans, or time periods). This input is required. Not connecting this pin will produce an error.<\/p>\n

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

Text values for comparison. Case sensitivity is determined by the component properties. This input is required. Not connecting this pin will produce an error.<\/p>\n

Outputs<\/p>\n

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

A true or false value. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, the \u2260<\/strong> component checks to see if the temperature is not equal to 28. If it is, an event is raised and the state of the entity changes to Warning. Otherwise, an event is raised and the state of the entity changes to Normal.<\/p>\n

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

Concatenate<\/h2>\n

The Concatenate component joins together one or more input strings (text) into a single output string.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Num Inputs<\/p>\n

The number of input text strings for this component. You can specify up to 8 inputs.<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin.<\/p>\n

0, 1 etc\u00a0\"\"<\/a><\/p>\n

The text input that you want to be joined into a single output string. The output string is constructed in the order of the input strings. That is, 0 will be first and 7 will be last. There is no spacing between input strings. E.g. str0str1str2str3str4str5str6str7. This input is required. Not connecting this pin will produce an error.<\/p>\n

Outputs<\/p>\n

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

The text that is to be sent to the next component in the process. This is constructed by concatenating the input text into one string. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, the Concatenate component is used to send the current time, the current state, and the Temp value to ISS Logger. The information will look something like this: 1\/11\/2014 1:00:00 00Above105<\/strong><\/p>\n

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

Contains<\/h2>\n

The Contains component produces a Boolean value which indicates if the outer input string contains the inner input string. For example, if the text string was supplied to the outer pin and the text rin was supplied to the inner pin, a Boolean value of true would be produced.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Case sensitive comparison<\/p>\n

This check box, if selected, allows strings to be compared on the basis of upper and lower-case letters. For example, String <\/strong>will be considered as being different to string<\/strong>.<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The text in which the inner text is part of.<\/p>\n

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

The text that forms part of the outer text.<\/p>\n

Outputs<\/p>\n

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

True if the inner string is part of the outer string; otherwise this is false. Not connecting this output pin will produce a warning.<\/p>\n

Ends With<\/h2>\n

The Ends With component produces a Boolean value which indicates if the last part of the outer input string consists of the inner input string. For example, if the text string was supplied to the outer pin and the text ing was supplied to the inner pin, a Boolean value of true would be produced.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Case sensitive comparison<\/p>\n

This check box, if selected, allows strings to be compared on the basis of upper and lower-case letters. For example, String <\/strong>will be considered as being different to string<\/strong>.<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The full text that ends with the inner text.<\/p>\n

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

The text that forms the end of the outer text.<\/p>\n

Outputs<\/p>\n

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

True if the inner string is at the end of the outer string; otherwise this is false. Not connecting this output pin will produce a warning.<\/p>\n

Entity Name Formatter<\/h2>\n

The Entity Name Formatter component is used to construct a correctly-formatted IFS OI Explorer entity name string from the supplied inputs.<\/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 acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The entity name. This input is required. Not connecting this pin will produce an error.<\/p>\n

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

The template name. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

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

The attribute name. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

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

The property name. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

Outputs<\/p>\n

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

The correctly formatted entity name. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, the temperature is compared against a maximum value. If the temperature is greater than the maximum, an event is raised, the state of the entity changes to Above, and a value of 0<\/strong> is written to the entity's attribute.<\/p>\n

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

Join Text<\/h2>\n

The Join Text component joins together two or more input strings (text) into a single output string. It delimits each input string specified by the join input pin.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Num Inputs<\/p>\n

The number of input text strings for this component. You can specify up to 7 additional inputs (numbered 0 - 7).<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin. This pin is optional.<\/p>\n

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

The text that is used to delimit the inputs. Typically, you would use a constant consisting of a single character, such as a colon, comma, or hyphen. You can also specify a space character here.<\/p>\n

0, 1 etc\u00a0\"\"<\/a><\/p>\n

The text input that you want to be joined into a single output text string. The output is constructed in the order of the input text. That is, 0 will be first and 6 will be last. E.g. str0-str1-str2-str3-str4-str5-str6.<\/p>\n

Note<\/strong>: If an input pin is not connected or cannot be resolved backwards to get a value, this data and its joiner is not included.<\/p>\n

Outputs<\/p>\n

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

The text that is to be sent to the next component in the process. This is constructed by joining the input text into one string. Not connecting this output pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, the Join Text component is used to send the current time, the current state, and the Temp value to ISS Logger, using a hyphen as the delimiter between the different inputs. The information will look something like this: 1\/11\/2014 1:00:00 00-Above-105<\/strong><\/p>\n

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

Number \u2192 Text<\/h2>\n

The Number \u2192 Text component converts a number to string format. For example, the number 20 is converted to the text 20.<\/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 acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The number that is to be converted to text format.<\/p>\n

Outputs<\/p>\n

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

The text that has been converted from a number format. The output pin is required, otherwise the process will produce an error.<\/p>\n

Example<\/p>\n

In the following example, the Number \u2192 Text component takes a number from the input stream and converts it to text, so that it can be sent to the Log component for logging.<\/p>\n

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

Starts With<\/h2>\n

The Starts With component produces a Boolean value which indicates if the outer input string begins with the inner input string. For example, if the text string was supplied to the outer pin and the text str was supplied to the inner pin, a Boolean value of true would be produced.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Case sensitive comparison<\/p>\n

This check box, if selected, allows strings to be compared on the basis of upper and lower-case letters. For example, String <\/strong>will be considered as being different to string<\/strong>.<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The full text that starts with the inner text.<\/p>\n

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

The text that forms the start of the outer text.<\/p>\n

Outputs<\/p>\n

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

True if the inner string is at the beginning of the outer string; otherwise this is false. Not connecting this output pin will produce a warning.<\/p>\n

Text \u2192 Index<\/h2>\n

The Text \u2192 Index component compares the first input pin to see if it matches any of the other input pins. The index number of the matching pin is sent to output.<\/p>\n

\"\"<\/p>\n

Properties<\/p>\n

Case sensitive comparison?<\/p>\n

This check box, if selected, allows strings to be compared on the basis of upper and lower-case letters. For example, String <\/strong>will be considered as being different to string<\/strong>.<\/p>\n

Num Inputs<\/p>\n

The number of input strings for this component. You can specify up to 9 input strings.<\/p>\n

Inputs<\/p>\n

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

The component that acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The input text to be matched.<\/p>\n

0-7\u00a0\"\"<\/a><\/p>\n

The text that can be matched to the input text.<\/p>\n

Outputs<\/p>\n

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

The integer corresponding to the index of the matching text.<\/p>\n

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

The path that is followed if the input string cannot be matched. This pin is optional. Not connecting this pin will produce a warning.<\/p>\n

Example<\/p>\n

In the following example, the Text \u2192 Index component compares the Selection value to see if it matches either Red or Yellow. If it matches Red, a value of 0<\/strong> is passed to the Selector component. If it matches Yellow, a value of 1<\/strong> is passed to the Selector component.<\/p>\n

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

Text \u2192 Number<\/h2>\n

The Text \u2192 Number component converts a number to string format. For example, the text 20 is converted to the number 20.<\/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 acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The text that is to be converted to number format.<\/p>\n

Outputs<\/p>\n

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

The number that has been converted from a text format. The output pin is required, otherwise the process will produce an error.<\/p>\n

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

If the text cannot be converted to a number, the process follows this path. If this output pin is not connected, the process will abort if an error is encountered.<\/p>\n

To Lower Case<\/h2>\n

The To Lower Case component converts the letter case of a string to lower case. For example, String would be converted to string.<\/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 acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The text that is to be converted to lower case.<\/p>\n

Outputs<\/p>\n

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

The input text converted to lower case. Not connecting this output pin will produce a warning.<\/p>\n

To Upper Case<\/h2>\n

The To Upper Case component converts the letter case of a string to upper case. For example, String would be converted to STRING.<\/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 acts as a trigger for this component should be connected to this pin.<\/p>\n

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

The text that is to be converted to upper case.<\/p>\n

Outputs<\/p>\n

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

The input text converted to upper case. Not connecting this output pin will produce a warning.<\/p>\n

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

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

The Text components in Sentinel Studio provide a way of working with text (strings), and can manipulate text to produce various outputs.<\/p>\n

Read more<\/i><\/a><\/p>\n","protected":false},"author":1,"featured_media":43852,"parent":42147,"menu_order":15,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":"","_members_access_role":[],"_members_access_error":""},"categories":[9],"tags":[698,795,802,803,818,796,797,696,804,820,726,513,819,794,798,799],"class_list":["post-42937","page","type-page","status-publish","has-post-thumbnail","hentry","category-tech-ref","tag-components-sentinel","tag-concatenate","tag-contains","tag-ends-with","tag-entity-name-formatter","tag-join-text","tag-number-to-text","tag-process-component","tag-starts-with","tag-string","tag-studio-sentinel","tag-text","tag-text-to-index","tag-text-to-number","tag-to-lower-case","tag-to-upper-case","Version-4-6-1","Product-sen"],"_links":{"self":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/42937","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=42937"}],"version-history":[{"count":2,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/42937\/revisions"}],"predecessor-version":[{"id":67978,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/pages\/42937\/revisions\/67978"}],"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\/43852"}],"wp:attachment":[{"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/media?parent=42937"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/categories?post=42937"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/oihelp.corporate.ifs.com\/help\/wp-json\/wp\/v2\/tags?post=42937"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}