Add Information to Models & Objects#

The following sections provide an overview of functions for managing the attributes of models, objects and connectors.

The Notebook#

Models, objects and connectors have certain characteristics, which are called attributes. You can view and, if you have sufficient user rights, edit these attributes in the so-called Notebooks. In order to increase the clarity and user-friendliness, related attributes are aggregated in chapters in a Notebook.

 Notebook of a Model

Global Attribute Values vs. Model-Specific Attribute Values

In ADONIS NP the attributes of repository objects both have global values as well as model-specific values. A repository object that is used in a model after insertion contains the default values from the Object Catalogue. However, some of these values can be adapted specifically for the model without influencing the global values at all.

  • Global Values

    Properties that are identical in the Object Catalogue and in all models in which the object is used (e.g. name, description).

  • Model-Specific Values

    Properties that are specific to one object. Model-specific values that have not been specifically adapted in a model automatically use default values (e.g. colour, representation for some classes).

Open Notebook#

Depending on the attributes to be displayed, the corresponding Notebooks have to be opened from different locations.

Open Model Notebook

Every model has a set of attributes, the so-called model attributes. You can open the Notebook of a model from the graphical editor:

  • Click the Properties button in the menu bar of the model.

Alternatively, you can open the Notebook of a model from the Model Catalogue:

  • Select the model and press <Alt> + <Enter> or:

  • Right-click the model, point to Open, and then click Properties.

note

The Notebook of a model opens in a freely floating window.

Open Object Notebook

All object types, whose attributes shall be accessible, are equipped with a Notebook as well. You can open the Notebook of an object from the graphical editor or from the Object Catalogue. Choose one of the following options:

  • Double-click the object or:

  • Select the object and press <Enter> or:

  • Right-click the object, point to Open, and then click Properties.

Additionally, you can open the Notebook of an object from the textual view and from the tabular editor.

note

When opened in the graphical editor, the Notebook of an object opens in a freely floating window. When opened in the Object Catalogue, the Notebook of an object opens integrated into the main application window (docked).

note

When you open the Notebook in the graphical editor, the Notebook with the model-specific attribute values of the object is opened. When you open the Notebook of a re-usable object in the Object Catalogue however, the Notebook with the global attribute values of the object is opened.

note

These options also allow you to open the Notebook of a connector, if one was defined for it in the product configuration.

Edit Attributes#

Different types of models/objects/connectors have different types of attributes that can be maintained. For simple text attributes the new value can be entered directly into the Notebook or selected there. For complex attributes input support dialogues and other functions are available.

Switch between Read Mode and Edit Mode#

It is possible to switch between a read mode and an edit mode. Read mode allows for quick browsing of all attributes of a Notebook.

If you want to edit the attributes in a Notebook, you need to switch to edit mode first. In order to do so:

  • Click the Edit button in the menu bar of the open Notebook.

In order to switch back to read mode:

  • Click the Read button in the menu bar of the open Notebook.

Open Chapter#

Open a Notebook chapter to browse the attributes which are aggregated within. In order to show/hide a Notebook chapter:

  • Click the chapter name.

Show Attribute Information#

Each attribute has an info text that provides you with information about what this attribute is used for. In order to open the info text of an attribute:

  • Click the icon .

Manage Relations#

Manage relations between objects or between objects and models in the Notebooks of the objects/models.

Create New Object

In order to create a new object and reference it in an attribute:

  • Click the icon . A dialogue window opens.

  • Select a name, object type and target folder for the new object. Confirm with OK.

Add Relation

You can create relations easily by drag & drop without profound knowledge of the modelling language. Proceed as follows:

  • Drag the model or object you want to reference from the Explorer to the Notebook. ADONIS NP will show you which relations are possible and let you decide which one to create. You will jump directly to the selected attribute.

Alternatively, if you know exactly which relation you want to add:

  • Click the icon . A dialogue window opens.

  • Select the object(s) or model(s) you want to reference and confirm with OK.

note

When referencing a modelling object, the model in which the modelling object is maintained is visualised as well.

 Referencing a Modelling Object

Delete Relation

In order to delete a relation:

  • Select the relation, and then click the icon .

Delete Relation and Referenced Object

In order to delete a relation and simultaneously delete the referenced object from the database:

  • Select the relation, and then click the icon .
note

If you modify relations between objects, the modified connectors can be displayed in the graphical editor by clicking update all relations in the context menu.

Open Model or Object Notebook

  • A referenced model can be opened by clicking on it.

  • A click on a referenced object opens its Notebook.

Open Model Notebook

In order to open the Notebook of a referenced model:

  • Click the Properties icon .

Open Notebook of the Relation

In order to open the Notebook of the relation to a referenced model or object:

  • Click the Open properties of the relation... icon .

Format Text#

In order to format a text attribute (e. g. a description):

  • Click the Edit support window icon .

A support dialogue opens. You can edit text directly in the text field and format it using the different icons offered by the quick access bar.

note

You can copy formatted text from other applications into the text window. ADONIS NP recognizes the formatting and applies it to the text.

Check Change History#

Depending on the product configuration, changes to objects are tracked in a change history. You can access the change history through the Notebook of an object. In order to do so:

  • Click the More button in the menu bar of the open Notebook.

  • Select the menu entry Change history   from the drop-down menu.

note

Only repository objects have a change history.

note

If you are not able to view the change history, please ask your ADONIS NP administrator to activate the change history in the Administration Toolkit.

Object Ownership#

In ADONIS NP a user can be assigned ownership of a repository object (e.g. Applications, Processes etc.). In order to do so, the user is assigned as Responsible Person (object attribute in the Notebook chapter "Organisation").

The object owner is responsible for the content of the object. They will be granted write access to the object, even if they usually only have read access.

note

By default a user who creates an object is automatically assigned ownership.

Close Notebook#

In order to close a Notebook:

  • Press <Esc> or:

  • Click the icon .

  • The Notebook
  • Open Notebook
  • Edit Attributes
    • Switch between Read Mode and Edit Mode
    • Open Chapter
    • Show Attribute Information
    • Manage Relations
    • Format Text
  • Check Change History
  • Object Ownership
  • Close Notebook