The Data Dictionary provides a centralized view of all data fields available across the Yarken application. It serves as a reference for understanding data structures and downloading standardized templates for data loading.
Use the Data Dictionary to:
-
Download data templates for supported datasets
-
Review field names, descriptions, and data types
-
Identify mandatory and optional fields for data uploads
-
Identify field size limits and data constraints
-
Understand the impact and severity (high or low) of missing data in each field
How to use the Data Dictionary
Procedure
To download a template file,
-
Navigate to Admin > Data Dictionary.
-
Use the search box or browse the list in the left pane.
-
Select a data table, for example, Actual Spend.
-
Once selected, the system displays all fields associated with that data table.
-
In the upper-right corner, click DOWNLOAD.
-
(Optional) Enable Include Field Descriptions to include detailed field descriptions in the downloaded files.
The system downloads a ZIP file containing:
-
A .csv file — the data template to be used for uploads
-
A .xlsx file — the data dictionary with field definitions, data types, field size, mandatory flags, and impact severity
Field size
When reviewing the Data Dictionary (either in the UI or the downloaded .xlsx file), the Size column indicates the maximum amount of data a field can store or the range of values allowed.
|
Data Type |
Size Meaning |
Example |
|---|---|---|
|
String |
Maximum number of characters allowed. |
A size of 255 means the field can store up to 255 characters (e.g., Expense Type). |
|
Integer |
Range of whole numbers the field can store. |
-2,147,483,648 to 2,147,483,647 |
|
Float/Decimal |
Approximate range of decimal values the field can store. |
Approximately 1E-307 to 1E+308 |
|
Yes/No (Boolean) |
Stores one of two possible values. |
Yes/No (internally represented as True or False). |
Note: For text fields, the Size column represents the maximum character length. For numeric and boolean fields, it represents the supported value range or allowed values.
When to use the Data Dictionary
Use the Data Dictionary when you:
-
Prepare files for data uploads
-
Validate field requirements before loading data
-
Troubleshoot upload errors caused by missing or incorrect fields
-
Understand the business impact of incomplete data