Date and Time formats in Content Manager OnDemand - Revision history

Jderrick: Added section on arsdate -F parameter for CMOD custom date format.

2023-09-06T15:54:42Z

Added section on arsdate -F parameter for CMOD custom date format.

← Older revision		Revision as of 15:54, 6 September 2023
Line 144:		Line 144:

	$ arsdate -C -a 17034		$ arsdate -C -a 17034
	17034 -> 08/20/16		17034 -> 08/20/16

			== Custom date formats ==
			Newer versions of the <code> arsdate</code> command support the <code> -F</code> option, which allows you to use the formatting parameters listed above to determine the format of the output.

			$ arsdate -F "%Y/%m/%d" 17034
			10907 -> 2016/08/20

			$ arsdate -F "%Y-%m-%d %H:%M" -i 1489982862
			1489982862 -> 17-03-20 04:07

			Note that the <code> -F</code> parameter comes first, the date format string is enclosed in quotes, and the internal date/date-time format comes last. By default, arsdate expects a date format - add the <code> -i</code> parameter to process an internal date-time value.

	== IBM CMOD Dates in SQL ==		== IBM CMOD Dates in SQL ==

Jderrick: /* ODWEK Java API Date Formats */

2022-01-19T21:07:22Z

ODWEK Java API Date Formats

