Skip to main content

Get help for ARIS

Default Alfabet import configuration

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

XML properties

user
name
token
accessmode

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" >
        <condition property="ObjectState" value="Active" />
        <attr aris="AT_NAME" />
        <attr aris="AT_DESC" />
        <attr aris="AT_REL_3" />
        <link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Application in Alfabet" >
            <title locale="1033" value="Navigate to Application in Alfabet" />
        </link>
    </object>
<dialog-columns alfatype="APPLICATION">
        <column alfabet="Version"/>
        <newlink url="ExternalAccess.aspx?AccessType=ExternalAccess&amp;UserType=Named&amp;View=GraphicView:APP_CaptureApplications_Ex"/>-->
    </dialog-columns>

XML properties

object
aristype
table
condition property
value
attr
aris
AT_NAME
AT_DESC
AT_REL_3
link
attribute
title
defaultvalue
locale
value
dialog-columns alfatype
column alfabet
newlink

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-->
    <condition property="ObjectState" value="Active" />
    <attr aris="AT_NAME" />
    <attr aris="AT_DESC" />
    <attr aris="AT_REL_3" />
    <cxn property="NextVersion" cxnhandling="createAllowForce" />
    <link attribute="AT_ALFA_LINK_1" title="AT_ALFA_NAVI1" defaultvalue="Navigate to Application in Alfabet" >
        <title locale="1033" value="Navigate to Application in Alfabet" />
    </link>
</sync>

XML properties

sync
table
cxnhandling
condition property
value
attr
aris
AT_NAME
AT_DESC
AT_REL_3
cxn
property
cxnhandling
link
attribute
title
defaultvalue
locale
value

Explanation of xml properties

  • condition property

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

    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.

  • aris

    API name of the ARIS attribute type. This name is used as an identifier for the attribute from the Alfabet import configuration. 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), modify 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.

  • AT_NAME

    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.

  • AT_DESC

    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.

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

  • 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

    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

    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.