The DATETIMEFORMAT parameter is used to specify the date and time formats when date/time strings are passed to parameters in the URL. If DATETIMEFORMAT is not used, the default format as specified in the Default Regional Settings or User Preferences is used. Additionally, this parameter can be used if you want to specify a time zone other than the time zone that the display is set for.
For more information on using date time strings in URLs, see Date Time Strings in URL Parameters.
NOTE: If you are using date time strings in a URL and do not use the DATETIMEFORMAT parameter, make sure to use the same date/time formats as are used by the display (specified in Default Regional Settings). If the date/time formats are not the same, you will see the error indicator in the upper left on your display. Additionally, the symbols that are used for the date/time parameters will fail to be resolved, unless the display is configured to load default symbols that resolve the parameters. If there are unresolved symbols, they are also reported as errors on the error page (error indicator).
This parameter is valid only as long as the integrated environment starts in Client Display mode.
NOTE: The DATETIMEFORMAT parameter is case sensitive.
Format Symbol |
Format Symbol Description |
Example Values |
S |
millisecond |
650 |
s |
second in minute |
52 |
m |
minute in hour |
40 |
H |
hour in day (0-23) |
22 |
k |
hour in day (1-24) |
24 |
K |
hour in AM/PM (0-11) |
0 |
h |
hour in AM/PM (1-12) |
10 |
a |
AM/PM marker |
AM |
D |
day in year |
246 |
d |
day in month |
20 |
F |
day of week in month |
2 |
E |
day in week |
Friday, Fri |
w |
week in year |
23 |
W |
week in month |
3 |
M |
month in year |
June, Jun, 06 |
y |
year |
1970, 2001, 05 |
G |
era |
BC, AD |
z |
time zone (general) Hours: 0 - 23 |
Mountain Standard Time, MST, GMT-07:00 |
Z |
time zone (RFC 822 4-digit time zone) |
-0700, +0300 |
The DATETIMEFORMAT parameter will consist of:
DATETIMEFORMAT=
A combination of the format symbols (as shown in the Format Symbol column of the chart) in double quotation marks. For example: "d/M/yy H:mm"
The object parameter that the date/time string is being passed to. For example: GridStartTime=
The actual values that make up the date/time string. Examples of what these values might be are shown in the Example Values column of the chart. These values must be enclosed with <! !>. For example: <!20/06/05 23:40!>
The following examples show how the DATETIMEFORMAT parameter can be used in URLs.
To load the TimeChart display with a specific date/time format, that will pass a specific start and end time to a chart's start and end time parameters:
http://localhost/ProficyPortal/Default.asp?DISPLAY="Users\jsmith\displays\TimeChart"
&DATETIMEFORMAT="MM-dd-yyyy
HH:mm:ss"&ChartStartTime=<!12-06-2004 14:04:00!>
&ChartEndTime=<!12-06-2004 14:10:00!>
To load the TimeChart display with a specific date/time format, that will pass a specific start and end time to a chart's start and end time parameters, along with the time zone:
http://localhost/ProficyPortal/Default.asp?DISPLAY="Users\jsmith\displays\TimeChart"
&DATETIMEFORMAT="MM-dd-yyyy HH:mm:ss
z"&ChartStartTime=<!12-06-2004 14:04:00 PST!>
&ChartEndTime=<!12-06-2004 14:10:00 PST!>