Download PDF

Table Definition

In this tab, you can create, edit, and delete the table definitions.

Table

Figure: Table Settings in "System Configuration"

After creating the table definitions here, you can use "Mapping" tab to create the mapping and "Filter" tab to create the filters.

Create Table Definition

Administrator has to perform the following steps to create a new data table.

  1. Click Create Table button. A pop-up will appear.

    Create Table

    Figure: Create Table

  2. Provide the following details:
    1. System: This contains the system ID which is taken by default.
    2. Table Definition Name: Enter the name of the table. You can use only "_" (underscore) as a special character while providing a name for Table Definition. Other special characters are not allowed.
    3. Description: Enter the description regarding the table.
    4. Column Definition: Perform the following steps to add a column.
      1. Click "Add" to add a column. It shows the following row.

        Create Table

        Figure: Add a row

      2. Here, you have to provide the following values to add a column.
        1. Name: Provide a name of the column. You can use only "_" (underscore) as a special character while providing a name for a Column. Other special characters are not allowed.
        2. Type: Select any of the following options to specify the type of input received in this column.
          1. Integer: Select it to accept only whole numbers. It will not accept the decimals.
          2. Numeric: Select it to accept the numbers including decimals.
          3. Boolean: Select it to accept only two values that are "true" and "false".
          4. Varchar: Select it to accept the alphabets with numbers.
          5. Date: Select it to accept the date.
          6. Time: Select it to accept the time.
          7. Timestamp: Select it to accept the timestamp.
        3. Nullable: Select it to let any cell in the column to remain blank. If unchecked, it will be mandatory to enter some value in the cell.
        4. Unique Key: Select it to let the column accept only unique values in its cells.
        5. Primary Key: Select it to make the column primary.
        6. Masked (Licensable): It provides the option to mask the values stored in a field.

          The feature to unmask the already masked values will not be provided. So, use this feature consciously.

          All or only important fields can be masked. If the Administrator selects a field to be maksed, then whatever data will be stored in this field will be masked at User Interface of the entire Ameyo System, in Customer Manager API, and at the backend, in the databases of PostgreSQL. For example, the data will be masked in AmeyoRefresh and CustomerProspect tables. Except the last 4 characters, all characters in the data will be masked with "X" letter such as XXXXXX1234.

          If you are modifying an existing Table Definition or creating a new one in an already existing Ameyo Setup, only the new data will be masked in the field selected for masking, however, the old data will not be masked.

          Perform the following steps to enable the masked Data Processor

          1. Execute the following query to verify whether the maskDataPreProcessor is available or not.

            SELECT * FROM system_configuration_parameter WHERE name = 'customerManagerPreprocessorsNames';

          2. Execute the following query to enable the maskDataPreProcessor if it is not available.

            update system_configuration_parameter set value='duplicatePreprocessor,numberRegexMatcherPreprocessor,standardNumberFormaterPreprocessor,maskDataPreProcessor' where name='customerManagerPreprocessorsNames';

          3. Run the following query.

            update column_definition set masking_policy_type='FIRST_X_LAST_Y_UNMASKED' where name=''; Update column_definition set masking_policy_properties='{"last_y_characters":"4","masked_string":"","first_x_characters":"6"}' where name='<Column_Name_To_Mask>';

          It is configurable that how many digits of the data has to be masked or unmasked from starting and how many digits has to be masked or unmasked from the end.
          Suppose the card number of 10 digits has to be masked. If it is configured that first 5 digits will be unmasked and the last 5 digits will be unmasked, then the complete number will remain unmask.

          If you select "Masked" for a field, then it cannot be "Primary Key" and "Unique Key". Also, default value of "Type" for a Masked field will be "VARCHAR" and it cannot be changed.

          Creating a Table

          Figure: Sample Values to create a Table

          There may be some cases arise when you have to disable the mask data fields. In this case, run the following query to disable the Mask Data Field.
          update system_configuration_parameter set value='duplicatePreprocessor,numberRegexMatcherPreprocessor,standardNumberFormaterPreprocessor' where name='customerManagerPreprocessorsNames';

        7. Default value: Enter the default value that will be displayed in all cells of this column.
        You can add multiple columns using the same steps.
    Following is a screenshot of a table containing different columns.

    Creating a Table

    Figure: Sample Values to create a Table

  3. Click "Save" button to create the table.

    You can click "Cancel" button to not create the table.

Following screenshot shows a newly created table.

Created a Table

Figure: Created a Table

Modify Table Definition

Perform the following steps to edit the table.

  1. Select a table and click "Edit".

    Modify a Table Definition

    Figure: Modify a Table Definition

  2. You can change the following fields here.
    1. Add new column: You can add the new columns in the table definitions. Click "Add" button to add the new column. A blank row is added at the bottom of the table. Here you can define the properties of the table column.

    2. Table Definition Name: Change the name of the table.
    3. Description: Change the description.

    You cannot modify or delete the columns. Also, you cannot modify the column properties such as name, type, Nullable, unique key, primary key, or default value.

  3. Click "Save" to save and apply the changes.

    Click "Cancel" to cancel the changes.

Delete Table Definition

Perform the following steps to delete a table.

  1. Select the table and click "Delete". It shows the following warning message.

    Asking to delete a table

    Figure: Asking to delete a table

  2. Click "Yes" to delete the selected table.
    You can click "No" to not delete the table.