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.

Default Alfabet import configuration (example)

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">

<class 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">

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

import

Specifies the kind of import for each <class>.

You can set either object, bulk, or both.

report

Alfabet report to request objects with the required and mapped data.

The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

The reports must return the following properties at a minimum:

  • all mapped properties

  • all properties used as a condition to determine ARIS types.

  • in case of a PSU mapping: refstr, xobject, yobject

  • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

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 object class. All imported objects are stored in this group.

If arisgroupname is empty or not specified, no subgroup will be created. If a conditional mapping is defined, related objects are imported to the corresponding groups.

isgroup

If true, creates a group for each imported object.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

condition

Property, such as Stereotype that is optionally used to determine the condition value specified in the condition elements below.

<!-- 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"/>

filter

Filters on property values.

Filter conditions, such as mapping applications with property ObjectState = "Active", should be defined within the Alfabet report if possible.

If you use the <filter> element, you can apply further filtering on ARIS side.

Filters are defined by the following properties:

  • property: the property providing the value for filtering.

  • value: the value of the property for allowed items.

  • import: import type where to apply the filter. Can be "object", "bulk", or "both" ("" is interpreted as "both").

property

Alfabet class property name, for example, ObjectState.

Value

Value of the property which marks objects that are supposed to be imported.

In this example, the ObjectState property value is Active.

import

Import type where to apply the filter. Values can be object, bulk, or both ("" is interpreted as "both").

<!-- 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

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

value

Property value specifying that this condition is to be applied.

arisgroupname

Optionally overwrites the default group name of the Alfabet object class element for items meeting this condition.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

<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"/>

alfabet

Name of the Alfabet property.

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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">

property XML property

Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.

See the Documentation of the Alfabet Meta-Model. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.

cxntype

API name of the ARIS connection type.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Empty string (""): not mapped/ignored.

Value="-1": do not create a connection. Is allowed only if an assignment definition is available as a sub-element.

srctotarget

Defines the direction of a connection.

Value true:

From class element to referenced element.

Value false:

From referenced element to class element.

forceexist

Specifies whether or not the import forces the target or source object of a referenced object to exist in the database. If the value is set to true, the target or source object will be created using the mapping definition of the referenced object. Only if the target or 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.

The default value is false.

<assign type="all" model="MT_APPL_SYST_TYPE_DGN" add-parent="true" parent-symbol="ST_APPL_SYS_TYPE" child-symbol="ST_APPL_SYST_TYPE"/>

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.

type

Creates one assigned model per imported object. Cannot be used as class subordinate element.

model

API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

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.

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Required only if the add-parent attribute is set to true.

child-symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Not used if the referenced element is the model itself.

</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" >

link

Creates ARIS link attributes as a reference between ARIS and Alfabet.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

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.

defaultvalue

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 locale="1033" value="Navigate to Application in Alfabet" />

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 logged into the ARIS database in another language, for example, German, the values of the German attributes are displayed in English.

value

Localized title text.

</link>

<!-- Configuration of dialog for object mapping -->

<dialog-columns>

dialog-columns

Defines the Alfabet object class to be available in the Select Alfabet object dialog.

In this example, the Application Alfabet object class is the source. All Alfabet objects of this class will be displayed.

<column alfabet="Version"/>

column alfabet

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.

<newlink url="ExternalAccess.aspx?AccessType=ExternalAccess&UserType=Named&View=GraphicView:APP_CaptureApplications_Ex"/>

newlink url

Defines the link to Alfabet for creating new Alfabet objects. This Create Alfabet object link is available in the Select Alfabet object dialog.

Do not change this value:

"ExternalAccess.aspx?AccessType=ExternalAccess&amp;UserType=Named&amp;View=GraphicView:APP_CaptureApplications_Ex"

The value represents the static part of the link. The link will be assembled using this value and the User interface URL value that you specified when you connected the ARIS database to the Alfabet system.

</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">

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

report

Alfabet report to request objects with the required and mapped data.

The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

The reports must return the following properties at a minimum:

  • all mapped properties

  • all properties used as a condition to determine ARIS types.

  • in case of a PSU mapping: refstr, xobject, yobject

  • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

import

Specifies the kind of import for each <class>.

You can set either object, bulk, or both.

<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">

cxntype

API name of the ARIS connection type.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Empty string (""): not mapped/ignored.

