Modify configuration of Alfabet REST API v1

The connection between ARIS and Alfabet is established by Alfabet database attributes. The Alfabet REST API v1 interface is configured using two configuration files. Script administrators can adapt the ARIS-ALFABET-integration.xml configuration file.

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.

Alfabet integration is available for objects of the Application system type type by default. If you want to define other ARIS object types, you must create additional <object>…</object> entries. Use the ARIS-ALFABET-mapping.xml configuration file as a guide for entering the attribute types.

Make sure that the defined attribute types are available for each object type.

User settings

Defines the login to Alfabet RESTful API for exchanging data.

<user name="" token="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" accessmode="httpclient"/>

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.

  • If no user name is entered, enter the key for the Alfabet server defined in the Web configuration file for the Alfabet Web application as the token. This means that all users have read and write access to all Alfabet objects.

  • If a user name is entered, enter the key defined for the user entered as the token. This key has been generated in Alfabet Expand. 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.

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.

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.

accessmode

User access mode. The default setting is httpclient.

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

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.

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.

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.

<condition property="ObjectState" value="Active" />

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.

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.

<attr aris="AT_NAME" />

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 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 aris="AT_DESC" />

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.

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.

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

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.

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.

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

value

Localized title text.

</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&amp;UserType=Named&amp;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 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-->

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.

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.

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:

  • ignore

    Connections not listed are not imported. This is the default if no cxnhandling attribute is specified.

  • create

    Connections are created if either the source or the target object of the connection had already existed before the item itself was imported/synchronized.

  • createAllowForce

    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.

<condition property="ObjectState" value="Active" />

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.

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.

<attr aris="AT_NAME" />

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 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 aris="AT_DESC" />

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.

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.

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

cxn

Specifies exactly which of the relations mapped in the ARIS-ALFABET-mapping.xml file are to be imported/synchronized.

  • If at least one cxn subelement is specified, this restricts the list of relations imported into ARIS to the list of cxn elements listed here.

  • If no cxn element is specified, the cxnhandling XML property of the superior element (object or sync) defines whether and how connections defined in the ARIS-ALFABET-mapping.xml file are imported.

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.

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:

  • ignore

    The connection is not imported.

  • create

    Connections are created if either the source or the target object of the connection had already existed before the item itself was imported/synchronized.

  • createAllowForce

    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.

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

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.

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

value

Localized title text.

</link>

</sync>

Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application table. If you want to define other ARIS object types or tables, you must create additional <object>…</object> entries or change the table value. Use the ARIS-ALFABET-mapping.xml configuration file as a guide for entering the attribute types.

Warning

For security reason we recommend to use Alfabet REST API v2.

After a program update all changes made to standard scripts and files are lost. If you adapt a duplicated file, the file will not be affected by the program update. Original XML files are overwritten and updated. After an update you must copy the adapted lines into the new XML file.

ARIS is supplied with numerous standard scripts. We generally recommend documenting all changes to scripts externally so that the documentation can be used to ensure that they are incorporated correctly during the update process.

Reports/Macros/Report templates and files

Do not make any changes to the standard scripts we supply. Always adapt copies of report, macro, and JS files, and any other files. There are exceptions, for example, the file atsall<language code>.js.

When updating ARIS, all ARIS standard scripts and files are overwritten and customer-specific changes to these files are discarded. Copied scripts and files and those you have created yourself are not overwritten.

If you have changed files we supplied but not copied them, before the update (updatesystemdb) they must be exported and then imported after the update. This enables you to retain your adapted standard scripts from the previous version. However, in this case you do not receive any corrections or updates to the files we supplied.

Semantic checks

We recommend creating custom rule types and custom profiles for semantic checks, in which the ARIS standard rule types and rules are referenced.

This is not possible for configurable rule types (relationship attribute rules, model attribute rules, object attribute rules, existence rules, and allocation rules). If you have added rules to these rule types, you must export the rule types before the update and then import them after the update.

Prerequisite

