Run property substitution - Data360_Analyze - 3.12

Data360 Analyze Server Help

Product
Data360 Analyze
Version
3.12
Language
English
Portfolio
Verify
Product family
Data360
Product name
Data360 Analyze
Title
Data360 Analyze Server Help
Copyright
2023
First publish date
2016
Tip: If you are not yet familiar with how you can use derived property values across your data flows, see Using derived property values.

The "Run" prefixed property values are derived from the time that a scheduled run of a data flow began.

The following run properties are automatically created for every data flow:

  • RunDate
  • RunTime
  • RunTimeZoneOffset

Generally, you will not need to set these properties as the values will be automatically populated with the date and time that a scheduled run commenced. However, if necessary, you can explicitly set the values. For example, you could enter a specific date value in the RunDate property, then reference this when acquiring data from a database:

select *where bestBeforeDate >= {{^RunDate^}}

When a data flow, or part of a data flow, is run outside of a scheduled run, for example from the data flow Designer, the property values will be based on the time that you clicked the run button.

The values of the following properties are in the local time of the Analyze server, unless otherwise specified.

The Date, Time, and TimeZoneOffset suffixed properties are the ISO 8601 Extended formats of date, time, and time zone offset. The DateTime suffixed properties are NOT ISO 8601 compliant for backward compatibiilty reasons. An ISO 8601 compliant datetime can be created by using substitution expression with the data and time values, for example {{^RunDate^}}T{{^RunTime^}}.

The _PathSafe variants of the properties are all in the ISO 8601 Basic formats. These formats are generally safe for substituting into file paths.

Run property

Format Example Description
RunDate YYYY-MM-DD 2019-05-04 The date (year, month, day) that the scheduled run of the data flow started.
RunTime HH:mm:ss 14:34:56 The time (hours, minutes, seconds) that the scheduled run of the data flow started.
RunDateTime YYYY-MM-DD HH:mm:ss 2019-05-04 14:34:56 The date and time that the scheduled run of the data flow started.
RunTimeZoneOffset [+/-]HH:mm +05:00 The offset of the local time zone in hours and minutes from UTC.
RunDate_PathSafe YYYYMMDD 20190504 The date (year, month, day) that the scheduled run of the data flow started.
RunTime_PathSafe HHmmss 143456 The time (hours, minutes, seconds) that scheduled run run of the data flow started.
RunDateTime_PathSafe YYYYMMDDTHHmmss 20190504T143456 The date and time that the scheduled run of the data flow started.
RunTimeZoneOffset_PathSafe [+/-]HHmm +0500 The offset of the local time zone in hours and minutes from UTC.
RunDateTime_UTC_MS nnnnnn 12345562242 The milliseconds since the UTC epoch (1970-01-01 00:00:00 UTC).

It can be useful to use property substitution to reference scheduled runs when generating reports or output files.

For example, you could include the date and time of the run in the filename of an output Excel file, as follows:

<output directory>/{{^RunDate_PathSafe^}}/Report-{{^RunTime_PathSafe^}}.xls