Defining custom categories and attributes for dictionary entries

You can define attributes for dictionary entries,just as you can define them for diagrams. You can also define custom dictionary categories.

To manage custom dictionary categories and attributes, click Setup, then Define notations/attributes in the top drop-down menu of the Signavio Explorer.

Define notations/attributes

Define notations/attributes

Click Dictionary on the top bar of the dialog:

../../_images/dictionarytab_en.png

The following dialog opens:

To configure dictionary settings, switch to the tab 'Dictionary'.

To configure dictionary settings, switch to the tab ‘Dictionary’.

Managing dictionary categories

Hint

Please consider the section Dictionary Access Rights to learn more about this topic.

To create a new dictionary category, proceed as follows:

  • If you want to create a sub-category, select the desired parent in the Dictionary tab of the Define notations/attributes menu:

    Select a parent category.

    Select a parent category.

  • Click Add category. Now you can insert the category’s name and select its color. Additionally, you can change the parent category the category is assigned to:

    Add a name.

    Add a name.

  • In case you want to use the category for DMN input data (see:

    Managing input/output data for DMN diagrams in the dictionary), activate the check box Use for data modeling:

    Use the category to model DMN input data.

    Use the category to model DMN input data.

  • The Publishing Mode determines whether (new revisions of) dictionary entries should be published in the Collaboration Hub manually or automatically upon creation. When the publishing mode is set to manually, an updated dictionary entry has to be explicitly published before the most recent version is displayed in the Collaboration Hub. This enables strict quality assurance. When the mode is set to automatically, a new dictionary entry (update) is displayed in the Collaboration Hub as soon as the entry is saved.

    Configure the publishing mode.

    Configure the publishing mode.

    Important

    After enabling manual publishing, you need to explicitly grant users the right to publish dictionary entries, as described at Managing access rights.

    If a dictionary category’s publishing mode is set to manually and an entry has been altered without being republished, the following warning will appear when the dictionary entry is used in the Editor:

    If changes to a dictionary entry have not been published, this warning will be displayed when you open a diagram that contains the entry.

    If changes to a dictionary entry have not been published, this warning will be displayed when you open a diagram that contains the entry.

    The following property - On change, linking diagrams are - defines whether diagrams referencing dictionary entries of the corresponding category should be updated upon changes or whether they should be unpublished, so the changes can be approved manually. Again, configuring an automatic update enables the ad-hoc display of changes in the Collaboration Hub, whereas configuring Signavio to unpublish updated diagrams enables you to control whether the updated dictionary entry is still matching the context of the referencing diagrams:

    ../../_images/autoupdate_en.png
  • Now, select the category type:

    Select a category type.

    Select a category type.

    Category types have two purposes:

    • They are used by the system when creating reports (e.g. RACI, document usage or process documentation reports) in order to identify objects of a certain category.
    • They act as filters when dictionary references are suggested while modeling in the Signavio Editor. for example, dictionary entries of the type ‘IT System’ are only suggested when the user attempts to label an IT System element. Entries that are not defined (not attached to any element type) will be suggested for any element.

    Category types can be defined for both root level categories and child categories.

    Available category types are:

    • Organization: Organizational entities, that can be used to assign responsibilities for actions. Examples would be whole organizations (e.g. ‘ACME Inc.’), organizational units or departments (e.g. ‘Finance’), roles (e.g. ‘Chief Financial Officer’) or even external process participants like partners, suppliers, government institutions or customers.
    • Document: Anything that can hold information and that is used or created during processes. This may be physical documents (e.g. printed applications), digital files (e.g. PDF forms), entries in databases or variables in a computer program.
    • IT-System: Anything that can process documents or data, from standard software programs, individualized applications and custom scripts to hardware systems, like individual server instances, data centers and hand-held devices, to integrated systems like fully-configured application servers, scanners, printers or personal computers.
    • Event Anything that can trigger a process, happen during execution or as the result of a process. Events are usually described by defining the situation or state reached once the event has occurred, e.g. “Customer order received” or “Goods sent”.
    • Activity Actions that are performed within processes. Actions usually connect all other types of objects: they are performed by organizational units or roles, may read and create documents or data, may use IT-systems, may cause events and should usually achieve certain goals.
    • Goal The reasons behind why processes are executed at all and why they are designed the way they are: business goals to be achieved, key performance indicators to be met or stakeholders to be satisfied.
    • Requirement Typically descriptions of the differences between as-is and to-be processes or IT-systems, e.g. change requests, functional or non-functional specifications or tickets in a requirements management system.
    • Others Categories with this type have no defined meaning attached to them and will thus be recommended to users for diagram elements that do not match more specific types. One example is the BPMN group element.
  • Finally, click Create:

    Create the category 'Location' of the type 'Organization' as a sub category of the category 'Organizational Units'.

Create the category ‘Location’ of the type ‘Organization’ as a sub category of the category ‘Organizational Units’.

Please note that sub-categories can’t be parent category of other categories - so a category path is always one or two levels deep.

To edit, remove or rearrange categories, click the corresponding icon in the categories tab toolbar:

Remove a category.

Remove a category.

To deactivate a custom category, uncheck the respective checkbox between the category’s color and it’s name:

Deactivate a category

Deactivate a category.

Managing custom attributes for dictionary entries

You can manage custom attributes of dictionary categories in the same way you manage custom attributes of elements read more at Defining custom attributes.