Skip to content

How to use Custom Vocabulary?

Bibek Mani Acharya edited this page Apr 6, 2020 · 2 revisions

What is custom vocabulary?

In certain types of vocabulary lists, code numbers 98 and 99 are used indicating the vocabulary is maintained by the Reporting Organization.

Custom vocabulary is a pro feature in Aidstream, which helps the organizations to host their own list of Code and Description for their vocabulary code 98 and 99.

URL format

The format or URL of custom vocabulary will be aidstream.org/reference/codelist/{org_identifer}/{element}
where,
org_identifier is your Organization Identifier element is the name of the element (eg: sector)

Elements Supported for Custom Vocabulary

Custom Vocabulary List is available for the following elements.

  • Result Indicator
  • Policy Marker
  • Sector
  • Humanitarian Scope
  • Region
  • Result Reference
  • Tag

How to Activate Custom Vocabulary?

If you are a pro user, Custom Vocabulary is already activated. You just need to add the code and description for the respective Vocabulary.

Let's take an example of Sector Vocabulary.

  • Go to Left sidebar and click on Custom Vocab
  • Click the Edit button on the Sector Vocabulary
  • Add Custom Code and Custom Description
  • You can add multiple code and description by clicking on the Add More button

How to use Custom Vocabulary in Element?

After you have added the custom vocabulary for Sector and select 98 or 99 in the vocabulary, you can see the Use my custom vocab checkbox just below the Vocabulary drop down in Sector Element.

Screen Shot 2020-04-06 at 12 38 52

By clicking on the checkbox, the Vocabulary Url is automatically filled with the custom vocabulary URL maintained at Aidstream. The custom code and description you have filled will also be automatically filled in the Sector Code as shown in the image below

How to remove the Custom Vocabulary Url?

You can remove the Custom Vocabulary Url from the Custom Vocabulary settings.

Click on the Delete icon on the right side of the individual Elements.

Please note that the Custom Vocabulary Url will not be removed activities that already includes the URL. You have to manually remove it from the Activity Form.

Clone this wiki locally