Create and Manage a Vocabulary

Customer Managed Vocabularies (CMV) is a user interface created to manage API Vocabulary. A Vocabulary is a way for clients with an API Integration to create a mapping key using Internal Attribute Names instead of Attribute IDs (or GUIDs).

Vocabularies Found in Configurations

API Vocabulary (or Attribute Vocabulary) are located within Configurations > Company Settings > Vocabularies.

Create a Vocabulary

1. Select Create New button in top right-hand corner.

   

2. A popup will appear. Name and give your new vocabulary a short description.

   

3. Select Next.
4. A list of your account’s preferred recipients will appear. Choose recipients and respective requirement sets that are relevant to your API Integration.
5. After selecting relevant recipient requirement sets, select Create.
   • You are able to edit (add/remove) recipient requirement set list after creating your vocabulary.
6. Popup will then disappear and you will be taken to the API Vocabulary Requirement Sets tab.
   • The Requirement Sets tab includes a list of all recipient requirement sets you have chosen to include in your Vocabulary.
7. Toggle to the Attributes tab to begin creating “Internal Attribute Names”(aliases) for attributes within aggregate list by double clicking into the respective cell to name and edit. You can also create Groups to help keep attribute lists organized.
   • Attributes tab includes an aggregate list of all attributes combined from the Requirement Sets tab.
   • Attributes are not added to the Vocabulary until an “Internal Attribute Name”(alias) is assigned and shows Active in the Status column.
8. Finally, after editing your Vocabulary, be sure to click Save Changes.
   • The Delete button will delete your Vocabulary. Vocabulary can also be deleted on the Vocabularies index page.

Requirement Set Tab Column Definitions

• Recipient - Name of the recipient containing requirement set.
• Requirement Set Name - Name of the requirement set contained under the recipient.
• Number of Attributes - Number of attributes contained in the recipient requirement set.
• Last Updated - Date the requirement set was last updated. Last Updated Date is also displayed in Recipients > Choose a Recipient in list > Requirement Sets. When attributes are added to a requirement set, attributes will be automatically added to Attribtues list, but will not be active in the Vocabulary until given an Internal Attribute Name (alias).
• Actions - Select the Trashcan icon in order to remove recipient requirement sets from your vocabulary list. This will remove the recipient requirement set, along with any attributes that are only associated the the recipient requirement set in question.

Attributes Tab Column Definitions

• Internal Attribute Name - Internal Alias. Editable cells.
• Group (Optional) - Create groupings to organize and filter your attributes within aggregate vocabulary list. Editable cells.
• CXH Attribute Name - The name of the attribute within Syndigo. 
• Format Type - Type of attribute:
  • GTIN/UPC
  • Number
  • Text
  • Choice
  • Image
  • Container (MultiValue)
• Help Text - Attribute definition
• Requirement Set - The number of recipient requirement sets within the Vocabulary the attribute is associated with.
• Required - Is the attribute required in one or more associated requirement sets.
• Status - Does the attribute have an Active Internal Attribute Name (alias)
• Ignore/Remove - Ability to Ignore or remove single attributes from aggregate vocabulary list

Status Definitions

• Active - Attribute has an Active alias that is live in the Vocabulary.
• Alias Needed - No alias assigned to attribute in list. Attributes that do not have an alias will not show up in the Vocabulary.
• Ignored - Ignored attributes will not show up in filter. Ignore an attribute by selecting the Eyeball icon located in the Ignore/Remove column.

Create a Group

1. Within the Attributes tab, double click a cell under the “Group (Optional)” column. A dropdown will appear with options to select an existing group, or to create a new group.
2. Select Create new group.
3. In the popup that appears, name your group.
4. Click Create.

Once you create a Group, you will be able to select it in the dropdown and apply it to attributes in list.

Note: Currently, Groups cannot be deleted from list.

Edit an Existing Vocabulary

1. Select the Vocabulary you wish to edit. Then select Edit in the actions bar at the top of the list.

2. Within the Requirement Sets tab, you can add new recipient requirement sets by selecting Add Requirement Set at the top of the page OR remove recipient requirement sets by selecting the respective Trashcan icon within the Actions column.
3. Within the Attributes tab, you can edit Internal Attribute Names along with Groupings, by double clicking the respective cell. TIP: Copy & Paste using CTRL + C for copy & CTRL + V for paste.
4. Click Save Changes.

Obtain a Vocabulary ID (GUID)

Pull a Vocabulary into Edit in order to view Vocabulary ID (GUID) within the URL displayed below:

Who Can View and Edit Vocabulary Using CMV?

Only Admin users on the account will have access to view and edit Vocabularies.
API Vocabulary are only applicable on Syndigo’s new API Integration service.
Feature Set: Customer Managed Vocabularies

Is there a difference between Production and UAT environments?

Yes, the vocabulary id will be different for each of the environments.
If you're working with PROD and UAT, you will need to manage updating the vocabularies in both environments.

Non-API Use Cases:

• Aggregation / copy & paste list of relevant important attributes.
• Understanding the impact of an individual attribute, and how attributes are shared across recipient requirement sets.
• Understanding Attribute Format Type along with Attribute definition provided within the Help Text.

 "Lookups": {
                "RecipientMapping": {},
                "Party": {
                "Walmart": "f6ab47b5-faa3-4540-831c-4407f98537fb" }
            }

"ProductIdentifierProperty": "globalTradeItemNumber (GTIN)",

Click here for further assistance.