Description of an application profile
An application profile describes how the core vocabulary is specified and restricted in a specific context.
When you land on the datamodel page, you will see the name of the datamodel and its basic information at the top of the page:
- datamodel type: an icon and an entry on whether the datamodel is a core vocabulary or an application profile
- datamodel identifier (a short identifier individualising the datamodel in this tool)
- version number (if the datamodel has been published)
- datamodel status.
If the datamodel has been published, the status may be Suggested or Valid.
The status is Draft if the datamodel is still a work in progress, i.e., a working version. In that case, the datamodel is visible only to persons in the same organisation. A datamodel in Draft status does not have a version number.
In the Search section, you can see the search field and below it, a list of all of the following resources included in the datamodel:
- class restrictions
- attribute restrictions
- association restrictions.
Use this datamodel’s own search function to filter the tool to display only the information you want to see on the list. Use the name of the resource to search for the resources included in the datamodel, i.e. class, attribute and association restrictions.
The search result will be a list of resources that meet the search criteria. Go to the desired class, attribute or association restriction by clicking its heading on the list.
The information describing the datamodel is almost the same for core vocabularies and application profiles, but in some respects these data model types differ. The information on an application profile is described below.
Field | Description |
|---|---|
Datamodel name | Name displayed for the datamodel in lists and search results. There will be a separate name field for each language. |
Description (optional) | A short verbal description of the content and intended use of the datamodel. There is a separate description field for each language. If more information has been provided on the datamodel, it has been entered on the Documentation page. |
Identifier | A string used to individualise a datamodel in the Data Vocabularies tool. The identifier is visible in the IRI addresses of the datamodel and the resources belonging to it (class, attribute, association restrictions). |
Datamodel IRI | A string that uniquely identifies the data model across the entire Internet. This address can be referenced in a machine-readable way, for example in interfaces. Click the Copy to clipboard button to save the IRI address to your computer’s clipboard. |
Version number of datamodel | A published datamodel always has a version number. If the status of the datamodel is Draft, the datamodel does not have a version number. A datamodel in Draft status is visible only to the members of the same organisation. |
Model version IRI | All versions of a datamodel have the same shared basic IRI address. In addition to this, the datamodel version has its own IRI address, which not only individualises the datamodel but also the version. In this case, the IRI address also contains the version number. Click Copy to clipboard when you want to save the IRI address to the clipboard of your computer. |
Domains | Information about which domain or domains the datamodel belongs to. A domain describes the subject areas of the data model’s content. The domain helps in finding the datamodel and narrowing searches based on content. |
Datamodel languages | Information on which languages the content of the datamodel has been described. There may be one or more languages. |
Links to additional information | Links to additional information, for example, to a project’s blog page or to a legal provision. |
Created | A time stamp indicating when the datamodel was created. Members of the same organisation will also see the name of the person who created the datamodel. |
Prior versions | Open the menu from the chevron symbol and you will see a list of prior versions of this datamodel, if there are any. |
Contributors | Information on what party, i.e. organisation has produced the datamodel and is responsible for its content. The contributors may be one or more organisations. |
Feedback | Contact information of the organisation that produced the datamodel. Users can send feedback and questions related to the content, etc. to this address. |
The Links page has lists of all the terminologies, codelists and other datamodels (namespaces) that have been used in modelling the data. For example, a resource may have been linked to a concept in a terminology.
A codelist listing the values that an attribute restriction may get can in turn be linked to attribute restrictions.
Additional functionalities for a data model editor
More functionalities are visible to an editor who is logged in the Data Vocabularies tool, i.e. to a data model editor.
If you have the editing rights for the datamodel, you can also see the Edit button on the page. Click the button and you will be able to add links by using an online form.
The other option is that the tool adds the links automatically if you, when modelling,
- link a new concept to a class, attribute or association restriction of your datamodel
- link a new codelist to an attribute restriction
- add a resource from a new datamodel that has not previously been linked to your datamodel.
Linking terminologies
Click the Add terminology button when you want to add a link to one of the terminologies in the Terminologies tool.
Find a suitable terminology either by entering a search word in the Search for terminology field or by browsing the list of terminologies. Select the desired terminology or terminologies by clicking the box next to the terminology and Add selected button. The tool adds the selected terminology or terminologies to the Links page. In the end, click Save.
Linking datamodels i.e. namespaces
Click the Add datamodel button when you want to add a link to a datamodel.
Links can be made both to a datamodel located in the Data Vocabularies tool and to an external datamodel. You can search for datamodels with the name of the datamodel. The search results can be filtered with the following information:
- Datamodel type: core data model or (application) profile
- Domain: filtering that has been conducted by theme; the domains are the same as on the front page of the tool
- Status: the default value is Statuses in use, which means all datamodels in Suggested and Valid status as well as the same organisation's datamodels in Draft status. Other options are All statuses and Statuses not in use, which includes Superseded and Retired.
- Content language: the languages that have been used in the datamodel.
Select the desired datamodel(s) by checking the box next to the datamodel. The tool adds the selected datamodel(s) to the Links page. In the end, click Save.
Utilisation of resources external to the Data Vocabularies tool (namespaces)
Click Add reference to external datamodel to link datamodels external to the Data Vocabularies tool (namespaces) to your own datamodel.
Select the desired datamodel from the drop-down menu. If the required datamodel does not appear on the list, contact Interoperability Platform developers. An external datamodel can be added if it is resolvable, i.e. a redirectable datamodel or ontology.
- Namespace: the web address of a datamodel
- Datamodel name: a text field in which you can enter the desired name in the languages that you have defined as the languages of your datamodel.
- Prefix: the identifier of the datamodel in the Data Vocabularies tool. The identifier must be unique, i.e. it cannot be the same as the identifier of another resource already in the Interoperability Platform.
After entering the required information, click the Add button. The tool adds the datamodel defined by you to the Links page. In the end, click Save button.
Linking of codelists
Click the Add reference data button to add a link to a codelist in the Reference Data tool.
Find a suitable codelist either by entering a search word in the Search for reference data field or by browsing the list of codelists. You can filter the information based on the code set group (i.e., register). You can also filter the results based on the status of the code set
Select the desired codelist(s) by ticking the box next to the codelist. The tool adds the selected codelist(s) to the Links page. In the end, click Save.
Under the heading Class restrictions, you will see a list of the class restrictions included in the datamodel in alphabetical order according to name of the class restriction.
Click the heading of the desired class to display more specific information on the class concerned, such as:
- Class restriction name
- Class restriction identifier in the Data Vocabularies tool
- Long identifier i.e. IRI address of the class restriction: uniquely identifies the class restriction on the entire internet.
The IRI address can be used to also refer to the class from outside the Data Vocabularies tool in machine readable interfaces, for example.
Click the Copy to clipboard button and the tool will import the IRI address to your workstation's clipboard. - Concept: a link to a concept in the Terminologies tool.
- Targets library class: A core vocabulary class that is used as a basis for the description of this class restriction. A class restriction restricts or supplements the data of a core data model class in this data model.
- Utilises class restriction: Some other class restriction in the application profile, used as a basis for the description of the class restriction in this datamodel.
- Technical description: A brief description of the class and an example of its intended use.
- API path: If you need to export valid Open API specifications, you can define the API path here. Paths can include path ({}) or query (?&) parameters, for example: /org/{id}/?name&role.
- Attribute restrictions: A list of attribute restrictions included in the class. Click the name of the attribute restriction to view more specific information on it.
- Association restrictions: A list of association restrictions included in the class. Click the name of the association restriction to view more specific information on it.
- References: Information about the resources that have utilized this class restriction’s resources, and a link to those resources.
- Created: Date and time of creating the class restriction.
- Last modified at: Date and time when the information on the class restriction was last changed.
- Work group comment: Comments and instructions for other persons editing information on the class restriction. The content of this field is not visible to persons outside the same organisation.
- Contributors: One or more organisations owning and maintaining the data in the Data Vocabularies tool.
Additional functionalities for a data model editor
If you have the data model editor’s rights for the tool, you will see the Actions menu in your organisation's datamodels and edit functions in the menu. You can edit the selected class restriction or its identifier. You can also remove the class restriction.
In the Class restrictions view, you can
- copy an IRI address to clipboard
- add attribute restrictions to a class
- add association restrictions to a class
- view the references to the class restriction, i.e. those resources of the Data Vocabularies tool that have used this class restriction. For example, such resources include the class restriction of another application profile.
Under the heading Attribute restrictions, you will see a list of the attribute restrictions included in the datamodel in alphabetical order according to the name of the attribute restriction.
Click the name of the attribute restriction on the list to display more specific information on the restriction concerned, such as:
- Name of the attribute restriction
- Icon indicating the status of the datamodel
- In use in this datamodel: A switch indicating whether this attribute inherited from the core vocabulary must exist in this class. If the option In use has been selected, the property is visible in technical schemes (such as JSON) and in the diagram of the datamodel and it is used in validating the class.
- Attribute restriction’s identifier: An identifier that individualises this resource in the Data Vocabularies tool
- Long identifier i.e. IRI address of the attribute restriction: uniquely identifies the attribute restriction on the entire internet: The IRI address allows the attribute restriction to be referenced outside the Data Vocabularies tool, for example, in machine-readable interfaces. Click the Copy to clipboard button and the tool will copy the IRI address to your workstation's clipboard.
- Concept: a link to a concept in the Terminologies tool if linking has been carried out.
- Data type: Determines what kind of structure the values of the attribute restriction must comply with. For example, it may be required that the value must be an integer, string, URI, data, etc.
Properties or restrictions defining the attribute restriction in more detail:
- Minimum count indicates the minimum number of values (cardinality) for an attribute restriction. For example, 0 indicates that the value is optional, i.e. it is not necessarily required; 1 indicates that there must be at least one value
- Maximum count indicates the maximum number of values (cardinality) for an attribute restriction. For example, 1 indicates that only one value is permitted; * indicates that the number of permitted values is infinite.
- Code list is a link to a codelist in the Reference Data tool if a codelist providing the values for the restriction has been linked to this attribute restriction.
- More restrictions - a supplementing view (expander) - click the chevron symbol pointing down and the tool will open a list of other properties of an attribute restriction.
The More restrictions view includes:
- Allowed values: A list of values permitted for a property. For example: blue, white, green.
- Default value: Information that becomes the value of the property if it is not given in an actual input.
- Required value: A value that the property must always have. This value must also exist in data.
- Minimum length: Minimum length of the attribute value.
- Maximum length: Maximum length of the attribute value.
- Larger or as large as: The value of the attribute restriction must be greater or equal to the value given here.
- Smaller or as small as: The value of the attribute restriction must be less or equal to the value given here.
- Larger than: The value of the attribute restriction must be greater than the value given here.
- Smaller than: The value of the attribute restriction must be less than the value given here.
- String attribute format: The structure that a string attribute restriction must conform to. For example, the value of email must include the ""@"” character or a personal identity code must include a specific number of numbers and the permitted punctuation mark.
- String attribute languages: A string attribute restriction can be presented only in the languages mentioned here.
The other information on an attribute restriction are:
- Attribute’s note: A description of the content or properties of a resource, that a user of the resource needs to know. For example, its intended purpose or other information not evident from the concept description (link to the terminology).
- Open the References drop-down menu to see the resources that have used this attribute restriction.
- Created: Date and time of creating the attribute restriction.
- Last modified at: Date and time when the information on the attribute restriction was last changed.
- Work group comment: Comments and instructions for other persons editing the attribute restriction of the class. The content of this field is not visible to persons outside the same organisation.
- Contributors: One or more organisations owning and maintaining the data in the Data Vocabularies tool.
If you want to give feedback on the definitions of an attribute restriction to the contributor, click the Give feedback on an attribute link. The Data Vocabularies tool will open your email with the contributor’s email address already in the message recipient field.
Additional functionalities for a data model editor
More functionalities are visible to an editor who is logged in the Data Vocabularies tool, i.e. to a data model editor.
If you have the data model editor’s rights for the tool, you will see the Actions menu in your organisation's datamodels and edit functions in the menu. You can add an attribute restriction or edit the selected attribute restriction or its identifier. You can also remove the attribute restriction.
Click the Add attribute restriction button when you want to add an attribute restriction to the application profile. A modal will then be displayed in which you can select, search for or create the desired attribute restriction.
Please note that attribute restrictions are first created at the level of the entire datamodel, which means they are in common use. Once created, the attribute restriction can be linked to one or more class restrictions.
- In other words, the attribute restriction is created only once, and a reference to this shared attribute restriction is then simply added to each class restriction concerned. For example, the very common attribute restriction “identifier” does therefore not need to be created separately for each class restriction requiring it. Instead, each of them refers to the general attribute restriction.
- If the attribute restriction is no longer needed in the class restriction, the reference to it is removed from the class restriction (use the Remove reference function). In this case, the attribute restriction itself is not removed from the entire datamodel, so the references in other class restrictions remain unchanged.
- Note also that if you edit a commonly used/shared attribute restriction (for example, change its name), the changes will appear in all classes that reference that attribute restriction.
- An attribute restriction can be removed from a datamodel only when it is no longer referred to from any class restriction. To remove an attribute restriction, go to the description page of the attribute restriction and select Remove from the Actions menu.
Adding a new attribute restriction to a datamodel
- If you already know the name of the desired attribute restriction, you can retrieve it directly through the search field. Enter the name of the attribute in the search field.
- By default, the tool will search for attribute restrictions in the datamodels (namespaces) that you have added to your datamodel in the Links section.
To search from all datamodels in the Data Vocabularies tool, change the selected option in step 2 to All data vocabularies. If you find a suitable attribute in a new, previously unlinked datamodel and add it to your datamodel, the tool will automatically add it to the Links section of the namespace. If too many options are offered, go back by selecting the option Datamodels added to this model. Attributes only from a filtered set of datamodels will then be displayed again. - Filter the number of attributes by focusing the search only on the datamodels of a specific domain.
- Increase the number of available attributes by focusing the search on all datamodels – all statuses - or focus the search on statuses not in use, i.e. retired or superseded datamodels.
- Filter the number of attributes by focusing the search only on datamodels in a specific language.
- Browse the available attributes by scrolling the list. Select the desired attribute by clicking the radio button in front of it. Deselect it by clicking the radio button again.
- When you have selected an attribute, click the Create new attribute constraint button. The tool will display a new page on which you can enter more specific information on the attribute restriction. The tool automatically marks the selected attribute as the target of the new attribute restriction from which your attribute restriction inherits its data.
- Click Cancel to cancel the addition of the attribute restriction.
Also pay attention to the following:
- Add the desired name for the attribute restriction in all languages of the datamodel and give it an identifier. You can also link it to the desired concept in the Terminologies tool.
- Note that changes made to this shared attribute restriction of the datamodel are also reflected in all instances in this datamodel, i.e. in all class restrictions of the datamodel where this attribute restriction has been used.
- The tool automatically marks the attribute you selected earlier as the target of this new attribute restriction, i.e. as the attribute from which this attribute restriction inherits its data. If necessary, you can change the target attribute later.
- On the information page of the attribute restriction, you can still define its data type and provide other more detailed information, such as the minimum and maximum count of the attribute, i.e. the cardinality information.
- You can also link a codelist to an attribute restriction, i.e. link it to a codelist in the Reference Data tool.
- When you have added all the necessary information, click the Save button and the tool will add the attribute restriction to the datamodel. Alternatively, you can click Cancel to cancel the addition.
Linking an attribute restriction to a class restriction
Add an attribute restriction to the desired class restriction either from the description page of the class by clicking Add attribute restriction or through the visualisation. In both cases, the same insert view will be displayed.
In the visualisation, first select the desired class and then click the box with three dots in the top right corner. Then select the Add attribute restriction option.
You can either add a reference
- to an attribute in the core vocabulary or
- copy an attribute restriction from another application profile, which means copying its reference to the core data model attribute.
Option 1: Reference to an attribute in the core vocabulary
When the type of data model to be used is set to “Core Data Model,” the tool displays a list of available core data model attributes. Browse the list and select the desired attribute from the options provided by the tool by clicking the selection button (radio button) next to its name. Once an attribute is selected, the Create New Attribute Constraint button becomes active. Click it, and the tool will add a new attribute constraint to the class, i.e., a reference to the core data model attribute. Fill in the additional information required for the attribute restriction and click Save.
If the desired attribute is not on the list, try changing the selected option under Datamodel (see section 2 above) to All Data Vocabularies to get more options.
Click Cancel if you want to cancel the addition.
Option 2: Copying a reference from another application profile
Change the Data Model type to (application) Profile to search for references to core data model attributes in other application profiles. If you find a suitable attribute restriction, you can copy its corresponding reference into your own data model.
The tool displays a list of available attribute constraints from application profiles. Browse the list and select the desired attribute restriction from the options provided by the tool by clicking the selection button (radio button) next to its name. Once an attribute is selected, the Add attribute restriction button becomes active. Click it, and the tool will add a new reference to the attribute in the class. Fill in the additional information required for the attribute restriction and click Save.
If the desired attribute restriction is not on the list, try changing the selected option under Datamodel (see section 2 above) to All data vocabularies to get more options.
Click Cancel if you want to cancel the addition.
The tool adds the desired reference to the attribute restriction to the class restriction. The added reference to the attribute restriction also appears in the visualisation.
All references to attribute restrictions contained in a class restriction are listed in the information view on the class restriction.
- If you want to edit the information on an attribute restriction under a class restriction, open the information by first clicking the chevron symbol pointing downwards.
- Then click the Actions button and select Edit.
- Change the desired information and click Save, or click Cancel to undo the edits.
If you no longer need a reference to a specific attribute restriction in a class restriction, select the Remove reference option and then click Remove to confirm the removal.
Removing a reference to an attribute restriction from a class restriction does not delete the attribute restriction itself - it remains in the data model’s list of all attribute restrictions. To completely remove an attribute restriction from the application profile, first delete all references to it from class restrictions, then remove the attribute restriction.
Under the heading Association restrictions, you will see a list of the association restrictions included in the datamodel in alphabetical order according to the name of the association restriction.
Click the name of the association restriction on the list to display more specific information on the restriction concerned, such as:
- Name of the association restriction
- Icon indicating the status of the datamodel
- In use in this datamodel: A switch indicating whether this association inherited from the core vocabulary must exist in this class. If the option In use has been selected, the property is visible in technical schemes (such as JSON) and in the diagram of the datamodel and it is used in validating the class.
- Association restriction’s identifier An identifier that individualises this resource in the Data Vocabularies tool
- Long identifier i.e. IRI address of the association restriction: uniquely identifies the association restriction on the entire internet: The IRI address allows the association restriction to be referenced outside the Data Vocabularies tool, for example, in machine-readable interfaces. Click the Copy to clipboard button and the tool will copy the IRI address to your workstation's clipboard.
- Concept: a link to a concept in the Terminologies tool if linking has been carried out.
- Target association: An association of the core vocabulary, used as the basis for the description of this association restriction.
- Association (restriction) targets class: A class loosely related to this association restriction. This linkage to a class does not affect filters in the same way as association references included in the class. It is mainly an informative detail about the connection between these two classes.
- Minimum count: Indicates the minimum number of values (cardinality) for a property. For example 0 when the value is optional, i.e. it is not necessarily required; 1 when there must be at least one value; the value may be an integer.
- Maximum count: Indicates the maximum number of values (cardinality) for a property. For example, 1 when there can be only one value; the value may be an integer. If no maximum number is provided, the tool interprets it to be infinite and displays a star * in the visualisation.
- Association restriction's note: A description of the resource’s content or characteristics that users need to know, such as its intended purpose or other details not revealed by the definition of the terminology concept linked to the association restriction.
- Open the References drop-down menu to see the other resources that have used this association restriction.
- Created: Date and time of creating the association restriction. Members of the same organisation can also see who has created the association.
- Last modified at: Date and time when the information on the association restriction was last changed.
- Work group comment: Comments and instructions for other persons editing the association restriction. The content of this field is not visible to persons outside the same organisation.
- Contributors: One or more organisations owning and maintaining the data in the Data Vocabularies tool.
If you want to give feedback on the definitions of the association restriction to the contributor, click the link Give feedback on the association. The Data Vocabularies tool will open your email with the contributor’s email address already in the message recipient field.
Additional functionalities for a data model editor
More functionalities are visible to an editor who is logged in the Data Vocabularies tool, i.e. to a data model editor.
If you have the data model editor’s rights for the tool, you will see the Actions menu in your organisation's datamodels and edit functions in the menu. You can edit the selected association restriction or modify its identifier. You can also remove an association restriction.
Click the Add association restriction button when you want to add an association restriction to the application profile. A modal will then be displayed, in which you can select, search for or create the desired association restriction.
Please note that association restrictions are first created at the level of the entire datamodel, which means they are in common use. Once created, the association restriction can be linked to one or more class restrictions.
- In other words, the association restriction is created only once, and a reference to this shared association restriction is then simply added to each class restriction concerned. For example, the very common association restriction “related to” does therefore not need to be created separately for each class restriction requiring it. Instead, each of them refers to the general association restriction.
- If the association restriction is no longer needed in the class restriction, the reference to it is removed from the class restriction (use the Remove reference function). In this case, the association restriction itself is not removed from the entire datamodel, the references in other class restrictions remain unchanged.
- Also note that if you edit a commonly used/shared association restriction, (for example, change its name), the changes will appear in all classes that reference that association restriction.
- An association restriction can be removed from a datamodel only when it is no longer referred to from any class restriction. To remove the association restriction, go to the description page of the association restriction and select Remove from the Actions menu.
Adding a new association restriction to a datamodel
- If you already know the name of the desired association, you can retrieve it directly through the search field. Enter the name of the association in the search field.
- By default, the tool will search for associations in the datamodels (namespaces) that you have added to your datamodel in the Links section.
To search from all datamodels in the Data Vocabularies tool, change the selected option in step 2 to All data vocabularies. If you find a suitable association in a new, previously unlinked datamodel and add it to your datamodel, the tool will automatically add it to the Links section of the namespace. If too many options are offered, go back by selecting the option Datamodels added to this model. Associations only from a filtered set of datamodels will then be displayed again. - Filter the number of associations by focusing the search only on the datamodels of a specific domain.
- Increase the number of available associations by focusing the search on all datamodels – all statuses - or focus the search on statuses not in use, i.e. retired or superseded datamodels.
- Filter the number of associations by focusing the search only on datamodels in a specific language.
- Browse the available associations by scrolling up and down the list.
Select the desired association by clicking the radiobutton in front of it. Deselect it by clicking the radio button again. - Click the Create new association constraint button to display a new page, on which you can then enter the details of the new association restriction.
- Click Cancel to cancel the addition of the association restriction.
Also pay attention to the following:
- Add the desired name for the association restriction in all languages of the datamodel and give it an identifier. You can also link it to the desired concept in the Terminologies tool.
- Note that changes made to a shared association restriction of the datamodel are also reflected in all instances in this datamodel, i.e. all class restrictions in which this association restriction has been used.
- The tool automatically marks the association you selected earlier as the target of this new association restriction, i.e. as the association from which this association restriction inherits its data. If necessary, you can change the target association later.
- When you have added all the necessary information, click the Save button and the tool will add the association restriction to the datamodel. Alternatively, you can click Cancel to cancel the addition.
Linking an association restriction to a class restriction
Add an association restriction to the desired class restriction either from the description page of the class restriction by clicking Add association restriction or through the visualisation. In both cases, the same insert view will be displayed.
In the visualisation, first select the desired class restriction and then click the box with three dots in the top right corner. Then select the option Add association restriction.
You can either add a reference
- to an association in the core vocabulary or
- copy an association restriction from another application profile, which means copying its reference to the core data model association.
Option 1: Reference to an association in the core vocabulary
When the type of data model to be used is set to “Core Data Model,” the tool displays a list of available core data model associations. Browse the list and select the desired association from the options provided by the tool by clicking the selection button (radio button) next to its name. Once an association is selected, the Create new association constraint button becomes active. Click it, and the tool will add a new association constraint to the class, i.e., a reference to the core data model attribute. Fill in the additional information required for the association restriction and click Save.
If the desired association is not on the list, try changing the selected option under Datamodel (see step 2 above) to All data Vocabularies to get more options.
Click Cancel if you want to cancel the addition.
Option 2: Copying a reference from another application profile
Change the Data Model type to (application) Profile to search for references to core data model associations in other application profiles. If you find a suitable association restriction, you can copy its corresponding reference into your own data model.
The tool shows a list of available association restrictions of application profiles. Browse through the list and select the desired association restriction from the options provided by the tool by clicking the radio button next to its name. When you have selected an association restriction, the Add association restriction button becomes active. Click it, and the tool will add this new reference to the association in the class. Fill in the additional information required for the association restriction and then click Save.
If the desired association restriction is not on the list, try changing the selected option under Datamodel (see step 2 above) to All data vocabularies to get more options.
Click Cancel if you want to cancel the addition.
The tool adds the desired reference to the association restriction to the class restriction. The added reference to the association restriction also appears in the visualisation.
All references to association restrictions contained in a class restriction are listed in the information on the class restriction.
- If you want to edit the information on an association restriction under a class restriction, open the information by first clicking the chevron symbol pointing downwards.
- Then click the Actions button and select Edit.
- Change the desired information and click Save or click Cancel to undo the edits.
If you no longer need a reference to a specific association restriction in the class restriction, click Actions, and then select the option Remove reference option.
Removing a reference to an association restriction from a class restriction does not delete the association restriction itself - it remains in the data model’s list of all association restrictions. To completely remove an association restriction from the application profile, first delete all references to it from class restrictions, then delete the association restriction itself.
The basic information on the datamodel is provided in the Description field in the Details tab. On the Documentation tab, you can enter longer description texts and provide other supplementary documentation.
The Documentation view contains a text field with extensive descriptions and additional information on the datamodel.
If you have the editing rights, you can see the Edit button. Click the button to edit the text.
In practice, the field uses a Markdown editor that allows you to format the text, such as adding headings, body text, bolding, links to images, and more. As you write and edit the text, the tool shows under the Preview heading how the text will look on the webpage after saving.
Once you have added the desired information, click the Save button and the text you have added will remain visible in the field.
Technical formats visible to everyone
From the Actions drop-down menu, select Show as file if you want the datamodel to be displayed on the website in the technical format you have selected.
Select Download as file if you want to save the datamodel to your workstation in the selected file format.
The technical formats of application profiles include JSON-LD, RDF, Turtle, OpenAPI and JSON Schema.
Additional functionality for a logged-in user: email notifications
When you log into the Data Vocabularies tool, you will also be able to see a function on the Actions menu, which enables you to subscribe to a notification for when a new version of the datamodel is released.
If you have already subscribed to notifications, you will see an option that enables you to unsubscribe.
Additional functionalities for data model editors and main users
In addition to the above-mentioned functionalities visible to everyone, a couple of other additional functionalities are available to data model editors and main users in the Actions menu.
Function | Data model editor has the right | Main user has the right | Description |
|---|---|---|---|
Edit | Yes | Yes | The datamodel tool goes into edit mode and you can make changes to data model. In a published datamodel, i.e. a datamodel in Suggested or Valid status, you can edit only the metadata of the datamodel, such as the status or the content contributor of the datamodel, but not its actual content. |
Go to draft version | Yes | Yes | In a published datamodel, you can use the function Go to draft version function to move directly to the working version. In other words, this functionality is a shortcut to the original datamodel in Draft status. |
Create release of data model | Yes | Yes | In a datamodel in Draft status, you will see a functionality that you can use to publish your datamodel either as suggested or valid. |
Create copy | Yes | Yes | You can create a copy of the datamodel, which will contain the same resources as the original datamodel. The tool prompts you to enter a new ID for the copy. The copy does not receive the version information of the original datamodel and does not have connexion to the original datamodel. This means that if you later change the original datamodel, the copied datamodel will not change. |
Create new draft | No | Yes | If a datamodel in Draft status is for some reason no longer considered usable, it can be replaced with one of the earlier versions of the datamodel. In order to make a new version of a published version, the original draft must first be deleted. The new draft will have the same identifier as the draft that it replaces. |
Remove | No | Yes | As a main user, you can delete the datamodel if it is in Draft status, or if it is in Suggested status and there are no references to it. If the datamodel is in status Valid, it can no longer be deleted. |
Show as file | Yes | Yes | The datamodel is displayed on the www page in the technical format chosen by you. |
Download as file | Yes | Yes | The datamodel is saved to your workstation in the file format chosen by you. |
Add email subscription | Yes | Yes | You can subscribe to an automatic email notification of when a new version of the datamodel is created. You can also cancel an earlier subscription to the email notification through here by clicking the Remove email subcriptions option. |
Click the chevron symbol if you want to hide the panel on the left so that only the datamodel as a diagram is visible on the page. Click the chevron again and the panel will reappear.
Information presented in the diagram
Below you will learn how to change the content (views) of the visualisation window of an application profile.
- Change the content language of the datamodel information and the visualisation from the Content in language drop-down menu in the upper right corner.
- The class restrictions of the application profile are displayed as blue in the diagram. If you select a class restriction from the diagram or from the left panel, class restrictions is highlighted in purple in the diagram.
- To enlarge, or zoom in the diagram, click the plus sign.
- To reduce the size of the diagram, or zoom out, click the minus sign.
- Spread the diagram over the entire window.
- Refresh the screen. (Refresh function)
- Align the desired class restriction to the centre of the view.
- Download the visualisation as an image file in PNG format to your workstation.
- Save the location of the class restrictions. Please note that the icon can be seen only by a user who is a data model editor in a contributor organisation, in other words, has the editing rights. Other users can move the position of the class restriction in the diagram, but this information will not be retained when the user exits the application.
- Click the chevron symbol to display the Diagram settings window, in which you can change the data visible in the diagram.
Use the switches in the Diagram settings menu to change the visibility of the following information:
- Show/hide attribute restrictions under classes
- Show/hide association restrictions under classes
- Highlight/hide association restrictions of classes: you can normally click only an individual association but this function is used to highlight all association lines originating from a specific class restriction.
Use the Show from resource option to change the diagram to show either the plain language name (e.g., requires) or the identifier of the resource, i.e. the technical, machine-readable name (e.g., fi-eauth:requires).
Additional functionalities for a data model editor
More functionalities are visible to an editor who is logged in the Data Vocabularies tool, i.e. to a data model editor.
Add an attribute or association restriction to the datamodel by clicking the square with three dots in the title bar of the class.
A window will then be displayed in which you can select the desired attribute or association restriction.
Adding bends to association and hierarchy arrows
If the lines representing an association between different classes overlap or cross badly, first try moving the classes (boxes) to a more suitable location in the diagram. This is not always possible, so add bends to the lines that indicate an association or hierarchic relationship in the diagram, if necessary.
- First, move the mouse, or cursor, over the association line (or the dashed line of the superordinate class) and select the line with a mouse click. The line is highlighted when hove over it. The tool also highlights the association of the initial class.
- The mouse cursor initially appears as an open hand. Move the mouse and right-click when the cursor changes to a hand pointing with the index finger at the line; the tool will then add a bend at that point.
- The bend you added will appear as a dot on the association line. Add as many bends as you want. Drag the dot to the desired position in the diagram. During dragging, the mouse cursor will appear as a closed fist.
- To remove an unnecessary bend, first click the dot. A cross associated with the dot will appear in the diagram. Move the cursor over the cross, and when the cursor changes to a hand pointing with the index finger, click the cross to remove the dot.