Value="-1": do not create a connection. Is allowed only if an assignment definition is available as a sub-element.

<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">

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

report

Alfabet report to request objects with the required and mapped data.

The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

The reports must return the following properties at a minimum:

  • all mapped properties

  • all properties used as a condition to determine ARIS types.

  • in case of a PSU mapping: refstr, xobject, yobject

  • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

check-master

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.

<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">

linkarisonly

Affects items transferred from ARIS to Alfabet. 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 class attribute is mandatory.

<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>

All XML properties (Alfabet import configuration)

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

<class 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">

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

import

Specifies the kind of import for each <class>.

You can set either object, bulk, or both.

report

Alfabet report to request objects with the required and mapped data.

The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

The reports must return the following properties at a minimum:

  • all mapped properties

  • all properties used as a condition to determine ARIS types.

  • in case of a PSU mapping: refstr, xobject, yobject

  • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

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 object class. All imported objects are stored in this group.

If arisgroupname is empty or not specified, no subgroup will be created. If a conditional mapping is defined, related objects are imported to the corresponding groups.

isgroup

If true, creates a group for each imported object.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

condition

Property, such as Stereotype that is optionally used to determine the condition value specified in the condition elements below.

<!-- 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"/>

filter

Filters on property values.

Filter conditions, such as mapping applications with property ObjectState = "Active", should be defined within the Alfabet report if possible.

If you use the <filter> element, you can apply further filtering on ARIS side.

Filters are defined by the following properties:

  • property: the property providing the value for filtering.

  • value: the value of the property for allowed items.

  • import: import type where to apply the filter. Can be "object", "bulk", or "both" ("" is interpreted as "both").

property

Alfabet class property name, for example, ObjectState.

Value

Value of the property which marks objects that are supposed to be imported.

In this example, the ObjectState property value is Active.

import

Import type where to apply the filter. Values can be object, bulk, or both ("" is interpreted as "both").

<!-- 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

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

value

Property value specifying that this condition is to be applied.

arisgroupname

Optionally overwrites the default group name of the Alfabet object class element for items meeting this condition.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

<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

class name

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

  • import

    import

    Specifies the kind of import for each <class>.

    You can set either object, bulk, or both.

  • report

    report

    Alfabet report to request objects with the required and mapped data.

    The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

    The reports must return the following properties at a minimum:

    • all mapped properties

    • all properties used as a condition to determine ARIS types.

    • in case of a PSU mapping: refstr, xobject, yobject

    • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

    Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

  • isgroup

    isgroup

    If true, creates a group for each imported object.

  • arisgroupname

    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 object class. All imported objects are stored in this group.

    If arisgroupname is empty or not specified, no subgroup will be created. If a conditional mapping is defined, related objects are imported to the corresponding groups.

  • aristype

    aristype

    API name of an object type, a model type, or a symbol type.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • overview-model (optional)

    overview-model

    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.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • condition (optional)

    condition

    Property, such as Stereotype that is optionally used to determine the condition value specified in the condition elements below.

  • check-master (optional)

    check-master

    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)

condition

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

  • value

    value

    Property value specifying that this condition is to be applied.

  • aristype

    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.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • arisgroupname (optional)

    arisgroupname

    Optionally overwrites the default group name of the Alfabet object class element for items meeting this condition.

'assign' sub-element of a 'class' element

Creates an assignment for all objects that are imported from this class.

All XML properties

type

type

Creates one assigned model per imported object. Cannot be used as class subordinate element.

model

model

API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

child-symbol

child-symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Not used if the referenced element is the model itself.

add-parent

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.

parent-symbol

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Required only if the add-parent attribute is set to true.

'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 XML property

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.

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.

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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.

All XML properties

attr

attr XML property

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

alfabet

Name of the Alfabet property.

aris

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

XML properties for conditional attribute import

condition

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

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

property XML property

Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.

See the Documentation of the Alfabet Meta-Model. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.

cxntype

cxntype

API name of the ARIS connection type.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Empty string (""): not mapped/ignored.

Value="-1": do not create a connection. Is allowed only if an assignment definition is available as a sub-element.

srctotarget

srctotarget

Defines the direction of a connection.

Value true:

From class element to referenced element.

Value false:

From referenced element to class element.

forceexist (optional)

forceexist

Specifies whether or not the import forces the target or source object of a referenced object to exist in the database. If the value is set to true, the target or source object will be created using the mapping definition of the referenced object. Only if the target or 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.

The default value is false.

make-parent-group (optional)

make-parent-group

Specifies that the group containing the referenced element will become the superior group of the element in question.

You must set the parent mapping to isgroup="true".

connected-objtype (optional)

connected-objtype

Used to validate the source/target object type. An exception is thrown during import if the type of the existing object is identified to be invalid.

overview-model (optional)

overview-model

Creates an occurrence of the target object and the corresponding connection in the overview model if the overview-model property is specified at the class element.

The value corresponds to the symbol type number (see API name).

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

assigned-model (optional)

assigned-model

Creates an occurrence of the target object and the corresponding connection in the assigned model if the object class element has an assigned sub-element.

The value corresponds to the symbol type number (see API name).

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

'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

type

Type of the assignment. Possible values are:

all

Assigns them all to the superior item in one model.

each

Assigns one model per subordinate item.

model

model

API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

child-symbol

child-symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Not used if the referenced element is the model itself.

add-parent

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.

parent-symbol

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Required only if the add-parent attribute is set to true.

srctotarget (optional)

srctotarget

Optionally defines the assignment's direction.

Value true (default value):

From object class element to referenced element.

Value false:

From referenced element to object class element.

group (optional)

group (depending on srctotarget)

Optionally defines in which database group the assigned model is created. source is the group of the table element, target is the group of the connected element.

Value source (default value):

Database group where the source table element of the assignment is stored.

Value target:

Database group where the connected table element of the assignment is stored.

Mapping syntax for classes defining process support units (PSU)

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">

class name

Name of the Alfabet object class to be imported as process support unit (PSU), for example, BusinessSupport, ITMasterPlanMap, or ITSolutionMap.

import-target

Attribute value of the import target Process Support Unit (PSU) or Process Support Map (PSM).

For PSU import, you must specify the attribute import-target="psu". For PSM import, you must specify the attribute or import-target="psm".

arisgroupname XML property

Name of the ARIS database subgroup where the process support unit (PSU) is to be created.

aristype XML property

API name of the ARIS object type to be used for process support units.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

By default, the Process support unit object type (OT_PROCESS_SUPPORT_UNIT) is used in ARIS. The aristype value must be exactly the same as in the ARIS - ALFABET-mapping.xml file.

<!-- these attributes are mapped as attributes of the PSU object-->

<attr alfabet="CREATION_USER" aris="AT_CREATOR" />

attr XML property

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 XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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" >

cxn XML property

The cxn XML properties along with their attr sub-elements define the relationship between the objects.

In this example, the property XML property with the value object, combined with the cxntype XML property with the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property with the value OT_APPL_SYS_TYPE define the relationship between process support units and application system types.

<!-- 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" />

The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.

<cxn property="yobject" cxntype="CT_CAN_BE_USER" srctotarget="false" connected-objtype="OT_ORG_UNIT" />

The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.

<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>

Mapping syntax for classes defining process support maps (PSM)

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">

Class name

Name of the Alfabet object class to be imported as process support map (PSM), for example, ITMasterPlanMap, ITSolutionMap, and ITStrategyMap.

import-target

Attribute value of the import target Process Support Unit (PSU) or Process Support Map (PSM).

For PSU import, you must specify the attribute import-target="psu". For PSM import, you must specify the attribute or import-target="psm".

arisgroupname XML property

Name of the ARIS database subgroup where the process support map (PSM) is to be created.

<items class="BusinessSupport" />

items XML property

The items sub-element refers to the object class that defines which PSUs are contained in the PSM. This needs to be specified because the import of PSUs that are being used requires special handling.

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">

class name

Name of the Alfabet object class to be imported as process support unit (PSU), for example, BusinessSupport, ITMasterPlanMap, or ITSolutionMap.

import-target

Attribute value of the import target Process Support Unit (PSU) or Process Support Map (PSM).

For PSU import, you must specify the attribute import-target="psu". For PSM import, you must specify the attribute or import-target="psm".

arisgroupname XML property

Name of the ARIS database subgroup where the process support unit (PSU) is to be created.

aristype XML property

API name of the ARIS object type to be used for process support units.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

By default, the Process support unit object type (OT_PROCESS_SUPPORT_UNIT) is used in ARIS. The aristype value must be exactly the same as in the ARIS - ALFABET-mapping.xml file.

<!-- these attributes are mapped as attributes of the PSU object-->

<attr alfabet="CREATION_USER" aris="AT_CREATOR" />

attr XML property

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 XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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" >

cxn XML property

The cxn XML properties along with their attr sub-elements define the relationship between the objects.

In this example, the property XML property with the value object, combined with the cxntype XML property with the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property with the value OT_APPL_SYS_TYPE define the relationship between process support units and application system types.

<!-- 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" />

The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.

<cxn property="yobject" cxntype="CT_CAN_BE_USER" srctotarget="false" connected-objtype="OT_ORG_UNIT" />

The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.

<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>

class XML property (mandatory).

Name of the source Alfabet object class, such as, BusinessSupport, ITMasterPlanMap, or ITSolutionMap, containing the PSUs to be used in the PSM.

<attr alfabet="name" aris="AT_NAME" />

attr XML property

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 XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<attr alfabet="description" aris="AT_DESC" />

<attr alfabet="id" aris="AT_ID" />

</class>

Mapping syntax for classes defining models

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.

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

<class 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">

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

import

Specifies the kind of import for each <class>.

You can set either object, bulk, or both.

report

Alfabet report to request objects with the required and mapped data.

The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

The reports must return the following properties at a minimum:

  • all mapped properties

  • all properties used as a condition to determine ARIS types.

  • in case of a PSU mapping: refstr, xobject, yobject

  • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

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 object class. All imported objects are stored in this group.

If arisgroupname is empty or not specified, no subgroup will be created. If a conditional mapping is defined, related objects are imported to the corresponding groups.

isgroup

If true, creates a group for each imported object.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

condition

Property, such as Stereotype that is optionally used to determine the condition value specified in the condition elements below.

<!-- 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"/>

filter

Filters on property values.

Filter conditions, such as mapping applications with property ObjectState = "Active", should be defined within the Alfabet report if possible.

If you use the <filter> element, you can apply further filtering on ARIS side.

Filters are defined by the following properties:

  • property: the property providing the value for filtering.

  • value: the value of the property for allowed items.

  • import: import type where to apply the filter. Can be "object", "bulk", or "both" ("" is interpreted as "both").

property

Alfabet class property name, for example, ObjectState.

Value

Value of the property which marks objects that are supposed to be imported.

In this example, the ObjectState property value is Active.

import

Import type where to apply the filter. Values can be object, bulk, or both ("" is interpreted as "both").

<!-- 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

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

value

Property value specifying that this condition is to be applied.

arisgroupname

Optionally overwrites the default group name of the Alfabet object class element for items meeting this condition.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

<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

class name

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

  • import

    import

    Specifies the kind of import for each <class>.

    You can set either object, bulk, or both.

  • report

    report

    Alfabet report to request objects with the required and mapped data.

    The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

    The reports must return the following properties at a minimum:

    • all mapped properties

    • all properties used as a condition to determine ARIS types.

    • in case of a PSU mapping: refstr, xobject, yobject

    • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

    Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

  • isgroup

    isgroup

    If true, creates a group for each imported object.

  • arisgroupname

    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 object class. All imported objects are stored in this group.

    If arisgroupname is empty or not specified, no subgroup will be created. If a conditional mapping is defined, related objects are imported to the corresponding groups.

  • aristype

    aristype

    API name of an object type, a model type, or a symbol type.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • overview-model (optional)

    overview-model

    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.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • condition (optional)

    condition

    Property, such as Stereotype that is optionally used to determine the condition value specified in the condition elements below.

  • check-master (optional)

    check-master

    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)

condition

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

  • value

    value

    Property value specifying that this condition is to be applied.

  • aristype

    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.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • arisgroupname (optional)

    arisgroupname

    Optionally overwrites the default group name of the Alfabet object class element for items meeting this condition.

'assign' sub-element of a 'class' element

Creates an assignment for all objects that are imported from this class.

All XML properties

type

type

Creates one assigned model per imported object. Cannot be used as class subordinate element.

model

model

API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

child-symbol

child-symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Not used if the referenced element is the model itself.

add-parent

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.

parent-symbol

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Required only if the add-parent attribute is set to true.

'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 XML property

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.

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.

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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.

All XML properties

attr

attr XML property

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

alfabet

Name of the Alfabet property.

aris

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

XML properties for conditional attribute import

condition

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

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

property XML property

Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.

See the Documentation of the Alfabet Meta-Model. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.

cxntype

cxntype

API name of the ARIS connection type.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Empty string (""): not mapped/ignored.

Value="-1": do not create a connection. Is allowed only if an assignment definition is available as a sub-element.

srctotarget

srctotarget

Defines the direction of a connection.

Value true:

From class element to referenced element.

Value false:

From referenced element to class element.

forceexist (optional)

forceexist

Specifies whether or not the import forces the target or source object of a referenced object to exist in the database. If the value is set to true, the target or source object will be created using the mapping definition of the referenced object. Only if the target or 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.

The default value is false.

make-parent-group (optional)

make-parent-group

Specifies that the group containing the referenced element will become the superior group of the element in question.

You must set the parent mapping to isgroup="true".

connected-objtype (optional)

connected-objtype

Used to validate the source/target object type. An exception is thrown during import if the type of the existing object is identified to be invalid.

overview-model (optional)

overview-model

Creates an occurrence of the target object and the corresponding connection in the overview model if the overview-model property is specified at the class element.

The value corresponds to the symbol type number (see API name).

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

assigned-model (optional)

assigned-model

Creates an occurrence of the target object and the corresponding connection in the assigned model if the object class element has an assigned sub-element.

The value corresponds to the symbol type number (see API name).

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

'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

type

Type of the assignment. Possible values are:

all

Assigns them all to the superior item in one model.

each

Assigns one model per subordinate item.

model

model

API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

child-symbol

child-symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Not used if the referenced element is the model itself.

add-parent

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.

parent-symbol

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Required only if the add-parent attribute is set to true.

srctotarget (optional)

srctotarget

Optionally defines the assignment's direction.

Value true (default value):

From object class element to referenced element.

Value false:

From referenced element to object class element.

group (optional)

group (depending on srctotarget)

Optionally defines in which database group the assigned model is created. source is the group of the table element, target is the group of the connected element.

Value source (default value):

Database group where the source table element of the assignment is stored.

Value target:

Database group where the connected table element of the assignment is stored.

XML properties

class name

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

aristype

aristype

API name of an ARIS model type.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

arisgroupname

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)

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

check-master (optional)

check-master

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)

condition

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

cxntypes (optional)

cxntypes

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

'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 XML property

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.

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.

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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.

All XML properties

attr

attr XML property

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

alfabet

Name of the Alfabet property.

aris

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

XML properties for conditional attribute import

condition

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

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)

class

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

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

symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Mapping syntax for classes defining connections only

A pure connection class can be recognized by the fact that no property ID is defined in it.

class element

XML properties

Only class name and aristype are valid attributes.

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

aristype

Comma-separated list of API names for ARIS connection types. The connection types are tried one after another until a type is found that is valid between the source and target object type. This is useful if the source and target objects are of more than one type.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a sub-element.

'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

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.

parent-symbol

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

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).

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

<class 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">

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

import

Specifies the kind of import for each <class>.

You can set either object, bulk, or both.

report

Alfabet report to request objects with the required and mapped data.

The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

The reports must return the following properties at a minimum:

  • all mapped properties

  • all properties used as a condition to determine ARIS types.

  • in case of a PSU mapping: refstr, xobject, yobject

  • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

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 object class. All imported objects are stored in this group.

If arisgroupname is empty or not specified, no subgroup will be created. If a conditional mapping is defined, related objects are imported to the corresponding groups.

isgroup

If true, creates a group for each imported object.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

condition

Property, such as Stereotype that is optionally used to determine the condition value specified in the condition elements below.

<!-- 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"/>

filter

Filters on property values.

Filter conditions, such as mapping applications with property ObjectState = "Active", should be defined within the Alfabet report if possible.

If you use the <filter> element, you can apply further filtering on ARIS side.

Filters are defined by the following properties:

  • property: the property providing the value for filtering.

  • value: the value of the property for allowed items.

  • import: import type where to apply the filter. Can be "object", "bulk", or "both" ("" is interpreted as "both").

property

Alfabet class property name, for example, ObjectState.

Value

Value of the property which marks objects that are supposed to be imported.

In this example, the ObjectState property value is Active.

import

Import type where to apply the filter. Values can be object, bulk, or both ("" is interpreted as "both").

<!-- 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

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

value

Property value specifying that this condition is to be applied.

arisgroupname

Optionally overwrites the default group name of the Alfabet object class element for items meeting this condition.

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

overview-model

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.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

<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

class name

class name

Alfabet object class name, for example, Application, ValueNode, or BusinessProcess.

  • import

    import

    Specifies the kind of import for each <class>.

    You can set either object, bulk, or both.

  • report

    report

    Alfabet report to request objects with the required and mapped data.

    The reports include a set of defined properties and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as the lifecycle attributes of an Application system type object.

    The reports must return the following properties at a minimum:

    • all mapped properties

    • all properties used as a condition to determine ARIS types.

    • in case of a PSU mapping: refstr, xobject, yobject

    • in case of a PSM mapping: refstr, xobjects1, yobjects1, name, last update, property defined by user as master guid check attribute, property defined as condition for 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.

    Alfabet reports that support the default configuration are shipped with Alfabet releases 10.5p2 and higher. You can modify these reports in Alfabet or define your own reports. If you create custom reports, make sure to modify your Alfabet configuration accordingly.

  • isgroup

    isgroup

    If true, creates a group for each imported object.

  • arisgroupname

    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 object class. All imported objects are stored in this group.

    If arisgroupname is empty or not specified, no subgroup will be created. If a conditional mapping is defined, related objects are imported to the corresponding groups.

  • aristype

    aristype

    API name of an object type, a model type, or a symbol type.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • overview-model (optional)

    overview-model

    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.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • condition (optional)

    condition

    Property, such as Stereotype that is optionally used to determine the condition value specified in the condition elements below.

  • check-master (optional)

    check-master

    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)

condition

Defines a conditional mapping based on a property's value of the class element, such as Stereotype. If Stereotype is specified and objects match one of the values, such as BOT or SaaS Systems listed in the condition elements below, objects are mapped according to what the condition element defines, and NOT according to what the class element defines. This means, objects matching the BOT and SaaS Systems condition value are imported into the BOTs and the SaaS database group instead of the Applications database group.

  • value

    value

    Property value specifying that this condition is to be applied.

  • aristype

    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.

    Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

    Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

  • arisgroupname (optional)

    arisgroupname

    Optionally overwrites the default group name of the Alfabet object class element for items meeting this condition.

'assign' sub-element of a 'class' element

Creates an assignment for all objects that are imported from this class.

All XML properties

type

type

Creates one assigned model per imported object. Cannot be used as class subordinate element.

model

model

API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

child-symbol

child-symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Not used if the referenced element is the model itself.

add-parent

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.

parent-symbol

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Required only if the add-parent attribute is set to true.

'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 XML property

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.

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.

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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.

All XML properties

attr

attr XML property

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

alfabet

Name of the Alfabet property.

aris

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

XML properties for conditional attribute import

condition

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

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

property XML property

Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.

See the Documentation of the Alfabet Meta-Model. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.

cxntype

cxntype

API name of the ARIS connection type.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Empty string (""): not mapped/ignored.

Value="-1": do not create a connection. Is allowed only if an assignment definition is available as a sub-element.

srctotarget

srctotarget

Defines the direction of a connection.

Value true:

From class element to referenced element.

Value false:

From referenced element to class element.

forceexist (optional)

forceexist

Specifies whether or not the import forces the target or source object of a referenced object to exist in the database. If the value is set to true, the target or source object will be created using the mapping definition of the referenced object. Only if the target or 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.

The default value is false.

make-parent-group (optional)

make-parent-group

Specifies that the group containing the referenced element will become the superior group of the element in question.

You must set the parent mapping to isgroup="true".

connected-objtype (optional)

connected-objtype

Used to validate the source/target object type. An exception is thrown during import if the type of the existing object is identified to be invalid.

overview-model (optional)

overview-model

Creates an occurrence of the target object and the corresponding connection in the overview model if the overview-model property is specified at the class element.

The value corresponds to the symbol type number (see API name).

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

assigned-model (optional)

assigned-model

Creates an occurrence of the target object and the corresponding connection in the assigned model if the object class element has an assigned sub-element.

The value corresponds to the symbol type number (see API name).

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

'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

type

Type of the assignment. Possible values are:

all

Assigns them all to the superior item in one model.

each

Assigns one model per subordinate item.

model

model

API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

child-symbol

child-symbol

API name for the symbol type of the ARIS object used in the assigned model, for example, ST_APPL_SYST_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Not used if the referenced element is the model itself.

add-parent

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.

parent-symbol

