Date Format
Upon initial installation, the date format in Cals Platz is set to "N/A". In this state, the system defaults to the yyyy-MM-dd format. For database columns of type DATE or DATETIME, data is stored according to the input format allowed by the configured DB Type (MySQL).
The Locale Date Format feature allows modification of system's default date format at the tenant level. This setting impacts how date-related fields are displayed and stored across Cals Web Application, Mobile, and Open API.
How to Change the Date Format
In the App environment, you can modify the Date Format from the Application Setting > Locale menu. In Provisioning, initial date format settings are applied to all tenants. Subsequent changes can be made within Tenant Setting > Locale followed by Deploy and Publish to apply tenant-specific configurations.
[Image 1. Location of Date Format Setting within the Locale Menu]
- Selecting a locale automatically assigns a suitable date format.
- The assigned Date Format can be changed.
- N/A: Use this option if you do not wish to apply any Date Format.
Date Format Application Logic
Before the Venus Project version released on February 25, date format conversion logic was not available. As a result, data that did not conform to the expected format was either registered without conversion or stored without error. Therefore, configuring Locale > Date Format may cause errors (e.g., [Error Code 501006] Config contains an error) in components that previously handled data retrieval and storage normally. If no Date Format is set, these errors will not occur.
- To disable Data Format application, set Locale > Date Format to N/A.
The Locale Date Format is applied to the core BO program (Lambda) and affects data retrieval in web, mobile, and Open API interfaces.
| Table Field | BO Field | Availability | Availability Description |
|---|---|---|---|
| DATE | Date | Y | Recommended |
| DateTime UTCDateTime | N | Retrieval is possible, but saving will result in an error. | |
| String | N | For retrieval, data is not converted to the Locale format; during saving, it is stored as 0000-00-00. | |
| `DATETIME` | DateTime UTCDateTime | Y | Recommended |
| Date | Y | Recommended for use with a DatePicker (the value must be in a proper date format; including a time format will cause an error) | |
| String | Y | Recommended for use with a DatePicker (the value must be in a proper date format; including a time format will cause an error) | |
| VARCHAR | Date DateTime UTCDateTime | Y | Stored as the input value without conversion by storage conversion logic. Use DatePicker for Date BO Fields and DateTimePicker for DateTime/UTCDateTime BO Fields. Using Text controls will display data in the database's stored format, which may not align with the Locale setting. |
Data Retrieval Logic
This logic formats date-related data retrieved from the database for display in components like List and Form Components.
Conversion Rules
- Conversion occurs when the Table Column is of type
DATEorDATETIMEand the BO Field is Date, Datetime, or UTCDateTime.WARNING
Date Format logic is not applied to non-date Table Column types (e.g.,
VARCHARorCHAR). - The format of the retrieved data is determined based on the BO Field.
- Conversion priority: 1) Display Format, 2) Locale Date Format.
Case 1) Locale: dd/MM/yyyy, Display Format: N/A
When only Locale is registered, data is converted using the Locale format.
| Table Column | BO Field | Conversion Logic | Stored Value (DB) | On-Screen Result (displayed in Locale format: dd/MM/yyyy) |
|---|---|---|---|---|
| Varchar | String | N/A | 2025-02-01 | - |
| Date | String | N/A | 2025-02-01 | - |
| DateTime | String | N/A | 2025-02-01 00:00:00 | - |
| Varchar | Date | N/A | 2025-02-01 | - |
| Date | Date | Conversion Target | 2025-02-01 | 01/02/2025 |
| DateTime | Date | Conversion Target | 2025-02-01 00:00:00 | 01/02/2025 |
| Varchar | DateTime | N/A | 2025-02-01 00:00:00 | - |
| Date | DateTime | Conversion Target | 2025-02-01 | 01/02/2025 00:00:00 |
| DateTime | DateTime | Conversion Target | 2025-02-01 00:00:00 | 01/02/2025 00:00:00 |
Case 2) Locale : N/A, Display Format : dd-MM-yyyy
When only the Display Format is registered, conversion is based on the Display Format.
| Table Column | BO Field | Conversion Logic | Stored Value (DB) | On-Screen Result Display Format: dd-MM-yyyy |
|---|---|---|---|---|
| Varchar | String | N/A | 2025-02-01 | |
| Date | String | N/A | 2025-02-01 | |
| DateTime | String | N/A | 2025-02-01 00:00:00 | |
| Varchar | Date | N/A | 2025-02-01 | |
| Date | Date | Conversion Target | 2025-02-01 | 01-02-2025 |
| DateTime | Date | Conversion Target | 2025-02-01 00:00:00 | 01-02-2025 |
| Varchar | DateTime | N/A | 2025-02-01 00:00:00 | |
| Date | DateTime | Conversion Target | 2025-02-01 | 01-02-2025 00:00:00 |
| DateTime | DateTime | Conversion Target | 2025-02-01 00:00:00 | 01-02-2025 00:00:00 |
Case 3) Locale : dd/MM/yyyy, Display Format : dd-MM-yyyy
When both Locale and Display Format are registered, conversion is based on the Display Format.
| Table Column | BO Field | Conversion Logic | Stored Value (DB) | On-Screen Result |
|---|---|---|---|---|
| Varchar | String | N/A | 2025-02-01 | |
| Date | String | N/A | 2025-02-01 | |
| DateTime | String | N/A | 2025-02-01 00:00:00 | |
| Varchar | Date | N/A | 2025-02-01 | |
| Date | Date | Conversion Target | 2025-02-01 | 01-02-2025 |
| DateTime | Date | Conversion Target | 2025-02-01 00:00:00 | 01-02-2025 |
| Varchar | DateTime | N/A | 2025-02-01 00:00:00 | |
| Date | DateTime | Conversion Target | 2025-02-01 | 01-02-2025 00:00:00 |
| DateTime | DateTime | Conversion Target | 2025-02-01 00:00:00 | 01-02-2025 00:00:00 |
Data Storage Logic
Conversion Rules:
- For Table Columns of type Date or DateTime, if the BO Field does not match the conversion logic, data may not be saved or an error may occur.
- Conversion priority: 1) Data Format, 2) Locale Date Format.
WARNING
Data will not be stored if the input value from the screen is not in the correct format.
Case 1) Locale : N/A
When no Date Format is specified, data is converted and stored using the MySQL default date format, yyyy-MM-dd.
| Table Column | Input Value (Screen) | Stored Value (DB) | Description |
|---|---|---|---|
| Varchar | 2025-01/01 | 2025-01/01 | |
| Date | 2025-01-01 | 2025-01-01 | |
| Date | 2025-01/01 | 2025-01-01 | None |
| Date | 20250101 | 2025-01-01 | |
| DateTime | 2025-01-01 00:00:00 | 2025-01-01 00:00:00 | |
| DateTime | 2025-01-01 | 2025-01-01 00:00:00 | |
| DateTime | 2025-01/01 00:00:00 | 2025-01-01 00:00:00 | |
| DateTime | 20250101 00:00:00 | 2025-01-01 00:00:00 |
Case 2) Locale : dd-MM-yyyy
The Locale format is used to check the input value and store it accordingly.
| Table Column | Input Value (Screen) | Stored Value (DB) | |
|---|---|---|---|
| Varchar | 01/01-2025 | 2025-01/01 | Saved as input value without applying conversion logic. |
| Date | 01-01-2025 | 2025-01-01 | Saved as the input value conforms to the format. |
| Date | 01/01-2025 | Error: Does not conform to the Locale format. | |
| Date | 01012025 | Error: Does not conform to the Locale format. | |
| DateTime | 01-01-2025 00:00:00 | 2025-01-01 00:00:00 | |
| DateTime | 01-01-2025 | 2025-01-01 00:00:00 | |
| DateTime | 01/01-2025 00:00:00 | Error: Does not conform to the Locale format. | |
| DateTime | 01012025 00:00:00 | Error: Does not conform to the Locale format. |
Values for DATE and DATETIME columns in the DB are always stored in the yyyy-MM-dd format, regardless of the Data Format or Locale DateFormat settings.
For text columns such as VARCHAR or CHAR, the data is stored in the format specified by the user's Data Format or Locale DateFormat settings.
Date Format Application Considerations
- Changing the Date Format from N/A triggers additional conversion logic. If the Table Column type and BO Field type do not match, the logic may not function correctly. Therefore, if you modify the settings for a tenant originally configured as N/A, you must verify data retrieval and storage on all screens.
- If the data stored in the database is in a format that cannot be converted, conversion errors may occur, causing data retrieval to fail. Therefore, after deployment, it is necessary to check the data stored in the database if retrieval errors occur.
- Date Format settings do not apply to BO Field Calculations. For example, if a field displayed as "01/01/2025" due to Locale settings is processed with LEFT([DATE],4), it will display "2025".
- Locale Date Format settings are not applied in the mobile app.
- After changing the Data Format or Locale Date Format and deploying, users with existing metadata may encounter errors during data storage or retrieval. A re-login is required to obtain the new metadata.
- Considerations for Component and Control Interface Actions: When transferring values from a source BO Field (String) to a target BO Field (Date or DateTime), the value must be in a format compatible with the specified Date Format or the default formats (
yyyy-MM-ddoryyyy-MM-dd HH:mm:ss). - Date format conversion logic is applied on the server side based on the Business Object Field type. Therefore, when third-party applications (e.g., Java) access data via Cals Lambda or APIs related to BO Config, the request and response data must be formatted according to the configured Locale Date Format.