Skip to end of metadata
Go to start of metadata

The Rule Model (also sometimes referred to as the Rule Maker Model) is an arKItect model which describes the Model Gateway import / export rules between a particular target project and external data format. It is strongly linked with the Meta Model of the target arKItect project and the format of the external data.

At his highest level the Rule Model is composed of WorkBook objects which are themselves contain Sheet objects. This structure is directly derived from the Excel file with the WorkBooks corresponding to the Excel file and the Sheets to the file sheets.

Rule Model WorkBook

A WorkBook is a convenient way to group several sheets, it is also the object from which a Rule File is generated. It has description attribute where the user can add useful information.

In its context menu a WorkBook provides the following functions:

  • Create Rule File: generates a Rule File from the WorkBook
  • Init Matrix Sheet: create a Sheet object skeleton for matrix format import/export.
  • Init from Excel file: helper function which creates the Sheet objects from an existing Excel file (Sheet with columns corresponding to the content of the Excel file). The user still needs to edit the created Sheets (adding types and relations) before being able to generate a Rule File. This helps the user to quickly create the WorkBook skeleton from a sample Excel file.
  • Init from XSD file: generates the complete structure from an XSD file for XML import. This feature is experimental and is not supported at this moment.

Rule Model Sheet

The Sheet object contains the import/export rules for a single sheet of the external data. In the case of an Excel file it maps there is a direct mapping between Rule Model Sheets and Excel sheets (the actual mapping depends on the external data format).

Each Sheet object has the following attributes:

  • activation: flag determining if the sheet is used or not by the Model Gateway (a deactivated sheet will be ignored).
  • format: indicates general format of the external data, currently only two formats are supported:
    • standard format: data is presented in a tabular format with fixed columns
    • matrix format (Excel files only): the matrix format is similar to an Excel pivot table, it is a good way to present certain type of data (for example exchange rates between all world currencies), contrary to the standard format neither the number of columns or rows is fixed. Refer to Model Gateway Matrix Format for more information on this feature.

In a Sheet the rules are described by a composition of:

  • Column / VirtualColumn objects: they correspond to objects or attributes in the arKItect project and columns in Excel.
    They are explained in more details in the page Rule Model Column Objects
  • Relation flows between columns: they express the constrains of the rules, they can be constrain specific to the Model Gateway or correspond more directly to the type relation in thearKItect project type diagram.
    They are listed and explained in the page Rule Model Relations Between Columns
  • No labels