Procedure

  1. In ARIS Architect, click ARIS > Show Administration Administration.

  2. Click the group Evaluations > Reports in the Navigation bar.

  3. Open the IT Architecture category.

  4. Double-click the file ARIS-ALFABET-integration.xml. The file opens in Script Editor.

    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.

    Alfabet integration is available for objects of the Application system type type by default. If you want to define other ARIS object types, you must create additional <object>…</object> entries. Use the ARIS-ALFABET-mapping.xml configuration file as a guide for entering the attribute types.

    Make sure that the defined attribute types are available for each object type.

    User settings

    Defines the login to Alfabet RESTful API for exchanging data.

    <user name="" token="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" accessmode="httpclient"/>

    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.

    • If no user name is entered, enter the key for the Alfabet server defined in the Web configuration file for the Alfabet Web application as the token. This means that all users have read and write access to all Alfabet objects.

    • If a user name is entered, enter the key defined for the user entered as the token. This key has been generated in Alfabet Expand. 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.

    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.

    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.

    accessmode

    User access mode. The default setting is httpclient.

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

    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.

    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.

    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.

    <condition property="ObjectState" value="Active" />

    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.

    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.

    <attr aris="AT_NAME" />

    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 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 aris="AT_DESC" />

    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.

    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.

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

    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.

    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.

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

    value

    Localized title text.

    </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&amp;UserType=Named&amp;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 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-->

    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.

    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.

    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:

    • ignore

      Connections not listed are not imported. This is the default if no cxnhandling attribute is specified.

    • create

      Connections are created if either the source or the target object of the connection had already existed before the item itself was imported/synchronized.

    • createAllowForce

      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.

    <condition property="ObjectState" value="Active" />

    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.

    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.

    <attr aris="AT_NAME" />

    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 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 aris="AT_DESC" />

    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.

    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.

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

    cxn

    Specifies exactly which of the relations mapped in the ARIS-ALFABET-mapping.xml file are to be imported/synchronized.

    • If at least one cxn subelement is specified, this restricts the list of relations imported into ARIS to the list of cxn elements listed here.

    • If no cxn element is specified, the cxnhandling XML property of the superior element (object or sync) defines whether and how connections defined in the ARIS-ALFABET-mapping.xml file are imported.

    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.

    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:

    • ignore

      The connection is not imported.

    • create

      Connections are created if either the source or the target object of the connection had already existed before the item itself was imported/synchronized.

    • createAllowForce

      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.

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

    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.

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

    value

    Localized title text.

    </link>

    </sync>

  5. Click the Administration tab again and open the file ARIS-ALFABET-mapping.xml. It tells you which object types you can insert in the ARIS-ALFABET-integration.xml configuration file.

    This file handles the data transfer between ARIS and Alfabet.The configuration file defines the general mapping for models, connections, and assignments between ARIS and Alfabet objects. The file controls 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 both configuration files.

    Generally, Alfabet tables are mapped to ARIS objects. Alfabet tables are mapped using the table XML property. The import of an entire table or the import/connection of a single Alfabet object is performed using the following import definition.

    Table element

    <table name="VALUENODE" arisgroupname="Values" condition="Stereotype" aristype="OT_FUNC_INST">

    name

    Alfabet table name, for example, VALUENODE.

    arisgroupname

    Name of the ARIS database group.

    If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.

    If arisgroupname is empty or not specified, no subgroup will be created.

    condition

    Defines a conditional mapping based on a property's value. The example above shows a mapping that is based on the Stereotype property. If the value is specified and corresponds to one of the values listed as a value in the condition elements below, it is mapped according to what the condition element defines, and NOT according to what the table element defines.

    aristype

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

    <condition value="Initiative" arisgroupname="Initiatives" aristype="ST_INITIATIVE" />

    condition

    Defines a conditional mapping based on a property's value. The example above shows a mapping that is based on the Stereotype property. If the value is specified and corresponds to one of the values listed as a value in the condition elements below, it is mapped according to what the condition element defines, and NOT according to what the table element defines.

    value

    Property value specifying that this condition is to be applied.

    arisgroupname

    Optionally overwrites the default group name of the <table> 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.

    <condition value="Vision" arisgroupname="Visions" aristype="ST_VISION" />

    <condition value="Business Requirement" arisgroupname="Business Requirements" aristype="ST_REQUIREMENT" />

    <condition value="Architecture Requirement" arisgroupname="Architecture Requirements" aristype="ST_REQUIREMENT" />

    All XML properties

    name

    name

    Alfabet table name, for example, VALUENODE.

    arisgroupname

    arisgroupname

    Name of the ARIS database group.

    If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.

    If arisgroupname is empty or not specified, no subgroup will be created.

    aristype

    aristype

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

    overview-model (optional)

    overview-model

    Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.

    check-master (optional)

    check-master

    Checks for the existence of the provided Alfabet attribute, and searches the ARIS database for an object with this GUID. If available, the ARIS object is identified and used as the master instead of the Alfabet object, for example,

    check-master="ARIS_GUID"

    The attributes and properties of the master object are not overwritten by the import and a master is not removed if theobject has been deleted in Alfabet.

    condition (optional)

    condition

    Defines a conditional mapping based on a property's value. The example above shows a mapping that is based on the Stereotype property. If the value is specified and corresponds to one of the values listed as a value in the condition elements below, it is mapped according to what the condition element defines, and NOT according to what the table element defines.

    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.

    arisgroupname

    arisgroupname

    Optionally overwrites the default group name of the <table> element for items meeting this condition.

    overview-model (optional)

    overview-model

    Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.

    'assign' subelement of a 'table' element

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

    All XML properties

    type

    type

    Creates one assigned model per imported object. Cannot be used as table subelement.

    model

    model

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

    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.

    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.

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

    'attr' subelement

    Maps an Alfabet property value, for example , String, Date, etc. 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 subelement 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 to be checked against the value of the condition XML property for conditional attribute import.

    aris XML property

    API name of the ARIS attribute.

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

    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 to be checked against the value of the condition XML property for conditional attribute import.

    'cxn' subelement

    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.

    For more information, refer to the Documentation of the Alfabet Meta-Model (Alfabet reference manual).

    cxntype

    cxntype

    API name of the ARIS connection type.

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

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

    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/source object of a referenced object to exist in the database. If the value is set to true, the target/source object will be created using the mapping definition of the referenced object. Only if the target/source object exists will a connection be imported. Whether the target object or the source object must exist depends on the value specified in the srctotarge XML property

    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.

    This requires the parent mapping to be set 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 table element.

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

    assigned-model (optional)

    assigned-model

    Creates an occurrence of the target object and the corresponding connection in the assigned model if the table element has an assigned subelement.

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

    'assign' subelement 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 table.

    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.

    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.

    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.

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

    srctotarget

    srctotarget

    Optionally defines the assignment's direction.

    Value true (default value):

    From table element to referenced element.

    Value false:

    From referenced element to table element.

    group

    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.

    'foreignattr' subelement of a 'cxn' element

    Adds attributes from an additional Alfabet table to the imported ARIS item.

    All XML properties

    table

    table

    Name of the additional Alfabet table.

    property

    property

    Name of the property of the additional table that refers to the current table element, for example, Owner.

    In example 3 of the mapping examples, the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.

    Example 1

    This example shows how a table 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 table 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.

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

    </table>

    Example 2

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

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

    ...

    </table>

    Example 3

    In the following example, the foreignattr property, which is a list of attr properties, is accepted. This list defines the attributes to be imported. The example shows the usage of foreign attributes and attribute conditions. Foreign attributes are read from the additional Alfabet table.

    <table name="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">

    <foreignattr table="TIMESTATUS" property="Owner"> <!-- Select * from TIMESTATUS where Owner = '<our AlfabetID>'. Will be written after processing "normal" attr-Elements, so will probably overwrite them -->

    property

    Name of the property of the additional table that refers to the current table element, for example, Owner.

    <attr alfabet="StartDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_START" />

    <attr alfabet="EndDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_END" />

    <attr alfabet="StartDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_START" />

    <attr alfabet="EndDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_END" />

    <attr alfabet="StartDate" condition="Status" value="Production" aris="AT_STANDARD_START" />

    <attr alfabet="EndDate" condition="Status" value="Production" aris="AT_STANDARD_END" />

    <attr alfabet="StartDate" condition="Status" value="Limited Production" aris="" /> <!-- tbd -->

    <attr alfabet="EndDate" condition="Status" value="Limited Production" aris="" />

    <attr alfabet="StartDate" condition="Status" value="Retired - Shut Down" aris="AT_TO_BE_PHASED_OUT_START" />

    <attr alfabet="EndDate" condition="Status" value="Retired - Shut Down" aris="AT_TO_BE_PHASED_OUT_END" />

    </foreignattr>

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

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

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

    ...

    <cxn property="NextVersion" cxntype="CT_IS_PRED_OF" srctotarget="true" forceexist="true" connected-objtype="OT_APPL_SYS_TYPE" overview-model="ST_APPL_SYS_TYPE"/>

    <cxn property="ApplicationGroups" cxntype="CT_BELONGS_TO_CLS" srctotarget="true" forceexist="true" connected-objtype="OT_APPL_SYS_CLS" />

    <cxn property="ICTObject" cxntype="CT_GENERAL" srctotarget="false" forceexist="true" connected-objtype="OT_APPL_SYS_TYPE" overview-model="ST_APPL_SYS_TYPE"/>

    <cxn property="Products" />

    ...

    </table>

    See also

    Mapping examples

    Mapping syntax for tables defining connections only

    Mapping syntax for tables defining models

    Mapping syntax for tables defining process support maps (PSM)

    Mapping syntax for tables defining process support units (PSU)

  6. Click the ARIS-ALFABET-integration.xml tab. The file is displayed for editing.

  7. Add further entries or change entries as required. Use the configuration file ARIS-ALFABET-mapping.xml as a guide.

  8. Save the changes and close the file.

  9. Export the ARIS-ALFABET-integration.xml file to a backup directory. After a program update, you can import the file to restore your modified configuration.

The configuration file is adapted.

If you want to change the standard object type attributes to be used, or transfer different attributes, adapt both configuration files.