This file defines the general mapping for models, connections, and assignments. It handles the data transfer between ARIS and Alfabet using Alfabet RESTful API v2. Generally, Alfabet objects are mapped to ARIS objects. Alfabet object classes are mapped using the class name xml property. The import of all or single objects of an Alfabet object class is performed using the following import definition.
In contrast to Alfabet RESTful API v1 where both configuration files are required, Alfabet RESTful API v2 uses only the ARIS-ALFABET- mappingV2.xml file and related Alfabet reports. This file contains only the Alfabet object classes and properties that were used for the import. The file also contains mapping information and mapping usage for single-object mapping or bulk mapping.
For the <mapping> root element, the version property is specified with the value 2.
In the ARIS-ALFABET- mappingV2.xml file, the <table> element is replaced by <class>. The class and property names are no longer the table and table column names but the Alfabet object class and property name. The <psutable> and <psmtable> elements are also replaced by <class>. For PSU/PSM import, you must specify the attribute import-target="psu" or import-target="psm".
Creates an overview model of the specified type and places an occurrence of each class object that meets this condition in the model.
aristype
ARIS API name of the ARIS object type to be used. If an ARIS symbol type is specified here, the object type is derived from the symbol. In addition, the default symbol of the imported item is set to this symbol type.
isgroup
If true, creates a group for each imported object.
arisgroupname
Name of the ARIS database group.
If specified and not empty, an ARIS database group with the specified value is created for the import of the class. All imported objects are stored in this group.
If arisgroupname is empty or not specified, no subgroup will be created.
report
Alfabet report to request objects with the required and mapped data.
The specified report reduces the amount of data transferred from Alfabet to ARIS. The report defines a set of used properties and enables access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as lifecycle attributes of Application system type. If a referenced report is not available in Alfabet, the import log reports this issue. In this case, the import tries to fall back to the default import without using the report.
You can import demo reports into Alfabet, which are available on the ARIS DVD \Content\Reports.
import
Specifies the kind of import for each <class>.
Set either single-object import or bulk import/synchronization. Possible values are object, bulk, or both.
name
Alfabet object class name, for example, Application.
Creates an overview model of the specified type and places an occurrence of each class object that meets this condition in the model.
aristype
ARIS API name of the ARIS object type to be used. If an ARIS symbol type is specified here, the object type is derived from the symbol. In addition, the default symbol of the imported item is set to this symbol type.
arisgroupname
Optionally overwrites the default group name of the class element for items meeting this condition.
value
Property value specifying that this condition is to be applied.
condition
Defines a conditional mapping based on a property's value. The example above shows a mapping that is based on the Stereotype property. If the value is specified and corresponds to one of the values listed as a value in the condition elements below, it is mapped according to what the condition element defines, and NOT according to what the class element defines.
Specifies whether or not the import forces the target/source object of a referenced object to exist in the database. If the value is set to true, the target/source object will be created using the mapping definition of the referenced object. Only if the target/source object exists will a connection be imported. Whether the target object or the source object must exist depends on the value specified in the srctotarge xml property
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.
Not used if the referenced element is the model itself.
parent-symbol
API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.
Required only if the add-parent attribute is set to true.
add-parent
Adds an occurrence of the superior object to the assigned model.
The default setting is false.
If you change it to true, an occurrence of the superior object will be added to the assigned model. Therefore, the parent-symbol attribute is mandatory.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
type
Creates one assigned model per imported object. Cannot be used as class subordinate element.
assign
Creates an assignment to a model either in addition to a connection, instead of a connection, or to a model if the referenced item is a model derived from an additional Alfabet object class.
Non-localized default text for the link's title text.
This text is displayed for all languages that are not explicitly specified in the title locale xml property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS-Alfabet synchronization report.
title
API name for the attribute type of the ARIS link title attribute to be used. By default, the Alfabet Navigation 1 attribute type will be used for storing the link's title text.
This text is entered in the defaultvalue xml property. It is displayed for all languages that are not explicitly specified in the title locale xml property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS - Alfabet synchronization report.
attribute
API name for the attribute type of the ARIS link attribute to be used for navigating to the Alfabet object. By default, the Alfabet Link 1 (AT_ALFA_LINK_1) attribute type will be used for saving the URL to the Alfabet object.
link
Creates ARIS link attributes as a reference between ARIS and Alfabet.
<title locale="1033" value="Navigate to Application in Alfabet" />
value
Localized title text.
locale
Locale ID (LCID) of the language in which the link title is transferred.
By default, the data is transferred in English (1033). If you have logged into the ARIS database in another language, for example, German, the values are written to the German attributes in English.
</link>
<!-- Configuration of dialog for single-object mapping -->
Defines columns and content to be displayed in the Select Alfabet object dialog.
In this example Version is the property name to be used as column title. All values of this property will be displayed in this column. Version refers to the attr subordinate element of the Application Alfabet object class, which is listed in the configuration file. You can use all other properties mapped via the attr subordinate element.
The value represents the static part of the link. The link will be assembled using this and the User interface URL value that you have specified when you connected the ARIS database to the Alfabet system.
Checks for the existence of the provided Alfabet attribute, and searches the ARIS database for an object with this GUID. If available, the ARIS object is identified and used as the master instead of the Alfabet object, for example,
check-master="ARIS_GUID"
The attributes and properties of the master object are not overwritten by the import and a master is not removed if theobject has been deleted in Alfabet.
linkarisonly
Affects items sourced from ARIS. These Alfabet objects have an ARIS GUID.
The default value is false.
If the value is true, links are created for ARIS items that still exist in the ARIS database, but neither items nor attributes are imported. The check-master table attribute is mandatory.
<link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Domain in Alfabet">
<title locale="1033" value="Navigate to Domain in Alfabet"/>