This file defines all objects to be mapped to Alfabet objects. It also defines the objects to be imported and synchronized, as well as the login for exchanging data.
User settings
Defines the login to Alfabet RESTful API for exchanging data.
<user
name=""
token="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL"
accessmode="httpclient"/>
accessmode
User access mode. The default setting is httpclient.
token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be specified in the Alfabet integration property dialog of the related database.
If no user name is entered (default setting) and the key for the Alfabet server defined in the Web configuration file for the Alfabet Web application is entered as a token, all users have read and write access to all Alfabet objects.
If a user name is entered, only this user has access to the Alfabet objects according to the privileges provided.
Further information about the token and authorization can be found in the Alfabet Interface for RESTful Web Services manual, which you can download from Empower.
name
User name for Alfabet RESTful API. If the RESTful API of the Alfabet system is configured for anonymous access, you only need to enter the related token. If the RESTful API is configured to be accessed by a user, you must enter both the user name and the password. Login credentials, Web service URL, and User interface URL can also be specified in the Alfabet integration property dialog of the related database.
user
Controls the login to Alfabet RESTful API for exchanging data. The user name, token, and access mode must be specified. Login credentials, Web service URL, and User interface URL can also be specified in the Alfabet integration property dialog of the related database.
By default, a sample token is set. The user name is not entered. By default, this anonymous access grants all users read and write access to all Alfabet objects.
Enter the key for the Alfabet server as the value for the token tag. This value depends on the user name. Enter a user name as the value for the name tag. This means that only this user has access to the Alfabet objects for which they have privileges.
Further information about the token and authorization can be found in the Alfabet Interface for RESTful Web Services manual, which you can download from Empower.
When accessing the Alfabet RESTful API, the login data is transferred with the HTTP header. Therefore, you must ensure that the transfer is encrypted.
Individual mapping
In the <!-- Single object mapping --> section, you can individually link ARIS items to Alfabet items.
<!-- Single object mapping -->
<object
aristype="OT_APPL_SYS_TYPE"
table="APPLICATION" >
table
Name of the Alfabet database table that contains the items to be mapped, for example, "APPLICATION".
The table value must be exactly the same as in the ARIS-ALFABET-mapping.xml file.
aristype
ARIS API name of an object type, a model type, or a symbol type.
It defines the ARIS item type to be provided for individual item mapping during Alfabet integration. Symbol types can be used to specify their object types. You can define multiple ARIS item types for the same Alfabet table. It is recommended that you define each ARIS item type in a separate <object> entry.
The aristype values must be exactly the same as in the ARIS - ALFABET-mapping.xml file.
If you want to change the default Application system type object type (OT_APPL_SYS_TYPE), make sure that all the attribute types required for Alfabet integration are available for the object type you want to use instead.
By default, these are the Name (AT_NAME), Description (AT_DESC), Release (AT_REL_3), and ALFABET Link 1 (AT_ALFA_LINK_1) types. In this case, you should also add all Alfabet attributes.
Of course, you can change the object type attributes to be used, or transfer other attributes. For example, if you do not want to use the Release (AT_REL_3) attribute type for the release (version), adapt both configuration files.
object XML property
Each object element defines one specific ARIS item to be provided during Alfabet integration. Thus, each ARIS item type must be defined in a separate object element.
<condition property="ObjectState"
value="Active" />
Value
Value of the specified Alfabet class property to be used for filtering table items.
In this example, the ObjectState property value is Active. The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
condition property
Alfabet class property name, for example, ObjectState.
The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
You enter only one condition property for filtering.
By default, the Name attribute will be overwritten when exchanging data.
If you map an ARIS object to an Alfabet object, the name of the Alfabet object will be used in future. The object name is overwritten in ARIS.
attr XML property
Defines the handling of attributes.
If at least one attr subelement is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
By default, the Description/Definition attribute will be overwritten when exchanging data.
If you map an ARIS object to an Alfabet object, the description of the Alfabet object will be used in future. The Description/Definition attribute is overwritten in ARIS.
aris
API name of the ARIS attribute type. This name is used as identifier for the attribute from the ARIS-ALFABET-mapping.xml file.
By default, the Name (AT_NAME), Description (AT_DESC), Release (AT_REL_3), and Alfabet Link 1 (AT_ALFA_LINK_1) types are used. Of course, you can change the object type attributes to be used, or transfer other attributes. For example, if you do not want to use the Release (AT_REL_3) attribute type for the release (version), adapt both configuration files.
If you have changed the default ARIS object type (OT_APPL_SYS_TYPE) to be imported, make sure that all the attribute types required for Alfabet integration are available for the object type you want to use instead.
<attr aris="AT_REL_3" />
By default, the Release attribute will be overwritten when exchanging data.
If you map an ARIS object to an Alfabet object, the Alfabet property Version will be updated.
<link
attribute="AT_ALFA_LINK_1"
title="AT_ALFA_NAVI1"
defaultvalue="Navigate to Application in Alfabet" >
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
API name for the attribute type of the ARIS link title attribute to be used. By default, the Alfabet Navigation 1 attribute type will be used for storing the link's title text.
This text is entered in the defaultvalue XML property. It is displayed for all languages that are not explicitly specified in the title locale XML property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS - Alfabet synchronization report.
attribute
API name for the attribute type of the ARIS link attribute to be used for navigating to the Alfabet object. By default, the Alfabet Link 1 (AT_ALFA_LINK_1) attribute type will be used for saving the URL to the Alfabet object.
link
Creates ARIS link attributes as a reference between ARIS and Alfabet.
<title locale="1033"
value="Navigate to Application in Alfabet" />
value
Localized title text.
locale
Locale ID (LCID) of the language in which the link title is transferred.
By default, the data is transferred in English (1033). If you have logged into the ARIS database in another language, for example, German, the values are written to the German attributes in English.
</link>
</object>
<dialog-columns alfatype="APPLICATION">
dialog-columns alfatype
Defines the Alfabet table to be available in the Select Alfabet object dialog.
In this example, the APPLICATION Alfabet table is the source. All Alfabet objects of this table 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 table, which is listed in the configuration file. You can use all other properties, for example, Status.
<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&UserType=Named&View=GraphicView:APP_CaptureApplications_Ex"
The value represents the static part of the link. The link will be assembled using this and the User interface URL value that you have specified when you connected the ARIS database to the Alfabet system.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
<sync
table="APPLICATION"
cxnhandling="ignore" > <!-- values for cxnhandling = ignore, create, createAllowForce-->
cxnhandling
Specifies the default connection handling of mapped connections for this table. This setting can be overwritten by specifying cxn subelements.
There are three possible values:
Connections not listed are not imported. This is the default if no cxnhandling attribute is specified.
Connections are created if either the source or the target object of the connection had already existed before the item itself was imported/synchronized.
Connections are created based on the specification in the ARIS-ALFABET-mapping.xml file. If the mapping forces the corresponding target or source object to exist, the connection is imported based on the specification in the ARIS-ALFABET-mapping.xml file.
table
Name of the Alfabet database table that contains the items to be mapped, for example, "APPLICATION".
The table value must be exactly the same as in the ARIS-ALFABET-mapping.xml file.
sync
Each sync element defines one specific Alfabet table to be synchronized. Therefore, each table must be defined in a separate sync element. The Alfabet synchronization can be started manually or via a scheduled report. All objects and relations that are not yet available in ARIS will be imported and linked to the corresponding Alfabet elements. If you do not configure this section, the functionality will not be available in ARIS.
<condition property="ObjectState"
value="Active" />
Value
Value of the specified Alfabet class property to be used for filtering table items.
In this example, the ObjectState property value is Active. The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
condition property
Alfabet class property name, for example, ObjectState.
The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
You enter only one condition property for filtering.
By default, the Name attribute will be overwritten when exchanging data.
If you map an ARIS object to an Alfabet object, the name of the Alfabet object will be used in future. The object name is overwritten in ARIS.
attr XML property
Defines the handling of attributes.
If at least one attr subelement is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
By default, the Description/Definition attribute will be overwritten when exchanging data.
If you map an ARIS object to an Alfabet object, the description of the Alfabet object will be used in future. The Description/Definition attribute is overwritten in ARIS.
aris
API name of the ARIS attribute type. This name is used as identifier for the attribute from the ARIS-ALFABET-mapping.xml file.
By default, the Name (AT_NAME), Description (AT_DESC), Release (AT_REL_3), and Alfabet Link 1 (AT_ALFA_LINK_1) types are used. Of course, you can change the object type attributes to be used, or transfer other attributes. For example, if you do not want to use the Release (AT_REL_3) attribute type for the release (version), adapt both configuration files.
If you have changed the default ARIS object type (OT_APPL_SYS_TYPE) to be imported, make sure that all the attribute types required for Alfabet integration are available for the object type you want to use instead.
<attr aris="AT_REL_3" />
By default, the Release attribute will be overwritten when exchanging data.
If you map an ARIS object to an Alfabet object, the Alfabet property Version will be updated.
<cxn
property="NextVersion"
cxnhandling="createAllowForce" />
cxnhandling
Defines for this table how the mapped connections are to be handled by default. This setting can be overwritten by specifying cxn subelements.
There are three possible values:
The connection is not imported.
Connections are created if either the source or the target object of the connection had already existed before the item itself was imported/synchronized.
Connections are created based on the specification in the ARIS-ALFABET-mapping.xml file. If the mapping forces the corresponding target or source object to exist, the connection is imported based on the specification in the ARIS-ALFABET-mapping.xml file.
This is the default setting if no cxnhandling attribute is specified.
property
Name of the Alfabet property defining this connection. The property must be of the Reference or ReferenceArray type.
For more information, please refer to the Documentation of the Alfabet Meta-Model Alfabet Reference Manual.
cxn
Specifies exactly which of the relations mapped in the ARIS-ALFABET-mapping.xml file are to be imported/synchronized.
<link
attribute="AT_ALFA_LINK_1"
title="AT_ALFA_NAVI1"
defaultvalue="Navigate to Application in Alfabet" >
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
API name for the attribute type of the ARIS link title attribute to be used. By default, the Alfabet Navigation 1 attribute type will be used for storing the link's title text.
This text is entered in the defaultvalue XML property. It is displayed for all languages that are not explicitly specified in the title locale XML property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS - Alfabet synchronization report.
attribute
API name for the attribute type of the ARIS link attribute to be used for navigating to the Alfabet object. By default, the Alfabet Link 1 (AT_ALFA_LINK_1) attribute type will be used for saving the URL to the Alfabet object.
link
Creates ARIS link attributes as a reference between ARIS and Alfabet.
<title locale="1033"
value="Navigate to Application in Alfabet" />
value
Localized title text.
locale
Locale ID (LCID) of the language in which the link title is transferred.
By default, the data is transferred in English (1033). If you have logged into the ARIS database in another language, for example, German, the values are written to the German attributes in English.
</link>
</sync>