Skip to end of metadata
Go to start of metadata

Document definitions with property fields are created in a Connection model.  Each model package for which you want to have self-defined information available for its sites, needs to have a Connection model with one or more document definitions.

Required roles

Designer or Lead Designer

Steps:

  1. Open the model package from the Team Server to which you want to add document definitions, and add a Connection model.

    If you create a new model package, make sure to save the model package on the Team Server before you start adding a document definition, otherwise the connection with the document store cannot be made.

  2. Right-click the Connection model, and select New > Document definitions. A new document definitions view is added to the model.

     

  3. Click the document definitions view to open it, and add a document definition to the view.

     

  4. Select the document definition, click  to open its properties window, and on the Properties tab, in Label, enter the name of the document definition as it should be shown in the title of the section with self-defined information in the object's properties panel in HoriZZon.

     

    Make sure the label name is unique, otherwise other document definitions with the same label name can be overwritten when uploading this definition to the document store. If your label name would turn out to be not unique when uploading the definition (because there already is a definition with the same label name in the document store), you have the possibility to upload it as a new version of the definition.

  5. Optional. Name and Namespace together identify the document definition in the document store. It must be a unique combination within the document store. Their values are implicitly set. Determine whether you want to explicitly set their names or not.

    If Name is implicitly set, each time you are going to change the definition's label, Name will automatically change with it. When uploading the definition with these changes to the document store, the existing definition in the store is NOT updated. Instead a new copy of the definition is created. If Name is explicitly set (name must differ from the label), it will not automatically change when renaming the label. When uploading the definition with label changes, the existing definition will be updated.

    Namespace is initially set to "default". It can be explicitly set for grouping definitions, or when explicitly needed for identification in the document store.

     

    If after setting the name or namespace an error message appears saying that you are not licensed to perform this action, it means that the model package you are working on is not stored on the Team Server. You first need to save it on the Team Server before you can proceed.

  6. Set one or more object types for the document definition. The self-defined information will be available for objects of this type. Either drag an existing object from the model browser onto the document definition, or enter the name of the object type name on the Types tab of the definition's properties window. To do this, first type the metamodel name followed by a colon and the name of the object type. Use the type id or name, or the translated name of the object type. Example:

    ArchiMate:ApplicationComponent , or  ArchiMate:Application component

     

    If after setting an object type an error message appears saying that you are not licensed to perform this action, it means that the model package you are working on is not stored on the Team Server. You first need to save it on the Team Server before you can proceed.

  7. By default two property fields have been added to the document definition. If you need additional fields, click  at the right top of the definition to add more. If you need only one field, remove one from the definition by selecting the field and clicking .

     

  8. Specify each field.

    1. Select a field, click  to open its properties window, and in Label, enter the name for the field as it should be shown in HoriZZon. The name must be unique within the document definition.



    2. Optional: Label and Name together identify the property field in the document definition. Name is automatically filled based on the label you entered. You can rename it but it has to be unique within the definition.

    3. In Field type, select the data type for the field.

      If you select "money", then also select the desired currency in Currency

      If you select "enumeration", then also do the following:

      In Field type name , enter a name for the enumeration list. This name is for possible reuse of the list in other fields within the document definition.

      If you want to reuse an enumeration list that has already been defined before for another field in the document definition, then enter the name of that enumeration list, and do not add literals.


      In Literals , add the labels and names for the list options users can choose from when editing the field in HoriZZon. The labels are the names of the options as presented to the user. Name values are automatically derived from the labels, but they can be renamed. The names can be used for condition expressions in scripts, if desired.

       

  9. When you are ready defining the fields of the document definition, open the definition properties window, and click Upload on the Document store tab to upload the document definition to the document store.


The fields from the document definition are now available for editing in HoriZZon.


Updating a document definition

Document definitions can be changed and updated any time. 

Take not that if the tabel with document definitions in the document store is open while making changes to a document definition and uploading it, the table will not automatically be updated. You need to close the table and reopen it in order to see the changes in the document store.