User Community Service Desk Downloads
If you can't find the product or version you're looking for, visit support.ataccama.com/downloads

Lists of Values

Lists of values aggregate referenced and enumerated lists of values assigned to entities.

Currently, there are two default lists: Deployments and Data Instances. Values added under Deployments (for example, cloud and on-premise) are assigned to data sources, while values for Data instances are assigned to catalog items using the Purpose tag.

You can also add and configure new lists as needed.

On the Organization > List of Values tab, you can view and edit existing lists. However, you cannot add new ones as this requires changing the metadata model.

List of Values tab

Create a list of values

To create a new list of values:

  1. Go to Organization > Metadata Model.

    Metadata model list
  2. Select Create entity.

  3. Provide the following information:

    1. Name of the value that you are adding.

      Enter entity name
    2. Property names and types.

      For the purpose of this tutorial, we are adding properties name and description, both of type String.

      Add entity properties
  4. Select Save.

  5. To be able to assign more than one value to the list, create another entity in the Metadata Model:

    If you are planning to have only one value assigned to the new list, you can skip this step.
    1. Select Create entity.

    2. Provide the following information:

      lists of values entity to assign multiple values

      1. Name of the entity.

      2. Property target, of type Referenced object, aiming for the Object that was created in steps 1-4.

        The property name should always be the target.
      3. Property name, of type Delegated scalar property, referring to target.name.

        lists of values second entity properties

    3. Select Save.

  6. Go to the Metadata Model tab again, search for the valueLists entity, and open it.

  7. In the properties list, select Add property and provide the following:

    1. Name: Name of the value list that you have created.

    2. Type: Embedded object array.

    3. Object: Reference the object that you have created earlier in List of Values.

      Add embedded object array property
  8. Select Save.

  9. Continue with section Add the list to an entity or go to Upgrade Center to publish changes.

    Applying changes includes switching to the maintenance mode, creating a database backup, and resolving any potential conflicts. For more information and step-by-step instructions, see Upgrade Center.

    Once the upgrade is complete and the application switches back to the application mode, the new list of values is available on the List of Values tab.

Add the list to an entity

Go to Organization > Metadata Model and search for the entity to which you would like to add the list of values.

On the entity details page, do the following:

  1. In Properties, select Add Property and specify the following:

    1. If you want to enable assigning only one value, provide the following:

      1. Name: Must match the name of the value list that you have created.

      2. Type: Referenced object.

      3. Object: Reference the object that you have created earlier in valueLists.

        Add referenced object property
    2. If you want to be able to assign more than one value, provide the following:

      1. Name: Must match the name of the value list that you have created.

      2. Type: Embedded object array.

      3. Object: Reference the Target object that you have added as a property to the valueLists entity.

        lists of values multiple values property

  2. After the property is added, select the property name to see details.

  3. (Optional) This step changes how the list is displayed in the application. If enabled, the list is shown as a property, with an Add option next to the property name, and not as a list of entities.

    valueList property
    1. In Traits, select Add mmd trait and set the Trait name to valueList:property.

      Add MMD trait
  4. Select Save.

  5. Go to Upgrade Center and publish the changes.

    Applying changes includes switching to the maintenance mode, creating a database backup, and resolving any potential conflicts. For more information and step-by-step instructions, see System Changes.

  6. The new reference list is added to the new entity. To be able to use the list, start creating list values as describe in [Add items to list].

Add items to the list

To add new items to an existing list:

  1. Go to Organization > List of Values.

  2. Depending on which list you want to edit, select Add Deployment or Add Data Instance respectively.

  3. Specify the name for the new item and select Save. Alternatively, before saving, select Create another to create a second item immediately.

    Create new item
  4. Publish the changes.

    A new Deployment item is now available in the Summary widget of data sources while a new Data Instance item is available as Purpose on the catalog item overview screen.

    New Data Instance item

Edit or remove value from the list

To modify or remove an item from a list:

  1. Go to Organization > List of Values.

  2. To edit a value name, use the three dots menu next to the value and select Edit.

    Provide a new name and select Save.

  3. To remove a value, use the three dots menu and select Delete.

  4. You can also change the description of the list of values entity. To do this, select Edit in the upper-right corner of the screen.

    Update the description and select Save.

Was this page useful?