Skip to end of metadata
Go to start of metadata

Team Server is now called HoriZZon Server. While the new name is being implemented in the software and on BiZZdesign Support, the old name may still be visible in places until the process has been completed. For more information, please refer to Team Server is now HoriZZon Server .

Document definitions and documents are now called data block definitions and data blocksWhile the new name is being implemented in the software and on BiZZdesign Support, the old name may still be visible in places until the process has been completed.


Data block definitions form the basis for data blocks, sets of object (or relation) attributes in HoriZZon that can be used for model data enrichment and that can be edited by Contributor users. 

Data block definitions are created in a Connection model in a model package. The definitions only apply to that model package, and the associated data blocks in HoriZZon are only available in sites based on that model package. If you need data blocks in sites of different model packages, you will need to create data block definitions in each of these model packages.

Data block definitions can be defined for an object type of any metamodel. Once available in a HoriZZon site, the associated data blocks will be available on all objects of the specified type. It is possible to create multiple data block defnitions in one model package. A single data block definition can be created for multiple object types.

Created data block definitions are uploaded to the central data block store to make the associated data blocks available in HoriZZon.

Required roles

Designer or Lead Designer


On this page:


Creating a data block definition

  1. Open the model package from the HoriZZon Server to which you want to add data block definitions, and add a Connection model.

    In the model browser, right-click the model package, point to
    New > Connection model , and then click 1. Empty model with connection view. A new Connection model  containing a connection view and Connections container, appears in the model browser.

  1. If you create a new model package, make sure to save the model package on the HoriZZon Server before you start adding data block definitions, otherwise the connection with the data block store cannot be made and you will receive an error message.

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

      

  3. Click the data block definitions view to open it, and add a data block definition to the view using the Create pane or the quick-create pop-up window.



  4. Select the data block definition, click  to open its properties window, and on the Properties tab, set the following:

    1. In Label, enter the name of the data block as it should be presented in HoriZZon. It will be the data block title.



    2. The definition's Name and Namespace  together identify the data block definition. The combination Namespace+Name  must be  unique   across all data block stores on the server. Initially, both values are implicitly set, meaning that they have a default, however real, value. Determine whether you want or need to explicitly set them or not:

      If Name is implicitly set (value is derived from Label), each time you change Label, Name will automatically change with it. To add the label change to the data block store, the definition can only be uploaded as a new data block definition to the data block store.
      If Name is explicitly set (name must differ from the label), it will not automatically change when Label is changed. To add the label change to the data block store, the existing definition can be updated.

      If Namespace is implicitly set, its value is "default". It can be explicitly set for grouping data block definitions, or it may be needed for identification in the data block store to create a unique combination with Name. If Namespace is explicitly set, each time you change it, you need to upload a new copy of the definition to the data block store. You cannot update the existing definition.



      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 HoriZZon Server. You first need to save it on the HoriZZon Server before you can proceed.


  5. Define one or more object types for the data block definition. The data block will be available on all objects of this type. You can link the data block definition to object types of different metamodels. Only concrete concepts can be assigned, like an ArchiMate application component, BPMN task, or UML class. You cannot assign abstract concepts like "mm_object".

    To add an object type, either drag an existing object from the model browser onto the data block definition, or enter the object type name in Object types in the Types tab.
    To enter a name, 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 still not stored on the HoriZZon Server. You first need to save it on the HoriZZon Server before you can proceed.

  6. By default, two attribute fields are added when creating a new data block definition. Depending on what you need, you can add additional fields by clicking  at the right top of the definition, or remove a field if you don't need it by selecting the field and clicking . Specify each attribute field:

    1. Select a field, click  to open its properties window.

    2. In Label, enter the name of the attribute field as it should be presented in the data block in HoriZZon.

    3. The value of Name is automatically filled and derived from Label, but you may need to change it. Name identifies the attribute field and must be unique within the data block store. So there cannot be two attributes with the same name in the data block definitions within the data block store.



    4. In Field type, select the data type of the field. Depending on the type you choose, you may need to set additional properties.



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

      If you select "enumeration", then also enter values in Field type name and Literals:

      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 data block definition.

      If you want to reuse an enumeration list that has already been defined in another attribute field within the same definition, then enter the name of that enumeration list. The associated list options will automatically be added in Literals.

      In Literals, add the labels and names for the list options users can choose from when editing the data block 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. An example:

       

  7. When you are ready defining the attribute fields, open the definition properties window again, and click Upload in the Data block store tab to upload the new data block definition to the data block store.


The data block is now available for editing in HoriZZon sites that are based on the model package the data block is created in:


Updating data block definitions

Data block definitions can be changed and updated any time. Depending on the type of changes that you make, the existing data block definition can be updated, or a new copy of the definition needs to be uploaded.

Please t ake not that if the table with data block definitions is open while making changes to a data block definition and uploading it, the table will not automatically be updated. To see the data block definition changes in the table, you need to close the table and reopen it.

Sorting of data block definitions in HoriZZon

When multiple data block defnitions are defined for a single object type, the associated data blocks will be shown below each other in the properties panel of an object of that type. They are sorted alphabetically based on their Namespace+Name combination (in that order), not based on their label. Only explicitly setting the namespace for each definition would suffice to determine their order. Please take note that the implicitly set "default" Namespace value and default Name value will also be included when determining the order, although implicitly set, they are considered to be a value.  Example:

When using only the default namespace, the following data block definitions would be shown in the following order in HoriZZon:



To get the desired order "cost, quality, editor",  the namespace of the definitions has been as follows: