Mapping syntax and examples
For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The first example shows how a class is mapped to an object definition and how (value) properties are mapped to ARIS attributes. Additionally, it is possible to create an overview model and place an occurrence of each object from this class into the model. A Reference or ReferenceArray property can be mapped to a connection, an assignment, or to a connection plus an assignment. Value properties can be mapped to a connection, an assignment, or to both at the same time. Value properties can be assigned to a created connection instead of being assigned to the object itself.
The second example shows the mapping to an object to with a model is assigned. Additionally, an object occurrence is created in the target model.
The configuration defines the general mapping for models, connections, and assignments. The configuration handles the data transfer between ARIS and Alfabet using Alfabet RESTful API version 2. 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 the non-secure Alfabet RESTful API version 1 (API version 1) where the Mapping definition and the Alfabet import configuration are required, Alfabet RESTful API version 2 (API version 2) uses only the Alfabet import configuration and related Alfabet reports. In contrast to API version 1 configuration, the Alfabet import configuration of API version 2 contains only the Alfabet object classes and properties that will actually be imported. The Alfabet import configuration 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 API version 2, 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 names. 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 ".
Alfabet import configuration
This Alfabet import configuration contains an import mapping based on the ARIS demo use case for Alfabet imports.
<mapping version="2">
<name="Application" import="both"> report="DataImportIntoARIS_Applications" arisgroupname="Applications" isgroup="true" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE" condition="Stereotype">
<!-- Conditions for filtering objects -->
<!-- (Note: For performance reasons filtering should normally
be done by the Alfabet report. This is just an example
that demonstrates how it can be applied on the ARIS side.
The example is restricted to object mapping by
setting import="object".) -->
<filter property="ObjectState" value="Active" import="object"/>
<!-- Conditions for classifying objects -->
<condition value="BOT" arisgroupname="BOTs" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE"/>
<condition value="SaaS Systems" arisgroupname="SaaS" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE"/>
<condition value="TradingPartner" arisgroupname="Trading Partners" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE"/
<!-- Attribute mappings -->
<attr alfabet="Name" aris="AT_NAME"/>
<attr alfabet="Version" aris="AT_REL_3"/>
<attr alfabet="Description" aris="AT_DESC"/>
<attr alfabet="ID" aris="AT_ID"/>
<attr alfabet="ObjectState" aris="AT_REM"/>
<attr alfabet="Evaluation_StartDate" aris="AT_EVALUATION_START"/>
<attr alfabet="Evaluation_EndDate" aris="AT_EVALUATION_END"/>
<attr alfabet="Pilot_StartDate" aris="AT_TO_BE_PHASED_IN_START"/>
<attr alfabet="Pilot_EndDate" aris="AT_TO_BE_PHASED_IN_END"/>
<attr alfabet="Production_StartDate" aris="AT_STANDARD_START"/>
<attr alfabet="Production_EndDate" aris="AT_STANDARD_END"/>
<attr alfabet="LimitedProduction_StartDate" aris="AT_LIMITED_STANDARD_START"/>
<attr alfabet="LimitedProduction_EndDate" aris="AT_LIMITED_STANDARD_END"/>
<attr alfabet="ShutDown_StartDate" aris="AT_TO_BE_PHASED_OUT_START"/>
<attr alfabet="ShutDown_EndDate" aris="AT_TO_BE_PHASED_OUT_END"/>
<!-- Connection mappings -->
<cxn property="NextVersion" cxntype="CT_IS_PRED_OF" srctotarget="true" forceexist="true">
<assign type="all" model="MT_APPL_SYST_TYPE_DGN" add-parent="true" parent-symbol="ST_APPL_SYS_TYPE" child-symbol="ST_APPL_SYST_TYPE"/>
</cxn>
<cxn property="Domain" cxntype="CT_CAN_SUPP_1" srctotarget="true" forceexist="true">
<assign type="all" model="MT_APPL_SYS_TYPE_DGM" add-parent="true" parent-symbol="ST_APPL_SYS_TYPE" child-symbol="ST_IS_FUNC" />
</cxn>
<!-- Link for navigation to Alfabet -->
<link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Application in Alfabet" >
<title locale="1033" value="Navigate to Application in Alfabet" />
</link>
<!-- Configuration of dialog for object mapping -->
<dialog-columns>
<column alfabet="Version"/>
<newlink url="ExternalAccess.aspx?AccessType=ExternalAccess&UserType=Named&View=GraphicView:APP_CaptureApplications_Ex"/>
</dialog-columns>
</class>
<name="ApplicationGroup" report="DataImportIntoARIS_ApplicationGroups" import="bulk" arisgroupname="Application groups" isgroup="true" aristype="OT_APPL_SYS_CLS" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_CLS">
<attr alfabet="Name" aris="AT_NAME"/>
<attr alfabet="Description" aris="AT_DESC"/>
<attr alfabet="ID" aris="AT_ID"/>
<cxn property="BelongsTo" cxntype="CT_CAN_SUBS_2" srctotarget="false" forceexist="true" make-parent-group="true">
<assign type="all" model="MT_APPL_SYS_TYPE_DGM" add-parent="true" parent-symbol="ST_APPL_SYS_CLS" child-symbol="ST_APPL_SYS_CLS"/>
</cxn>
<cxn property="Applications" cxntype="CT_BELONGS_TO_CLS" srctotarget="false" forceexist="true">
<assign type="all" model="MT_APPL_SYS_TYPE_DGM" add-parent="true" parent-symbol="ST_APPL_SYS_CLS" child-symbol="ST_APPL_SYS_TYPE"/>
</cxn>
</class>
<name="Domain" report="DataImportIntoARIS_Domains" import="bulk" linkarisonly="true" check-master="ARIS_GUID" aristype="OT_FUNC_CLUSTER">
<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"/>
</link>
</class>
<class name="ValueNode" report="DataImportIntoARIS_ValueNodes" import="bulk" linkarisonly="true" check-master="ARIS_GUID" aristype="OT_OBJECTIVE">
<link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Value Node in Alfabet">
<title locale="1033" value="Navigate to Value Node in Alfabet"/>
</link>
</class>
<class name="BusinessProcessModel" import="bulk" linkarisonly="true" check-master="ARIS_GUID" aristype="MT_VAL_ADD_CHN_DGM">
<link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Business Process Model in Alfabet">
<title locale="1033" value="Navigate to Business Process Model in Alfabet"/>
</link>
</class>
<class name="BusinessProcess" report="DataImportIntoARIS_BusinessProcesses" import="bulk" linkarisonly="true" check-master="ARIS_GUID" aristype="OT_FUNC">
<link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Business Process in Alfabet">
<title locale="1033" value="Navigate to Business Process in Alfabet"/>
</link>
</class>
<!--
====================================================================
Example: ValueArc
====================================================================
This example demonstrates how to import objects of the ValueArc class
from Alfabet. These objects represent relationships that connect
ValueNode objects. The latter are imported as well. The example is
stripped down to the bare minimum and does not bother with creating
overview models or object links to Alfabet.
-->
<!--
<class name="ValueNode" import="bulk" arisgroupname="Value Nodes" aristype="OT_OBJECTIVE" condition="Stereotype">
<condition value="Vision" arisgroupname="Visions" aristype="ST_VISION" />
<condition value="Goal" arisgroupname="Goals" aristype="ST_STRAT_OBJCTV" />
<condition value="Objective" arisgroupname="Objectives" aristype="ST_OBJCTV" />
<condition value="Initiative" arisgroupname="Initiatives" aristype="ST_INITIATIVE" />
<attr alfabet="Name" aris="AT_NAME" />
</class>
<class name="ValueArc" import="bulk" arisgroupname="Value Arcs" aristype="CT_BELONGS_TO_1" overview-model="MT_OBJ_DGM,ST_VISION,ST_OBJCTV">
<cxn property="Head" role="source" forceexist ="true"/>
<cxn property="Tail" role="target" forceexist ="true"/>
</class>
-->
<!--
====================================================================
Example: BPInformationFlow
====================================================================
This example demonstrates how to import objects of the
BPInformationFlow class. These objects represent relationships that
connect BusinessProcess and BPRule objects. The latter classes are
imported as well.
Please note that this example conflicts with the <class> entry for
BusinessProcess above which does not define an import but only creates
links to objects imported by Alfabet. (Note the linkarisonly="true"
setting.) If you want to use the BPInformationFlow example, you
should disable the <class> entry above.
This example is more elaborate as the ValueArc example above since it
shows how to deal with the different connection types that can occur
between the objects in ARIS. It also creates overview models and
links to the object representations in Alfabet.
-->
<!--
<class name="BusinessProcess" report="DataImportIntoARIS_BusinessProcesses" import="bulk" arisgroupname="Business Processes" isgroup="false" aristype="ST_FUNC" overview-model="MT_VAL_ADD_CHN_DGM,ST_VAL_ADD_CHN_SML_2">
<attr alfabet="Name" aris="AT_NAME" />
<link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Business Process in ALFABET" >
<title locale="1033" value="Navigate to Business Process in Alfabet" />
</link>
</class>
<class name="BPRule" import ="bulk" arisgroupname="Business Process Rules" isgroup="false" aristype="OT_RULE" overview-model="MT_EEPC,ST_OPR_AND_1" condition="Type">
<condition value="Connector" arisgroupname="Business Process Rules - AND" aristype="ST_OPR_AND_1" overview-model="MT_EEPC,ST_OPR_AND_1"/>
<condition value="XOR" arisgroupname="Business Process Rules - XOR" aristype="ST_OPR_XOR_1" overview-model="MT_EEPC,ST_OPR_XOR_1"/>
<attr alfabet="Name" aris="AT_NAME" />
</class>
<class name="BPInformationFlow" import="bulk" arisgroupname="Business Process Information Flows" aristype="CT_LEADS_TO_1,CT_ACTIV_1,CT_IS_PREDEC_OF_1,CT_LNK_2" overview-model="MT_EEPC,ST_FUNC">
<attr alfabet="Name" aris="AT_NAME" />
<cxn property="from" role="source" forceexist="true" />
<cxn property="to" role="target" forceexist="true" />
</class>
-->
</mapping>
The Alfabet import configuration handles the data transfer between ARIS and Alfabet. The configuration defines the general mapping for models, connections, and assignments between ARIS and Alfabet objects and how Alfabet objects are actually mapped in ARIS.
If you want to change the object type attributes to be used, or transfer different attributes, adapt the configuration. Changing the configuration is also required if you modified reports used in Alfabet
Generally, Alfabet classes are mapped to ARIS objects. Alfabet classes are mapped using the class XML property. The import of an entire class or the import/connection of a single Alfabet object is performed using the following import definition.
Class element
<name="Application" import="both"> report="DataImportIntoARIS_Applications" arisgroupname="Applications" isgroup="true" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE" condition="Stereotype">
<!-- Conditions for filtering objects -->
<!-- (Note: For performance reasons filtering should normally
be done by the Alfabet report. This is just an example
that demonstrates how it can be applied on the ARIS side.
The example is restricted to object mapping by
setting import="object".) -->
<filter property="ObjectState" value="Active" import="object"/>
<!-- Conditions for classifying objects -->
<condition value="BOT" arisgroupname="BOTs" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE"/>
<condition value="SaaS Systems" arisgroupname="SaaS" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE"/>
<condition value="TradingPartner" arisgroupname="Trading Partners" aristype="ST_APPL_SYS_TYPE" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE"/
All XML properties
name
import
report
isgroup
arisgroupname
aristype
overview-model (optional)
condition (optional)
check-master (optional)
condition (optional)
value
aristype
arisgroupname (optional)
'assign' sub-element of a 'class' element
Creates an assignment for all objects that are imported from this class.
All XML properties
type
model
child-symbol
add-parent
parent-symbol
'attr' sub-element
Maps an Alfabet property value, for example , String or Date, Reference or ReferenceArray properties are not allowed here.
<attr alfabet="StartDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_START" /> <attr alfabet="EndDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_END" /> <attr alfabet="StartDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_START" /> <attr alfabet="EndDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_END" />
In this case, the value of the "StartDate" property is written to the aris attribute "AT_EVALUATION_START" only if the alfabet property "Status" has the value "Evaluation", etc.
When used as a sub-element of the <cxn> element (see below), the property is mapped to an attribute of the connection.
XML properties
attr
Defines the handling of attributes. If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
aris
API name of the ARIS attribute. An empty string (""): not mapped/ignored.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
'cxn' sub-element
Creates a connection definition and/or an assignment between the current table item and the referenced item.
All XML properties
property
cxntype
srctotarget
forceexist (optional)
make-parent-group (optional)
connected-objtype (optional)
overview-model (optional)
assigned-model (optional)
'assign' sub-element of a 'cxn' element
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 class.
All XML properties
type
model
child-symbol
add-parent
parent-symbol
srctotarget (optional)
group (optional)
Alfabet classes, for example, BusinessSupport, ITMasterPlanMap, or ITSolutionMap, to be imported as process support units (PSU) are mapped using the class XML property in combination with import-target =" psu ".
ARIS handles PSUs automatically. Therefore, a specific database group structure is required, as well as defined relationships. Relationships are defined by the cxn XML properties along with their attr sub-elements. The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
If the PSU already exists in ARIS, it will be reused. Therefore, the referenced xobject and yobject objects must already exist.
<class name="BusinessSupport" import-target="psu" arisgroupname="Business support" aristype="OT_PROCESS_SUPPORT_UNIT">
<!-- these attributes are mapped as attributes of the PSU object-->
<attr alfabet="CREATION_USER" aris="AT_CREATOR" />
<attr alfabet="LAST_UPDATE_USER" aris="AT_LUSER" />
<attr alfabet="LAST_UPDATE" aris="AT_LAST_CHNG_2" />
<attr alfabet="CREATION_DATE" aris="AT_CREAT_TIME_STMP" />
<cxn property="object" cxntype="CT_BELONGS_TO_PROC_SUPPORT_UNIT" srctotarget="false" connected-objtype="OT_APPL_SYS_TYPE" >
<!-- the following attributes define the connection attributs for connection from the application system type to the PSU object: -->
<attr aris="AT_EXTERNAL_ID" alfabet="refstr" /> <!-- for cxns we do not map refstr/guid by default, so it must be listed here -->
<attr alfabet="StartDate" aris="AT_PHASE_IN_AS_IS" />
<attr alfabet="EndDate" aris="AT_PHASE_OUT_PLAN" />
<attr alfabet="ObjectState" aris="AT_PROC_SUPPORT_STATUS" />
<attr alfabet="Description" aris="AT_DESC" />
<attr alfabet="ID" aris="AT_ID" />
<attr alfabet="Name" aris="AT_CXN_ROLE" />
<attr alfabet="Status" aris="AT_REM" />
</cxn>
<cxn property="xobject" cxntype="CT_CAN_SUPP_1" srctotarget="true" connected-objtype="OT_FUNC" />
<cxn property="yobject" cxntype="CT_CAN_BE_USER" srctotarget="false" connected-objtype="OT_ORG_UNIT" />
<cxn property="deployments" /> <!-- Deployment array. Enabling Deployments, The deployment that is supported by the business support. -->
<cxn property="businessservices" /> <!-- BusinessService. Enabling Business Services, The business services that are used by the business support. -->
<cxn property="aspects" /> <!-- Artifact. The operational aspects that the business support addresses. -->
</class>
Alfabet classes, such as, ITMasterPlanMap, ITSolutionMap, and ITStrategyMap, to be imported as a process support map (PSM) are mapped using the class XML property in combination with import-target =" psm ".
<class name="ITMasterPlanMap" import-target="psm"arisgroupname="IT landscape planning">
<items class="BusinessSupport" />
<attr alfabet="name" aris="AT_NAME" />
<attr alfabet="description" aris="AT_DESC" />
<attr alfabet="id" aris="AT_ID" />
</class>
Alfabet models are defined in a way different from ARIS models. Alfabet models do not always reference the objects they contain. Instead, the objects reference the models in which they are represented. Therefore, the import definition needs to specify where to find the model items: see items sub-element.
<class name="BusinessProcessModel" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items class="BusinessProcess" property="model" symbol="ST_VAL_ADD_CHN_SML_2">
<attr alfabet="name" aris="AT_NAME" />
<attr alfabet="description" aris="AT_DESC" />
<attr alfabet="id" aris="AT_ID" />
<attr alfabet="version" aris="AT_REL_1" />
<cxn property="aris_guid" arisguid="unique" /> <!-- if used, use as unique ID and fix/check alfabet ID -->
<cxn property="diagrams" /> <!-- what is this? views? []BusinessProcessDiagram -->
<cxn property="documents" /> <!-- cannot be mapped -->
</class>
Class element
The use of this element is the same as described here.
XML properties
name
Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group. If the entire table is imported, arisgroupname is the name of the subgroup that is created for the table content. If arisgroupname is empty or not specified, no subgroup will be created.
overview-model (optional)
Optionally creates an overview model of the specified type and places an occurrence of each class object that meets this condition in the model. Specify the API name of a model type, such as MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE.
check-master (optional)
Checks for the existence of the specified Alfabet property, such as ARIS_GUID, maintained for an Alfabet object with the ARIS GUID of the corresponding ARIS object. If the ARIS database contains this GUID, the related ARIS object is 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 the object has been deleted in Alfabet.
condition (optional)
Defines a conditional mapping based on the property referenced by the condition attribute of the condition element. For example, if the property referenced in the class element is Stereotype (<class ... condition="Stereotype">) and a condition element specifies "BOT" as the value to be matched (<condition ... value="BOT"/>), then all objects that have a "BOT" stereotype are mapped according to what the condition element defines, and NOT according to what the class element defines. They could, for example, be stored in a different database group or get a different symbol.
cxntypes (optional)
Comma-separated list of API names that are to be shown for the ARIS connection types contained in the model. These names are shown only if the corresponding connections exist between the objects contained in the model.
'attr' sub-element
Maps an Alfabet property value, for example , String or Date, Reference or ReferenceArray properties are not allowed here.
<attr alfabet="StartDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_START" /> <attr alfabet="EndDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_END" /> <attr alfabet="StartDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_START" /> <attr alfabet="EndDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_END" />
In this case, the value of the "StartDate" property is written to the aris attribute "AT_EVALUATION_START" only if the alfabet property "Status" has the value "Evaluation", etc.
When used as a sub-element of the <cxn> element (see below), the property is mapped to an attribute of the connection.
XML properties
attr
Defines the handling of attributes. If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
aris
API name of the ARIS attribute. An empty string (""): not mapped/ignored.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
'items' sub-element of a 'class' element
XML properties
class (optional)
Alfabet object class name.
If omitted: The model elements are to be found in the model properties (<cxn>).
If used: The model provides no reference to the objects it contains. Therefore, additional information is required to indicate in which class to find these objects. This can be a list of item elements if the model references to more than one class.
property
Property name.
If the 'class' property is used: property of the Alfabet object class containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection class can be recognized by the fact that no property ID is defined in it.
class element
XML properties
Only name and aristype are valid attributes.
'assign' sub-element of a class element
Creates an assignment for all connections that are imported from this class. This can be performed only if the target reference is a model.
XML properties
add-parent
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.
'attr' sub-element
Maps properties to ARIS connection attributes. This is not applicable to imports including assignments only. The syntax is the same as in the general description (see 'attr' sub-element).
'cxn' sub-element
Defines the properties to contain the source and the target of the connection.
property
role
forceexist (optional)
Example
<class name="BPINFORMATIONFLOW" aristype="CT_LEADS_TO_1,CT_ACTIV_1,CT_IS_PREDEC_OF_1,CT_LNK_2"
<attr aris="AT_CXN_ROLE" alfabet="name" />
<attr aris="AT_DESC" alfabet="description" />
<attr aris="AT_REM" alfabet="shortname" />
<cxn property="from" role="source" forceexist ="true" > <!-- src must exist / is imported if needed–>
<cxn property="to" role="target" forceexist ="true" > <!-- src must exist / is imported if needed–>
<cxn property="data" /> <!-- not mapped -->
<cxn property="documents" /> <!-- not mapped -->
</class>