How to create and export SKOS collections

Collections provide a method to export groups of unstructured Semaphore concepts to clients and other Semaphore models. For optimum portability, collections are exported as JSON documents in a SKOS-compliant format. This topic describes how to do the following:

• Create a collection of concepts
• Build your collection
• Export your collection

Related videos

In this video, you will learn about SKOS collections, including when and why to use collections, how they support non‑hierarchical organization, and downstream integration.

Create a collection of concepts

To create a collection:

1. Open your model; then, click Open Master. Note that, for this procedure, we will use the provided Geographic Locations sample model in our examples.

2. Select the tab to navigate to the Collections View.

3. Click the + Create a collection button. The + Create a new collection window opens.

4. Provide values for the following options:

   • Collection: Specify the name of your collection. For example, Australian Cities.
   • Language: Select the language used for the collection label.
   • Customize URI (optional): Check the box to use a custom URI for the collection.
   • Custom URI (optional): Specify the custom URI for the collection endpoint. This URI is used to return the collection using GET requests.

5. Click Save.

Build your collection

To build your collection, navigate to the view of your collection by selecting tab and then the name of your collection (for example Australian Cities). Next, add values for the following fields by clicking on the corresponding button:

• Labels (optional): Specify labels for your collection in different languages.
• Metadata (optional): Select metadata fields to add to your collection.
• Members: Select concepts from your model to add to your collection. For example, Sydney, Melbourne, and any other Australian cities you want to add.

In addition, you can add individual concepts to a collection in the Details view for the concept. To add a concept to a collection, click the button for the Member of field and select the collection to which you want to add the concept. See Add a concept for more information about the Details view for concepts.

Export your collection

You can export your collection to clients or Semaphore models in the same instance.

Export to clients

To export your collection to a client, configure your client to issue a GET request to the URI endpoint for your collection. The endpoint returns the collection as a JSON document in an SKOS compliant format. To view the URI for your collection, click the (URI) button at the top of the Details view for the collection.

Export to other Semaphore models

Collections can be exported to other models in the same Semaphore instance by completing the following steps:

1. Select the tab.

2. In the list of collections, click the button next to the collection you want to export; then, select Export Collection. The Export "<collection_name>" window opens.

3. From the Target model field, select the model to which you want to export your collection.

4. Click Export.