← Older revision		Revision as of 21:07, 19 January 2022
Line 83:		Line 83:
	=== ODWEK Java API Date Formats ===		=== ODWEK Java API Date Formats ===

	When using the Content Manager OnDemand Web Enablement Kit ("ODWEK") Java API version v9.5 or higher to load reports into IBM CM OnDemand with the [https://cmod.wiki/dox/ODapiDoc/v10.1/com/ibm/edms/od/ODServer.html#loadInit() ODServer.loadInit()], [https://cmod.wiki/dox/ODapiDoc/v10.1/com/ibm/edms/od/ODServer.html#loadAddDoc(int~~,%20java~~.util.Hashtable~~,%20byte%91;%93;)~~ ODServer.loadAddDoc()] and [https://cmod.wiki/dox/ODapiDoc/v10.1/com/ibm/edms/od/ODServer.html#loadCommit(java.lang.String~~,%20java~~.lang.String) ODServer.loadCommit()] calls, date and date & time fields ~~must~~ be in ISO format.		When using the Content Manager OnDemand Web Enablement Kit ("ODWEK") Java API version v9.5 or higher to load reports into IBM CM OnDemand with the [https://cmod.wiki/dox/ODapiDoc/v10.5/com/ibm/edms/od/ODServer.html#loadInit-- ODServer.loadInit()], [https://cmod.wiki/dox/ODapiDoc/v10.5/com/ibm/edms/od/ODServer.html#loadAddDoc-int-java.util.Hashtable-byte:A- ODServer.loadAddDoc()] and [https://cmod.wiki/dox/ODapiDoc/v10.5/com/ibm/edms/od/ODServer.html#loadCommit-java.lang.String-java.lang.String- ODServer.loadCommit()] calls, date and date & time fields can either be in the format specified in the Application that you are loading data into, or can be in ISO format.

	~~The ISO~~ format ~~is supported directly by~~ the ~~database engine~~, ~~and isn~~'~~t subject~~ to ~~any conversion~~ or ~~reformatting as per~~ the Application ~~definition. Dates must~~ be ~~provided in~~ the ~~"YYYY~~-MM-~~DD"~~ format, ~~or for Date~~ and ~~Time formats~~, ~~"YYYY-MM-DD HH:MM:SS~~.~~FFFFFF"~~.		Since the date field format in the Application can easily be changed inside the CMOD Admin Client, it's highly recommended that any tools developed to use the ODWEK Load API calls be written to use the ISO date or date/time format.

			NOTE: Any character removal specified in the Application configuration (in the Load Information tab, Character Removal pane) will be applied to the data submitted -- which can cause loads to fail if you are removing embedded spaces from incoming data, since the ISO format specifies a space character between the date and the time.

			CMOD attempts to parse date metadata as described in the Application definition (in the Load Information tab) first, and if the date format doesn't match the configured format, then it defaults to the ISO date or date/time format. If neither format matches an acceptable format, then the load will fail.

	== History ==		== History ==

Jderrick: Added ODWEK Date Format.

2020-11-11T01:46:58Z

Added ODWEK Date Format.

← Older revision		Revision as of 01:46, 11 November 2020
Line 80:		Line 80:

	When a user submits a query through a folder, they enter the date (and/or time) in the format specified in the Folder definition, which is then converted into the format defined in the Application Group, then the search is performed in the database, and the results are converted back into the Folder format, and displayed for the user.		When a user submits a query through a folder, they enter the date (and/or time) in the format specified in the Folder definition, which is then converted into the format defined in the Application Group, then the search is performed in the database, and the results are converted back into the Folder format, and displayed for the user.

			=== ODWEK Java API Date Formats ===

			When using the Content Manager OnDemand Web Enablement Kit ("ODWEK") Java API version v9.5 or higher to load reports into IBM CM OnDemand with the [https://cmod.wiki/dox/ODapiDoc/v10.1/com/ibm/edms/od/ODServer.html#loadInit() ODServer.loadInit()], [https://cmod.wiki/dox/ODapiDoc/v10.1/com/ibm/edms/od/ODServer.html#loadAddDoc(int,%20java.util.Hashtable,%20byte%91;%93;) ODServer.loadAddDoc()] and [https://cmod.wiki/dox/ODapiDoc/v10.1/com/ibm/edms/od/ODServer.html#loadCommit(java.lang.String,%20java.lang.String) ODServer.loadCommit()] calls, date and date & time fields must be in ISO format.

			The ISO format is supported directly by the database engine, and isn't subject to any conversion or reformatting as per the Application definition. Dates must be provided in the "YYYY-MM-DD" format, or for Date and Time formats, "YYYY-MM-DD HH:MM:SS.FFFFFF".

	== History ==		== History ==

Jderrick: Formatting change...

2020-10-22T01:51:55Z

Formatting change...

← Older revision		Revision as of 01:51, 22 October 2020
Line 12:		Line 12:
	[[File:Attention.png\|left\|50px]] It's important to be consistent in your use of date formats when defining CMOD Application Groups and CMOD Folders, since the "Date" and "Date+Time" formats are NOT compatible at the folder level - you can't map a Folder "Date" field to an Application Group Field with a 'Date+Time' format! <br/> <br/>		[[File:Attention.png\|left\|50px]] It's important to be consistent in your use of date formats when defining CMOD Application Groups and CMOD Folders, since the "Date" and "Date+Time" formats are NOT compatible at the folder level - you can't map a Folder "Date" field to an Application Group Field with a 'Date+Time' format! <br/> <br/>

	[[File:ConsistentDateFieldFormats.png\|left\|1000px]]		[[File:ConsistentDateFieldFormats.png\|none\|left\|1000px]]

	=== Application Group Dates ===		=== Application Group Dates ===

Jderrick: Added Graphic: Using Consistent Date Field Formats in Content Manager OnDemand

2020-10-22T01:48:00Z

Added Graphic: Using Consistent Date Field Formats in Content Manager OnDemand

← Older revision		Revision as of 01:48, 22 October 2020
Line 11:		Line 11:
	=== Consistency of Date formats===		=== Consistency of Date formats===
	[[File:Attention.png\|left\|50px]] It's important to be consistent in your use of date formats when defining CMOD Application Groups and CMOD Folders, since the "Date" and "Date+Time" formats are NOT compatible at the folder level - you can't map a Folder "Date" field to an Application Group Field with a 'Date+Time' format! <br/> <br/>		[[File:Attention.png\|left\|50px]] It's important to be consistent in your use of date formats when defining CMOD Application Groups and CMOD Folders, since the "Date" and "Date+Time" formats are NOT compatible at the folder level - you can't map a Folder "Date" field to an Application Group Field with a 'Date+Time' format! <br/> <br/>

			[[File:ConsistentDateFieldFormats.png\|left\|1000px]]

	=== Application Group Dates ===		=== Application Group Dates ===

Jderrick: Added CMOD Folder Date & Time Specifiers.

2020-10-21T16:03:47Z

Added CMOD Folder Date & Time Specifiers.

← Older revision		Revision as of 16:03, 21 October 2020
Line 42:		Line 42:

	{\| class="mw-collapsible wikitable" style="width: 800px;"		{\| class="mw-collapsible wikitable" style="width: 800px;"
	\|+CMOD Application Date & Time Specifiers		\|+CMOD Application and Folder Date & Time Specifiers
	!Specifier!!Description!!Usage!!Example		!Specifier!!Description!!Usage!!Example
	\|- style="text-align:center;"		\|- style="text-align:center;"

Jderrick: Added CMOD Application Date and Time Specifiers table.

2020-10-21T00:42:47Z

Added CMOD Application Date and Time Specifiers table.

← Older revision		Revision as of 00:42, 21 October 2020
Line 40:		Line 40:

	The range of available variables for Applications can be found in the online help - search the online help for the phrase "Date and Time Formats".		The range of available variables for Applications can be found in the online help - search the online help for the phrase "Date and Time Formats".

			{\| class="mw-collapsible wikitable" style="width: 800px;"
			\|+CMOD Application Date & Time Specifiers
			!Specifier!!Description!!Usage!!Example
			\|- style="text-align:center;"
			\|%Y\|\|Numeric Year, with leading century\|\|%m-%d-%Y\|\|09-01-'''2020'''
			\|- style="text-align:center;"
			\|%y\|\|Numeric Year, without leading century\|\|%m-%d-%y\|\|09-01-'''20'''
			\|- style="text-align:center;"
			\|%m\|\|Numeric Month, with leading zero\|\|%m-%d-%Y\|\|'''09'''-01-2020
			\|- style="text-align:center;"
			\|%f\|\|Numeric Month, without leading zero\|\|%f-%d-%Y\|\|'''9'''-01-2020
			\|- style="text-align:center;"
			\|%b\|\|Text Month, abbreviated\|\|%b-%d-%Y\|\|'''Sep'''-01-2020
			\|- style="text-align:center;"
			\|%B\|\|Text Month, complete\|\|%B-%d-%Y\|\|'''September'''-01-2020
			\|- style="text-align:center;"
			\|%d\|\|Numeric Day, with leading zero\|\|%m-%d-%Y\|\|09-'''01'''-2020
			\|- style="text-align:center;"
			\|%e\|\|Numeric Day, without leading zero\|\|%m-%e-%Y\|\|09-'''1'''-2020
			\|- style="text-align:center;"
			\|%H\|\|Numeric Hour, 24-hour format\|\|%H:%M:%S\|\|'''12''':34:56
			\|- style="text-align:center;"
			\|%I\|\|Numeric Hour, 12-hour format\|\|%I:%M:%S %p\|\|'''12''':34:56 PM
			\|- style="text-align:center;"
			\|%p\|\|Ante Meridiem / Post-Meridiem\|\|%I:%M:%S %p\|\|12:34:56 '''PM'''
			\|- style="text-align:center;"
			\|%M\|\|Numeric Minute\|\|%H:%M:%S\|\|12:'''34''':56
			\|- style="text-align:center;"
			\|%S\|\|Numeric Second\|\|%H:%M:%S\|\|12:34:'''56'''
			\|-
			\|colspan=4 style="text-align:center;"\| ''Delimiters can be a combination of slashes (/), dashes (-), colon (:), spaces( ) or none. "%b %e, %y" matches '''Sep 5, 2020''' and %Y-%m-%d-%H%M%S matches '''2020-09-01-123456''' for September 1st, 2020 at 12:34:56.''
			\|}

	=== Folder Date Formats ===		=== Folder Date Formats ===

Jderrick: /* Configuring CMOD Date Fields */

2020-10-19T19:45:17Z

Configuring CMOD Date Fields

← Older revision		Revision as of 19:45, 19 October 2020
Line 10:		Line 10:

	=== Consistency of Date formats===		=== Consistency of Date formats===
	[[File:Attention.png\|left\|50px]] It's important to be consistent in your use of date formats when defining CMOD Application Groups and CMOD Folders, since the "Date" and "Date+Time" formats are NOT compatible at the folder level - you can't map a Folder "Date" field to an Application Group Field with a 'Date+Time' format!		[[File:Attention.png\|left\|50px]] It's important to be consistent in your use of date formats when defining CMOD Application Groups and CMOD Folders, since the "Date" and "Date+Time" formats are NOT compatible at the folder level - you can't map a Folder "Date" field to an Application Group Field with a 'Date+Time' format! <br/> <br/>



	=== Application Group Dates ===		=== Application Group Dates ===

Jderrick: Added warning about CMOD Date & Time field incompatibilities.

2020-10-19T15:26:08Z

Added warning about CMOD Date & Time field incompatibilities.

← Older revision		Revision as of 15:26, 19 October 2020
Line 8:		Line 8:

	There are three places to configure date fields in Content Manager OnDemand.		There are three places to configure date fields in Content Manager OnDemand.

			=== Consistency of Date formats===
			[[File:Attention.png\|left\|50px]] It's important to be consistent in your use of date formats when defining CMOD Application Groups and CMOD Folders, since the "Date" and "Date+Time" formats are NOT compatible at the folder level - you can't map a Folder "Date" field to an Application Group Field with a 'Date+Time' format!



	=== Application Group Dates ===		=== Application Group Dates ===

Jderrick: Minor updates to CMOD Date formats.

2020-10-19T14:05:53Z

Minor updates to CMOD Date formats.

← Older revision		Revision as of 14:05, 19 October 2020
Line 23:		Line 23:
	: Before database engines offered native date and time formats, dates were represented as an integer inside the database.		: Before database engines offered native date and time formats, dates were represented as an integer inside the database.
	: A date of zero represented January 1st, 1970 - and 1 for January 2nd, 1970, and so on. August 20th, 2016 is day number 17034.		: A date of zero represented January 1st, 1970 - and 1 for January 2nd, 1970, and so on. August 20th, 2016 is day number 17034.
	: It was NOT possible to represent dates prior to 1970, or after ~~2070~~ with a date field in Content Manager OnDemand before v9.0.		: The supported date range was from January 1st 1970 to December 31st 2058, due to being stored internally as an integer.
			: It was NOT possible to represent dates prior to 1970, or after 2058 with a date field in Content Manager OnDemand before v9.0.

	; Date & Time (old Style)		; Date & Time (old Style)
Line 31:		Line 32:

	=== Application Date Formats ===		=== Application Date Formats ===
	In order to load documents into Content Manager OnDemand, an Application definition must be configured, defining the format and locations and formats of metadata found in the documents (or the index file if one exists). In the Application configuration window, in the "Load Information" tab, you can select a date or date / time format on the ~~leftmost pane~~, then enter the date (and/or time) format on the right hand side of the tab.		In order to load documents into Content Manager OnDemand, an Application definition must be configured, defining the format and locations and formats of metadata found in the documents (or the index file if one exists). In the Application configuration window, in the "Load Information" tab, you can select a date or date / time format from the list called "Application Group Database Name", then enter the date (and/or time) format on the right hand side of the tab in the 'Format' field.

	This allows an Application to be configured to parse almost any existing date format, so it can be converted into the date field type defined at the Application Group level, and stored in the database.		This allows an Application to be configured to parse almost any existing date format, so it can be converted into the date field type defined at the Application Group level, and stored in the database.

			The range of available variables for Applications can be found in the online help - search the online help for the phrase "Date and Time Formats".

	=== Folder Date Formats ===		=== Folder Date Formats ===