Data Dictionaries
    • Dark
      Light

    Data Dictionaries

    • Dark
      Light

    Article summary

    Configure dynamic operators more efficiently with the Data Dictionary panel. The panel provides convenient access to create, download, upload, and view data dictionary tables, making it easy to reference and utilize relevant data in the configuration. This streamlines the workflow and enhances productivity if you are working with dynamic operators.

    Accessing Your Data Dictionaries

    This guide explains how to access your data dictionaries

    Accessing Data Dictionaries from Workspace Manager

    Step 1: Start by selecting the Data Dictionaries chip in the Workspace Manager

    Image

    Step 2: After clicking, a page displays all uploaded data dictionaries for the selected workspace. Hover over each data dictionary to view its name, last modified date, and the person who last modified it.

    Image

    Accessing Data Dictionaries from Workspace Navigation

    Step 1: Find the workspace navigation dropdown from any workspace artifact like Pipeline Builder or Runtime Fields. Use this feature to navigate between different artifacts within the workspaces, including Data Dictionaries.

    Image

    Accessing Data Dictionaries from Pipeline Builder

    Step 1: The process to access data dictionaries from an operator remains the same. Navigate to Pipeline Builder and select any Operator.

    Image

    Step 2: Within the panel, access the data dictionary panel located at the top right corner.

    Image

    Image

    Creating Your First Data Dictionary

    This guide explains how upload your first data dictionary.

    Creating from Workspace Manager

    Step 1:  Start by selecting the Data Dictionaries chip in the Workspace Manager

    Image

    Step 2: There are two ways to create a data dictionary. If no data dictionary exists, click the button “Create Data Dictionary” in the middle of the page to create your first data dictionary.

    Image

    Otherwise, locate the navigation bar on the top right corner, and click on “Create New” to create your first data dictionary.

    Image

    Step 3: Name the new data dictionary.

    Step 4: Upload the file. If unsure about the type of file to upload, refer to the file-related information provided in the tooltips.

    CSV Files for Tables: The first row represents the column name, and the second row indicates the type. The subsequent rows contain the table data.  

    Supported Types: Types are case sensitive and have certain requirements for the data that are entered into their columns.

    The following are the supported types and the requirements for each type:

    • Text: Text types will accept any strings. If you want to represent a null enter '==NULL==' without the quotes. If you want a reserved character, i.e. comma, new line or ==NULL==, put either the character or entire string in double quotes '"test ,Text"'

    • long: long types support integers.

    • double: double types support floating point numbers. You can also represent not a number as 'NaN' as well as negative and positive infinity as 'inf' and '-inf'

    • bool: bool types support true and false, case insensitive.

    • LocalDate: LocalDate types are a date and are in the following format: '%Y-%m-%d'. EX: 2023-04-26

    • Instant: Instant types are a moment in time and in the following format: '%Y-%m-%dT%H:%M:%S.%fZ', EX: 2023-04-26T13:33:30.000Z

    Step 5: Once the data dictionary is ready, drag and drop it to upload. The uploaded file is now available as a data dictionary.

    Creating from Pipeline Builder

    Step 1: Select an Operator, then access the data dictionary panel located at the top right corner.

    Note: To enlarge the view of the data dictionary select the “Open in new tab” option from the menu

    Step 2: To create a Data dictionary choose the option to create a new data dictionary.

    Step 3: Name the new data dictionary.

    Step 4: Upload the file. If unsure about the type of file to upload, refer to the file-related information provided in the tooltips.

    CSV Files for Tables: The first row represents the column name, and the second row indicates the type. The subsequent rows contain the table data.  

    Supported Types: Types are case sensitive and have certain requirements for the data that are entered into their columns.

    The following are the supported types and the requirements for each type:

    • Text: Text types will accept any strings. If you want to represent a null enter '==NULL==' without the quotes. If you want a reserved character, i.e. comma, new line or ==NULL==, put either the character or entire string in double quotes '"test ,Text"'

    • long: long types support integers.

    • double: double types support floating point numbers. You can also represent not a number as 'NaN' as well as negative and positive infinity as 'inf' and '-inf'

    • bool: bool types support true and false, case insensitive.

    • LocalDate: LocalDate types are a date and are in the following format: '%Y-%m-%d'. EX: 2023-04-26

    • Instant: Instant types are a moment in time and in the following format: '%Y-%m-%dT%H:%M:%S.%fZ', EX: 2023-04-26T13:33:30.000Z

    Step 5: Once the data dictionary is ready, drag and drop it to upload. The uploaded file is now available as a data dictionary.

    Viewing An Existing Data Dictionary

    This guide explains how view your data dictionaries.

    Viewing from Workspace Manager

    Step 1:  Start by selecting the Data Dictionaries chip in the Workspace Manager

    Image

    Step 2: This action directs to the data dictionary list page displaying all data dictionaries.

    Image

    Step 3: Click on a specific data dictionary to view its details.

    Image

    Step 4: View the selected data dictionary data

    Image

    Viewing from Pipeline Builder

    Step 1: Navigate to the pipeline builder.

    Image

    Step 2: Select any operator.

    Image

    Step 3: Click on the data dictionary icon on the open panel

    Image

    Step 4: Select the specific data dictionary to view.

    Image

    Step 5: View the selected data dictionary data

    Image

    Modifying An Existing Data Dictionary

    This guide explains how to modify a data dictionary.

    Modifying from Workspace Manager

    Step 1: On the top navigation bar, select the Download option to have a local copy.

    Image

    Step 2: Modify the downloaded data dictionary.

    Step 3: On the top navigation bar, select the Upload option.

    Image

    Step 4: Choose the modified file and upload it.

    Image

    Modifying from Pipeline Builder

    Step 1: Download the data dictionary to have a local copy.

    Step 2: Modify the downloaded data dictionary.

    Step 3: In the expanded Data Dictionary screen Select the Upload option.

    Step 4: Choose the modified file and upload it.

    Deleting An Existing Data Dictionary

    This guide explains how to delete a data dictionary.

    Deleting from List Page

    Step 1: Select the data dictionary to delete from the list.

    Image

    Step 2: Click on the Proceed option to confirm the deletion.

    Image

    Deleting from View Page

    Step 1: Navigate to the options in

    Image

    Step 2: Click on delete to remove the data dictionary.

    Image

    Step 3: Click on the Proceed option to confirm the deletion.

    Image

    Supported File Types

    CSV Files for Tables: The first row represents the column name, and the second row indicates the type. The subsequent rows contain the table data.  

    Supported Types: Types are case sensitive and have certain requirements for the data that are entered into their columns.

    The following are the supported types and the requirements for each type:

    • Text: Text types will accept any strings. If you want to represent a null enter '==NULL==' without the quotes. If you want a reserved character, i.e. comma, new line or ==NULL==, put either the character or entire string in double quotes '"test ,Text"'

    • long: long types support integers.

    • double: double types support floating point numbers. You can also represent not a number as 'NaN' as well as negative and positive infinity as 'inf' and '-inf'

    • bool: bool types support true and false, case insensitive.

    • LocalDate: LocalDate types are a date and are in the following format: '%Y-%m-%d'. EX: 2023-04-26

    • Instant: Instant types are a moment in time and in the following format: '%Y-%m-%dT%H:%M:%S.%fZ', EX: 2023-04-26T13:33:30.000Z

    Looking for a sample data dictionary? You can download a sample CSV file by clicking on the provided link.


    What's Next