Definition

Specify the name of a variable which will contain the custom date/time. This variable will contain character date and may be used in most fields (other than fields expecting a File List or RowSet). For example, a common use for this variable would be part of an output file name (OutputFile_${timestampVar}.txt). The variable will be created if it does not exist. This timestamp value will not be available in the system variables system.currentDate, system.currentTime and system.currentTimestamp

Specify the pattern in which this timestamp should be formatted.

Specify the locale to which the date/time data is to be formatted. The locale must be of the form [language]_[country], where language is the two character ISO language code and country is the two character ISO country code. The country part may be omitted if the data was formatted to just the specified language. Example locales are - en_US (English/United States), de (German). The default is 'en_US'.

Specify the value to which the day of month field of this timestamp is to be set, rolled forward or rolled backward. A valid value must be a whole number. The number may be prefixed with a "+" or '-' sign to indicate that the day of month should be rolled forward or backward by the specified amount. When nothing precedes the number, the day of month component of this timestamp is set (or made equal) to the specified number. For example, a value of 3 sets the date to 3, +3 adds 3 to the current date and -3 subtracts 3 from the current date. A special value of "L" can be used to set the date to the last day of the month.

Specify the value to which the month (month of year) field of this timestamp is to be set, rolled forward or rolled backward. A valid value must be a whole number. The number may be prefixed with a "+" or '-' sign to indicate that the month should be rolled forward or backward by the specified amount. When nothing precedes the number, the month field of this timestamp is set (or made equal) to the specified number. For example, a value of 3 sets the month to 3 (march), +3 adds 3 to the current month and -3 subtracts 3 from the current month.

Specify the value to which the year field of this timestamp is to be set, rolled forward or rolled backward. A valid value must be a whole number. The number may be prefixed with a "+" or '-' sign to indicate that the year should be rolled forward or backward by the specified amount. When nothing precedes the number, the year field of this timestamp is set (or made equal) to the specified number. For example, a value of 2007 sets the year to 2007, +3 adds 3 to the current year and -3 subtracts 3 from the current year.

Specify the value to which the hour (hour of day) field of this timestamp is to be set, rolled forward or rolled backward. A valid value must be a whole number. The number may be prefixed with a "+" or '-' sign to indicate that the hour field should be rolled forward or backward by the specified amount. When nothing precedes the number, the hour field of this timestamp is set (or made equal) to the specified number. For example, a value of 15 sets the hour to 3pm, +3 adds 3 to the current hour of day and -3 subtracts 3 from the current hour of day.

Specify the value to which the minute (minute of hour) field of this timestamp is to be set, rolled forward or rolled backward. A valid value must be a whole number. The number may be prefixed with a "+" or '-' sign to indicate that the minute field should be rolled forward or backward by the specified amount. When nothing precedes the number, the minute field of this timestamp is set (or made equal) to the specified number. For example, a value 0 sets the minute to 0, +3 adds 3 to the current minute of hour and -3 subtracts 3 from the current minute of hour.

Specify the value to which the seconds (second of the minute) fields of this timestamp is to be set, rolled forward or rolled backward. A valid value must be a whole number. The number may be prefixed with a "+" or '-' sign to indicate that the seconds field should be rolled forward or backward by the specified amount. When nothing precedes the number, the seconds field of this timestamp is set (or made equal) to the specified number. For example, a value of 20 sets the seconds to 20, +10 adds 10 to the current seconds and -10 subtracts 10 from the current seconds.

Specify the value to which the milliseconds field of this timestamp is to be set, rolled forward or rolled backward. A valid value must be a whole number. The number may be prefixed with a "+" or '-' sign to indicate that the milliseconds field should be rolled forward or backward by the specified amount. When nothing precedes the number, the milliseconds component of this timestamp is set (or made equal) to the specified number. For example, a value of 0 sets the milli seconds to 0 (makes it a whole second), +500 adds 500 milliseconds to the current milliseconds -500 subtracts from the current milliseconds.

Specify the value to which the day of week field of this timestamp is to be set. A valid value must be in the rage of 1 through 7 where 1 means Sunday, 2 means Monday and 7 means Saturday. For example, a value of 3 sets day of week to Tuesday. This value in combination with dayOfWeekInMonth can be used to uniquely identify a day in a month (e.g. 3rd Friday of the month).

Specify the value to which the day of week in month field of this timestamp is to be set. A valid value must be in the range of -5 through 5. A value of 1 in this field together with a value of 3 in Day of Week field will evaluate to the 1st Tuesday of the month. Negative values in this field will count backwards from the end of the month. For example, A value of -1 in this field together with a value of 1 in the Day of Week field will evaluate to the last Sunday of the month. When a value of 0 is specified for this attribute, the week in month will be set to the last week of the previous month.