![\"\"](\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2018\/12\/word-image-171.png\")
<\/p>\nThe Time components provide a way to work with time periods and timestamps of data points.<\/p>\n
The Add Seconds component adds seconds to a timestamp. You can use this to create a time offset in a process.<\/p>\n
<\/p>\n
Properties<\/p>\n
This component has no additional properties.<\/p>\n
Inputs<\/p>\n
Flow The component that acts as a trigger for this component should be connected to this pin.<\/p>\n Date Time The timestamp passed by the pin of the connected component. This input is required. Not connecting this pin will produce an error.<\/p>\n Number The number of seconds to add to the timestamp. For example, 120 (120 seconds). To subtract time from the timestamp, use a negative symbol (-), for example, -120. This input is required. Not connecting this pin will produce an error.<\/p>\n Outputs<\/p>\n Date Time\u00a0 The resultant timestamp, which has been incremented (or decremented, if a negative number is used) by the specified number of seconds.<\/p>\n Example<\/p>\n In the following example, the input data is compared with the data from 60 seconds earlier to see if it is above or below. The input stream is split into two to retrieve the current value and the previous value.<\/p>\n The previous value is obtained by adding 60 seconds to the data's timestamp. This gives us the point in time for which we want to get the value.<\/p>\n We will use that timestamp as an end point and retrieve a 24-hour window worth of values up to that point. We will then take the last value from that 24-hour window worth of data. This is the value that we will use for comparison.<\/p>\n We then compare that value with the current value obtained by the Get Single<\/a> component.<\/p>\n The Add Time Period component adds a time period to a timestamp. You can use this to create a time offset in a process.<\/p>\n Properties<\/p>\n This component has no additional properties.<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin.<\/p>\n Date Time\u00a0 The timestamp passed by the pin of the connected component. This input is required. Not connecting this pin will produce an error.<\/p>\n Time Period\u00a0 The period of time to add to the timestamp. For example, 1 hour. This input is required. Not connecting this pin will produce an error.<\/p>\n Outputs<\/p>\n Date Time\u00a0 The resultant timestamp, which has been incremented by the specified time period.<\/p>\n Example<\/p>\n In the following example, the input data is compared with the data from the previous day to see if it is above or below. The input stream is split into two to retrieve the current value and the previous value.<\/p>\n The previous value is obtained by adding a time period of 1 day to the data's timestamp. We must put a negative symbol to indicate we want to go back in time to get the value from the previous day. This gives us the point in time for which we want to get the value of.<\/p>\n We will use that timestamp as an end point and retrieve a minute's worth of values up to that point. We will then take the last value from that minute's worth of data. This is the value that we will use for comparison.<\/p>\n We then compare that value with the current value obtained by the Get Single<\/a> component.<\/p>\n The Now component retrieves the current timestamp and sends it to the connecting component. This component should only be used with the Log<\/a> component, to log a message at the current timestamp as opposed to the timestamp of the entity.<\/p>\n Warning<\/strong>: If this component is used with Get Window<\/a>, Get Window From<\/a>, or Get Window Start Filter<\/a>, data points will not be retrieved at the correct times and you will get unexpected results.<\/p>\n Properties<\/p>\n This component has no additional properties.<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin.<\/p>\n Outputs<\/p>\n Date Time\u00a0 The current timestamp.<\/p>\n Example<\/p>\n In the following example, the Now component is used to obtain the current timestamp, which is converted to text and joined into one string that is ultimately sent to the logging infrastructure.<\/p>\n The Set Timestamp component sets the timestamp of the input to the specified timestamp.<\/p>\n Properties<\/p>\n This component has no additional properties.<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin.<\/p>\n data The input value.<\/p>\n time\u00a0 The timestamp that you want to set for the input.<\/p>\n Outputs<\/p>\n Mixed\u00a0 The data point with the new timestamp. Not connecting this output 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. The Set Timestamp component gives to the value the timestamp of the entity used to supply the Temperature input.<\/p>\n The Text \u2192 Time component parses a string and converts it into its equivalent timestamp. The timestamp is in UTC format.<\/p>\n Properties<\/p>\n This component has no additional properties.<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin.<\/p>\n Text\u00a0 The string that is to be converted into a timestamp. This input is required. Not connecting this pin will produce an error. The string should have the following format: Outputs<\/p>\n Date Time\u00a0 The timestamp produced by the component after parsing the input string.<\/p>\n err\u00a0 If the string cannot be converted to a time format, the process follows this path. No data is passed to the connected component. This pin is optional. Not connecting this pin will produce a warning. If this pin is not connected, the process will abort if an error is encountered.<\/p>\n Example<\/p>\n In the following example, the user inputs a string to use as a timestamp. The Text \u2192 Time component converts this to a timestamp to send to the rest of the process. If the conversion cannot happen, a message is logged.<\/p>\n The Text \u2192 Time Period component parses a string and converts it into its equivalent time period. The time period is in UTC format.<\/p>\n Properties<\/p>\n This component has no additional properties.<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin.<\/p>\n Text\u00a0 The string that is to be converted into a time period. This input is required. Not connecting this pin will produce an error. The string should have the following format: Outputs<\/p>\n Time Period\u00a0 The time period produced by the component after parsing the input string.<\/p>\n err\u00a0 If the string cannot be converted to a time period format, the process follows this path. No data is passed to the connected component. This pin is optional. Not connecting this output pin will produce a warning. If this pin is not connected, the process will abort if an error is encountered.<\/p>\n Example<\/p>\n In the following example, the user inputs a string to use as a time period. The Text \u2192 Time Period component converts this to a time period to send to the rest of the process. If the conversion cannot happen, a message is logged.<\/p>\n The Time \u2192 Text component formats a timestamp as a string.<\/p>\n Properties<\/p>\n Timestamp Format<\/p>\n You can choose to format the timestamp in two ways:<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin. This pin is optional.<\/p>\n Date Time\u00a0 The timestamp that is to be converted to text.<\/p>\n Outputs<\/p>\n Text\u00a0 The text conversion of the timestamp.<\/p>\n Example<\/p>\n In the following example, the current time is retrieved by the Now component, and is converted to text so that it can be logged.<\/p>\n The Time Difference component produces a time period that represents the difference between the two timestamp inputs.<\/p>\n Properties<\/p>\n This component has no additional properties.<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin.<\/p>\n ts1\u00a0 The start timestamp of the time period. This input is required. Not connecting this pin will produce an error.<\/p>\n ts2\u00a0 The end timestamp of the time period. This input is required. Not connecting this pin will produce an error.<\/p>\n Outputs<\/p>\n Time Period\u00a0 The time period that represents the difference between the two inputs.<\/p>\n Example<\/p>\n In the following example, the Time Difference component retrieves the timestamp of Input 2 and reads the timestamp of Input 1 from memory. It produces a time period, which is used as the input for a Boolean operator that evaluates if the difference between the two time stamps is greater than 2 minutes.<\/p>\n The Time Period \u2192 Text component converts a time period to string format.<\/p>\n Properties<\/p>\n This component has no additional properties.<\/p>\n Inputs<\/p>\n Flow\u00a0 The component that acts as a trigger for this component should be connected to this pin.<\/p>\n Time Period The time period that is to be converted to text. This input is required. Not connecting this pin will produce an error.<\/p>\n Outputs<\/p>\n![\"\"](\"https:\/\/oihelp.corporate.ifs.com\/help\/wp-content\/uploads\/2018\/12\/word-image-18.png\")
<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nAdd Time Period<\/h2>\n
<\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nNow<\/h2>\n
<\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nSet Timestamp<\/h2>\n
<\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nText \u2192 Time<\/h2>\n
<\/p>\n<\/a><\/p>\n<\/a><\/p>\n
\nyyyy-M-d h:mm:ss tt<\/strong>
\nE.g. 2014-12-1 12:00:00 AM<\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nText \u2192 Time Period<\/h2>\n
<\/p>\n<\/a><\/p>\n<\/a><\/p>\n
\n<years>y<\/strong><months>m<\/strong><weeks>w<\/strong><days>d<\/strong><hours>h<\/strong><minutes>mi<\/strong><seconds>s<\/strong><milliseconds>ms<\/strong>
\ne.g. 2y5m2w3d13h54mi12s0ms<\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nTime \u2192 Text<\/h2>\n
<\/p>\n\n
\nE.g. 13\/11\/2014 13:00:00 AM (where tt is AM or PM)<\/li>\n
\nThe date and time in Coordinated Universal Time. E.g. 2014-11-13T13:00:00+08:00.<\/li>\n<\/ul>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nTime Difference<\/h2>\n
<\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\n<\/a><\/p>\nTime Period \u2192 Text<\/h2>\n
<\/p>\n<\/a><\/p>\n<\/a><\/p>\n