parent-symbol

API name for the symbol type of the superior ARIS object used in the assigned model, for example, ST_APPL_SYS_TYPE.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

Required only if the add-parent attribute is set to true.

srctotarget (optional)

srctotarget

Optionally defines the assignment's direction.

Value true (default value):

From object class element to referenced element.

Value false:

From referenced element to object class element.

group (optional)

group (depending on srctotarget)

Optionally defines in which database group the assigned model is created. source is the group of the table element, target is the group of the connected element.

Value source (default value):

Database group where the source table element of the assignment is stored.

Value target:

Database group where the connected table element of the assignment is stored.

'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 XML property

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.

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.

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

<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.

All XML properties

attr

attr XML property

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

alfabet

Name of the Alfabet property.

aris

aris XML property

API name of the ARIS attribute.

Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.

Information about API names is available in ARIS (Application launcher Application launcher > Administration Administration > Configuration Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.

An empty string (""): not mapped/ignored.

XML properties for conditional attribute import

condition

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

Value that is checked against the value of the condition XML property for conditional attribute import.

'cxn' sub-element

Defines the properties to contain the source and the target of the connection.

property

property XML property

Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.

See the Documentation of the Alfabet Meta-Model. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.

role

role

Defines the role of the object referenced by the property.

Possible values are: source or target.

forceexist (optional)

forceexist

Specifies whether or not the import forces the target or source object of a referenced object to exist in the database. If the value is set to true, the target or source object will be created using the mapping definition of the referenced object. Only if the target or 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.

The default value is false.

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>

Example 1

<class name="ApplicationGroup" arisgroupname="Application groups" aristype="OT_APPL_SYS_CLS" isgroup="true" 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="a_size" aris="" /> <!-- not mapped-->

...

<cxn property="belongsto" cxntype="CT_CAN_SUBS_2" srctotarget="false" />

<!-- overview-model="ST_APPL_SYS_CLS" means: show in overview model with its CXN and the given symbol -->

<!-- an attr element within a cxn element maps an attribute from the Alfabet table to the cxn -->

<cxn property="belongsto" cxntype="CT_CAN_SUBS_2" srctotarget="false" connected-objtype="OT_APPL_SYS_CLS" overview-model="ST_APPL_SYS_CLS" ordernum="1" >

<attr alfabet="refstr" aris="AT_EXTERNAL_ID" />

</cxn>

<cxn property="applications" cxntype="CT_BELONGS_TO_CLS" srctotarget="true" >

<!-- "each" would mean 1 assignment per child, all=assign them all to the parent in one model -->

<!-- add-parent: assignment contains occ of the parent. This needs: parent-symbol="ST_APPL_SYS_CLS" -->

<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>

<cxn property="processes" /> <!-- not mapped-->

</class>

This 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.

Example 2

<class name=" BusinessProcess" arisgroupname="Business processes" aristype="OT_FUNC" isgroup="true" overview-model="MT_VAL_ADD_CHN_DGM,ST_VAL_ADD_CHN_SML_2" check-master="ARIS_GUID" >

<!-- "each" would mean 1 assignment per child, all=assign them all to the parent in one model -->

<!-- add-parent: assignment contains occ of the parent. This needs: parent-symbol="ST_APPL_SYS_CLS" -->

<assign type="each" model="MT_FUNC_ALLOC_DGM" add-parent="true" parent-symbol="ST_VAL_ADD_CHN_SML_2" child-symbol="ST_FUNC" />

<attr alfabet="name" aris="AT_NAME" />

<attr alfabet="shortname" aris="AT_REM" />

...

<cxn property="belongsto" srctotarget="false" cxntype="CT_IS_PRCS_ORNT_SUPER" overview-model="ST_VAL_ADD_CHN_SML_2" /> <!-- BusinessProcess–>

<createocc property="model" symbol="ST_VAL_ADD_CHN_SML_2" forceexist="false" /> <!-- creates occ in the model if the model exists -->

<cxn property="executingorganizations" srctotarget="false" cxntype="CT_EXEC_1" forceexist="true" assigned-model="ST_ORG_UNIT_2" />

<cxn property="applications" srctotarget="false" cxntype="CT_CAN_SUPP_1" forceexist="true" assigned-model="ST_APPL_SYS_TYPE"/>

...

</class>

This example shows the mapping to an object to with a model is assigned. Additionally, an object occurrence is created in the target model.