Skip to end of metadata
Go to start of metadata

By default, model elements have one documentation field available. The tab can be used for documenting the element or linking to other documents or intranet sites. It is possible to add additional documentation fields with their own specific tab names and in which you can define your own specific information.

To create a custom documentation field, follow the steps below. To illustrate the procedure, the following example is used:

Example

You want to be able to register call information about the business actors in your ArchiMate® models in a separate documentation field. To realize this, a profile is created for the business actor concept, including an attribute to name the documentation field "Call info".

The result of the profile created following the example would be a documentation field "Call info" that is available to business actor objects:


Steps:

  1. In the Create pane, click the Profile element , click in the Custom Profile Definition view, and type the name for the profile.

    This name is the profile's identifier, its internal name for Enterprise Studio. It can only contain letters, digits, and underscores. Spaces are not allowed.



  2. A documentation field profile is always an extension of the documentation template profile. Set the extension.

    1. Select the profile and click  to open the profile's properties window.



    2. In the Profile properties window, click in the extends box.

    3. In the Select element window, select the DocumentationTemplate profile.

      To quickly find the profile, type its name in the search box, and press Enter or click .




  3. Set the profile's hidden property to true.

    The profile for a documentation field should always be hidden, otherwise, it will appear in an object's properties window.

  4. Specify the concept(s) from the metamodel for which the documentation field should be available.

    1. Click in the always assigned to box.

    2. In the Concepts window, double-click Concept , and select the concept. Repeat this for each concept you want to add.
    3. You can also assign the documentation field to viewpoint definitions to make the documentation field available in one or more diagrams or views. In that case select a viewpoint definition, except when the field must be assigned to a diagram. In that case select the scheme representing the diagram in the Concepts folder.




  5. Close the profile properties window.

  6. Add an attribute to the profile to specify the name for the documentation field.

    In the Create pane, click the Attribute element , select the profile in the view, and type the name for the attribute.

    This name is the internal name for Enterprise Studio. It can only contain letters, digits, and underscores. Spaces are not allowed.



  7. Optional: Add the documentation field name that must be presented to the user. If you do not add a name, the documentation field's identifier name will be shown to the user.

    1. Select the attribute and open its properties window.

    2. Click in the translation box, and type the name. This name can contain spaces.



  8. Specify the documentation field's data type. Click in the type box, and in Profile type window, select the rtf type.

  9. Close the attribute's properties window.


The documentation field is now ready and can be validated.


The order of the documentation fields is determined by Enterprise Studio. If you want them to be shown in alphabetical order, select the option Sort documentation fields in alphabetical order at the Enterprise Studio Options.


ArchiMate® is a registered trademark of The Open Group.