Difference between revisions of "Time Period Format Validation"
(Created page with "The Registry will validate observation dates against an expected format. This Data Validator is called “Time Period Format” and enforces that format of the reported time p...") |
|||
| Line 22: | Line 22: | ||
| Date Time || I || 2001-12-31T23:59:59 | | Date Time || I || 2001-12-31T23:59:59 | ||
|} | |} | ||
| + | |||
| + | == Alternate Half-Year Format == | ||
The Registry also supports an alternate Hourly format. With this alternate format, the value of “Half Of Year” may be represented by an '''H''' and the Hourly format is not supported. | The Registry also supports an alternate Hourly format. With this alternate format, the value of “Half Of Year” may be represented by an '''H''' and the Hourly format is not supported. | ||
| Line 34: | Line 36: | ||
export JAVA_OPTS=-DTF_ALTERNATE_HALF_YEAR=true | export JAVA_OPTS=-DTF_ALTERNATE_HALF_YEAR=true | ||
(For Unix systems) | (For Unix systems) | ||
| + | |||
| + | If this is provided correctly, this will be reported in the startup sequence of the Registry with a log entry like the following: | ||
| + | |||
| + | 2021-12-31 23:59:59.123 INFO main io.sdmx.core.fmr.application.FusionRegistryApplicationInitialiser - Using 'Alternate Half-Year' Setting | ||
Revision as of 23:57, 6 June 2022
The Registry will validate observation dates against an expected format. This Data Validator is called “Time Period Format” and enforces that format of the reported time periods match the expected value defined in the DSD. Note: This Data Validator is only applied if the Data Structure has a dimension called “FREQ”. This time formats are defined as follows:
| Format | Frequency Code | Example Usage |
|---|---|---|
| Yearly | A | 2001 |
| Half-Of-Year | S | 2001-S1 |
| Third-Of-Year | T | 2001-T3 |
| Quarter-Of-Year | Q | 2001-Q4 |
| Month | M | 2001-12 |
| Week | W | 2001-W52 |
| Date | D | 2001-12-31 |
| Hour | H | 2001-12-31T23 |
| Date Time | I | 2001-12-31T23:59:59 |
Alternate Half-Year Format
The Registry also supports an alternate Hourly format. With this alternate format, the value of “Half Of Year” may be represented by an H and the Hourly format is not supported.
To enable this mode, the Registry must be started with a Java System variable called “TF_ALTERNATE_HALF_YEAR” must be specified and set to “true”.
The simplest way to perform this is by modifying the setenv.bat or setenv.sh file. To illustrate this:
SET JAVA_OPTS=-DTF_ALTERNATE_HALF_YEAR=true (For Windows systems)
export JAVA_OPTS=-DTF_ALTERNATE_HALF_YEAR=true (For Unix systems)
If this is provided correctly, this will be reported in the startup sequence of the Registry with a log entry like the following:
2021-12-31 23:59:59.123 INFO main io.sdmx.core.fmr.application.FusionRegistryApplicationInitialiser - Using 'Alternate Half-Year' Setting
