DateOffset
The offset to apply to the document date when rounding to the specified DatePeriod. By default, IDOL aligns the DatePeriod to its system time. Use DateOffset
to align the DatePeriod to a different start point, such as the local timezone boundaries for users in different timezones.
You can use one of the following formats to specify the offset:
-
An offset in seconds. You can use negative numbers to specify a negative offset. For example,
DateOffset=-19800&DatePeriod=day
uses18:30:00 UTC
as the start of a day, which is00:00:00 IST
. -
A comma-separated list of values in the format
NSeconds,NMinutes,Nhours,Ndays,Nmonths,Nyears,
whereNSeconds
is the number of seconds to offset,NMinutes
is the number of minutes to offset, and so on.You do not have to specify all these values. For example, if
DateOffset
is0,0,0,5,3
, the date is offset by five days and three months so that the beginning of a year is 6 April, which is the UK tax year. -
A timezone or location value. For a full list of the available timezones, see DateOffset Timezone List. For example,
Asia:Calcutta
gives a UTC offset of +05:30, which is equivalent toDateOffset=-19800
.You can add
:DST
to a timezone string to offset for that timezone with daylight savings time. For example:Australia:Adelaide:DST
.
Actions: | GetQueryTagValues |
Type: | String |
Default: | |
Example: | DateOffset=0,0,0,5,3
|
See Also: | DatePeriod |