Alfabet user interface, which you can use to
to Alfabet objects from ARIS. The URL is entered when .You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have
to the Alfabet Web User Interface.ARIS users access Alfabet directly or indirectly. Depending on the action, a different type of authentication is used:
Mapping single Alfabet objects, importing objects in bulk or synchronizing data requires read access via the .
Interface to Alfabet used to exchange data.
Therefore, RESTful API must be activated and ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
as well as in Alfabet. For more information, read the Alfabet reference manual of theAlfabet is an IT planning and portfolio management system. Based on answering the questions, when, where, how, and why to make changes in the IT portfolio, it is used to increase IT investment returns and reduce transformation risks.
When configured, the ARIS - Alfabet Interoperability Interface allows users to .
It is easy to navigate between the systems. For example, from a business process in Alfabet, you can jump to the corresponding function or to a model in ARIS that contains the function. You can jump, for example, from an application system to the related application in Alfabet.
You can do the following
You can map an Alfabet object to an ARIS object. Multiple mapping is not possible. By default, objects of the Application system type type can be mapped to objects of the Alfabet Application table. If you want to use other object types or Alfabet tables, you must adapt the configuration files according to the Alfabet REST API version in use.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
Activate the Contents tab bar.
Click Alfabet >
Map Alfabet object. The Select Alfabet object dialog opens. All Alfabet objects are listed that match the .
ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
Select the Alfabet object class or table, for example, Application. You will see only those Alfabet objects you have the to use. If you start typing the object name into the Filter field, the number of entries will decrease.
Click Refresh, if objects are missing in the list. If an object is not available, you can create it in Alfabet.
Double-click the Alfabet object you want to map to the ARIS object.
The attributes defined in the configuration file are applied to the Alfabet object. For the Application system type type these are the following attributes by default:
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.
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.
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.
The Alfabet object is mapped to the ARIS object. The name of the Alfabet object is now used for the ARIS object. Additional attributes have been entered for this object in the Alfabet attribute type group.
The mapping remains until the object is unmapped. Administrators can delete all mappings at once.
You can create a missing Alfabet object to be mapped to an ARIS object.
Prerequisites
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to an object of the Application system type type.
Activate the Contents tab bar.
Click Alfabet >
Map Alfabet object. The Select Alfabet object dialog opens.
Select the Alfabet table, for example, Application.
Click Create new Alfabet object. The Alfabet login dialog opens.
Create the object in Alfabet.
In ARIS in the Select Alfabet object dialog click Refresh.
The new object is listed in the table.
You can map the new object to an ARIS object.
You can delete the mapping between an ARIS object and an Alfabet object.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object. Unless you have changed the configuration, objects of the Application system type type may be mapped to Alfabet objects.
Activate the Contents tab bar.
Click Alfabet >
Unmap Alfabet object.
The mapping is removed without prompting. All attributes in the Alfabet attribute type group are deleted. The name of the Alfabet object continues to be used for the ARIS object.
Administrators can do the following
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
If Alfabet objects and connections were imported that no longer exist in Alfabet, you can decide how to treat these elements in ARIS. You can either leave them unchanged, delete the mapping, mark them as deleted, or delete the elements from the database.
Procedure
Log into the database.
Click Properties.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
In ARIS Designer, click ARIS > Administration.
In the Start tab bar, click Alfabet > Alfabet synchronization. A warning is displayed.
Warning
Note that the selected synchronization options cannot be undone. We recommend backing up the database before starting the operation.
Click OK.
The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.
Click Yes to review the log file and check which objects have been synchronized.
Click No to close the dialog.
You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.
Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.
ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.
You can import all Alfabet objects to a selected database group.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Procedure
Using the Explorer tab, log in to the database.
Select the database group as a target for all Alfabet objects to be imported.
Activate the Contents tab bar.
Click Import > Import all Alfabet data.
This functionality is also available on the Administration tab (Start tab bar > Alfabet > Import all Alfabet data). A dialog for you to complete the procedure opens.
Click Yes to review the import log file, or click No to close the dialog.
You have successfully imported all
from Alfabet into the selected database group at once (bulk import).ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
You can synchronize data between the ARIS database and the Alfabet system according to the
.ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
Prerequisites
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Objects are mapped.
.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
Procedure
In ARIS Designer, click ARIS > Administration. The Administration tab opens.
Log in to the database and ensure that the database name is selected.
In the Start tab bar, click Alfabet > Alfabet synchronization. A warning is displayed.
Warning
Note that the selected synchronization options cannot be undone. We recommend backing up the database before starting the operation.
Click OK.
The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.
Click Yes to review the log file and check which objects have been synchronized.
Click No to close the dialog.
You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.
Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.
ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.
You can delete all mappings between ARIS objects and Alfabet objects in ARIS Designer. You can optionally delete only the link parameters or the object definitions.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Warning
Note that the selected actions cannot be undone. We recommend backing up the database before starting the operation.
Procedure
In ARIS Designer, click ARIS > Administration. The Administration tab opens.
Log in to the database.
In the Start tab bar, click Alfabet > Delete Alfabet mappings. The dialog opens.
Select Delete mapping if you want to delete only the mappings between ARIS and Alfabet objects. The objects themselves will not be deleted from the database.
Select Delete object if you want to delete the mappings between ARIS objects and Alfabet objects along with the corresponding objects.
Click OK. A dialog opens for you to complete the procedure.
Click Yes to review the import log file, or click No to close the dialog.
All mapping is removed. All attributes in the Alfabet attribute type group are deleted. The names of the Alfabet objects continue to be used for the ARIS objects. If you have enabled the corresponding option, the objects are deleted as well.
This use case shows how to
import all Alfabet objects to ARIS and start Alfabet synchronization. This keeps your database up to date.Scheduled reports are reports that start automatically at a defined point in time.
They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.
For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.
You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.
The Scheduled reports group is displayed if you have the Report automation .
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Scenario
You write two report scripts to be executed by scheduled reports. The first one imports Alfabet objects, the second one starts the synchronization.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have the Report automation for the related database.
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
You are
for this tenant.The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.
superuser
The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.
system
The system user system assumes the of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.
The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Designer) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.
The following administrator roles are defined:
Database administrators
Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.
Database administrators perform the following tasks at the server level:
Create databases
Delete databases
Backup databases
Restore databases using backups
Reorganize databases
Users with defined function privileges can perform additional actions at the database level.
Configuration administrators
A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.
They perform the following tasks:
Define the modeling conventions and adapt the appearance to match the corporate design of the company.
Create filter
Import filters
Export filters and templates
Create templates
Import templates
Create languages
Create font formats
Define the contents of ARIS Method that are available in the database.
Create model types
Derive model types
Derive object symbols
Create attribute type groups
Create attribute types
Create attribute type symbols
Define symbols for an attribute value
Define symbols for alternative attribute values
Change configurable method names in multiple languages
Script administrators
Script administrators require the Script administrator function privilege in ARIS Administration.
Script administrators perform the following tasks:
Write report scripts
Define report scripts (design view)
Delete scripts
Define rules (semantic check)
Define rule types (semantic check)
Define profiles (semantic check)
Define macros
Export scripts
Import scripts
Import script template
Export script template
Transfer custom or modified scripts of previous ARIS versions
Publisher administrators
Publisher administrators require the Publisher administrator function privilege in ARIS Administration.
Publisher administrators perform the following tasks:
Create Publisher export
Update Publisher export
Delete Publisher export
Analysis publisher
Analysis publishers require the function privilege of the same name in ARIS Administration.
Analysis publishers perform the following actions:
Publish queries
Unpublish queries
Publish ad hoc analyses
Unpublish ad hoc analyses
Analysis administrators
Analysis administrators require the function privilege of the same name in ARIS Administration.
Analysis administrators perform the following actions:
Export query
Import query
Export ad hoc analysis
Import ad hoc analysis
Back up analysis and queries
Restore analyses and queries
.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
Procedure
This procedure is part of the use case.
To import Alfabet objects and start the synchronization automatically, write the two report scripts.
Prerequisite
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
You are
for this tenant.The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.
superuser
The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.
system
The system user system assumes the of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.
The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Designer) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.
The following administrator roles are defined:
Database administrators
Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.
Database administrators perform the following tasks at the server level:
Create databases
Delete databases
Backup databases
Restore databases using backups
Reorganize databases
Users with defined function privileges can perform additional actions at the database level.
Configuration administrators
A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.
They perform the following tasks:
Define the modeling conventions and adapt the appearance to match the corporate design of the company.
Create filter
Import filters
Export filters and templates
Create templates
Import templates
Create languages
Create font formats
Define the contents of ARIS Method that are available in the database.
Create model types
Derive model types
Derive object symbols
Create attribute type groups
Create attribute types
Create attribute type symbols
Define symbols for an attribute value
Define symbols for alternative attribute values
Change configurable method names in multiple languages
Script administrators
Script administrators require the Script administrator function privilege in ARIS Administration.
Script administrators perform the following tasks:
Write report scripts
Define report scripts (design view)
Delete scripts
Define rules (semantic check)
Define rule types (semantic check)
Define profiles (semantic check)
Define macros
Export scripts
Import scripts
Import script template
Export script template
Transfer custom or modified scripts of previous ARIS versions
Publisher administrators
Publisher administrators require the Publisher administrator function privilege in ARIS Administration.
Publisher administrators perform the following tasks:
Create Publisher export
Update Publisher export
Delete Publisher export
Analysis publisher
Analysis publishers require the function privilege of the same name in ARIS Administration.
Analysis publishers perform the following actions:
Publish queries
Unpublish queries
Publish ad hoc analyses
Unpublish ad hoc analyses
Analysis administrators
Analysis administrators require the function privilege of the same name in ARIS Administration.
Analysis administrators perform the following actions:
Export query
Import query
Export ad hoc analysis
Import ad hoc analysis
Back up analysis and queries
Restore analyses and queries
Procedure
In ARIS Designer, click ARIS > Administration.
Click Navigation in the bar panel if the Navigation bar is not activated yet.
In the Explorer tree, double-click the Evaluations folder.
Double-click the Reports folder. The report categories are displayed.
Right-click the category to which you want to assign the report script or create a new category.
Click New > Report. The Script Wizard opens.
For the first example specify the Name and Description in the required languages, for example, the name Import all Alfabet objects and the description Imports all objects from Alfabet as defined in the interface configuration into selected database groups.
Deactivate the Opens dialogs check box.
Click Next.
Select the Group as context for the report to be started, and click Next.
Deactivate the Generate output file check box and navigate to the Restrict access page.
Restrict the access for the report to be executed.
Click Finish. Script Editor opens.
Write the code, for example:
var alfaIntegration = Context.getComponent("AlfabetIntegration");
var result = alfaIntegration.doImport(ArisData.getSelectedGroups()[0], null)
Save the script and write the second report, for example, Synchronize Alfabet objects.
This report will synchronize already imported Alfabet objects.
Select Database as context for the report to be started.
Use this code as example:
var alfaIntegration = Context.getComponent("AlfabetIntegration");
var result = alfaIntegration.doSynchronize(ArisData.getActiveDatabase(), 3);
Now you have two reports that will be started by scheduled reports.
This procedure is part of the use case.
To import Alfabet assets and start the synchronization automatically ,create two scheduled reports for your two reports to be execute
.Scheduled reports are reports that start automatically at a defined point in time.
They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.
For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.
You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.
The Scheduled reports group is displayed if you have the Report automation .
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Prerequisite
You have the Report automation for the related database.
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Procedure
Click ARIS > Administration or ARIS > Explorer. The Administration or Explorer tab opens.
Log in to the database.
Click Navigation in the bar panel if the Navigation bar is not activated yet.
In the Explorer tree, click the folder Scheduled reports.
To create a schedule, click New >
Create scheduled report. The Report Automation Wizard opens.
Specify the name of the first schedule, e. g, Import Alfabet assets daily.
Specify the password of the current user, and click Next.
Select the Import all Alfabet assets report that you have created earlier, and click Next.
Select the database group for the Alfabet assets to be saved in, and click Next.
Specify when and how often the report should be executed, and click Finish.
Create the second schedule for the Synchronize Alfabet assets report to be executed. The steps to be carried out are similar. In this case, select the database as start context.
The reports will be executed as defined. If the first execution is in the future, the report is automatically active and runs as soon as the defined point in time is reached.
Back to the use case
You can configure ARIS - Alfabet Interoperability Interface in ARIS if you have access to ARIS Enterprise - Server or ARIS Enterprise - Enterprise Server and you have the Configuration administrator function privilege.
To manage Alfabet configurations, in ARIS, click Application launcher >
Administration > Conventions > Alfabet import.
You can do the following:
Alfabet configuration
To prevent Alfabet configurations from being overwritten by ARIS updates, you can no longer modify the related XML files in ARIS Designer or edit the Default configuration in ARIS. To modify the configuration, you must duplicate the Default Alfabet configuration or an already modified configuration and adapt the contained Alfabet import configuration. The Default configuration is overwritten with each ARIS update to provide you with the latest features.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. The Default configuration always contains the latest features.
Click Duplicate.
The configuration is duplicated.
You can change and activate the configuration as required.
Alfabet configuration
Import an Alfabet configuration that you have exported earlier to be used on the current tenant.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Import. If you are re-importing this Alfabet configuration, a confirmation dialog is displayed,
even if you have changed the file name, where you can confirm overwriting the existing
Alfabet configuration.
The configuration is imported.
You can change and activate the configuration as required.
of an Alfabet configuration
You can edit the name and description in multiple languages.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Display details.
Select the language.
Enter the name and description (optional).
Click Save.
The changes details are displayed.
Edit the name and description in all required languages in turn.
The connection between ARIS and Alfabet is established by ARIS database attributes. The Alfabet RESTful API interface is configured in ARIS using the Alfabet configuration and related reports available in Alfabet. The Alfabet import configuration is contained in the Default Alfabet configuration. The Default configuration is overwritten with each ARIS update to provide you with the latest features. To prevent your modified Alfabet configuration from being overwritten by ARIS updates, you can no longer modify the related XML files in ARIS Designer or edit the Default configuration. To modify the configuration, you must duplicate the Default Alfabet configuration and modify the Alfabet import configuration in your copy.
The Alfabet import configuration defines the general mapping for models, connections, and assignments. It handles the data transfer between ARIS and Alfabet using Alfabet RESTful API version 2.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class.
If you want to define other ARIS object types or Alfabet object classes, you must modify the Alfabet configuration and adapt the related reports that are used in the Alfabet system to transfer the defined data to ARIS.
Prerequisite
Make sure that the defined attribute types are available for each object type.
Alfabet RESTful API version 2 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The Alfabet import configuration is displayed.
Adapt the configuration as required. Tags are explained in these examples.
Click Save configuration.
The configuration is adapted.
You must activate the Alfabet configuration to be used. You can modify the Select Alfabet object dialog available for users. Make sure to . All elements in both the reports and the Alfabet configuration must correspond to each other.
Alfabet reports supporting the default configuration are shipped with Alfabet releases 10.5p2 and later. You can adapt these reports in Alfabet or define your own reports. If you did so, make sure to adapt your Alfabet configuration accordingly.
The reports reduce the amount of data transferred from Alfabet to ARIS. The reports make a set of used properties available 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 lifecycle attributes of an Application system type object.
At least the following properties must be returned by reports:
all mapped properties
all properties used as a condition for ARIS type determination
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.
Further information on the interface and on how to configure the data exchange is available in the related manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You can create an Alfabet configuration from scratch. If you do so, you must write the entire configuration by yourself. To save time, you can duplicate the Default configuration instead and modify the configuration as required.
Prerequisite
In ARIS Designer, you have
the database with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Make sure that the defined attribute types are available for each object type.
Alfabet RESTful API v2 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click Create import configuration. If the insecure API version 1 was activated, make sure to write the Alfabet import configuration on the API version 2 tab. Tags are explained in these examples.
Click Save configuration.
The configuration file is saved.
You must activate the Alfabet configuration to be used. You can modify the Select Alfabet object dialog available for users.
an Alfabet configuration
To make an Alfabet configuration to be used on a tenant, you must activate the required configuration.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. The Default configuration always contains the latest features but will be overwrittten with each
ARIS update.
Click Activate.
The configuration is used for actions performed by the ARIS - Alfabet Interoperability Interface.
an Alfabet configuration
Export an Alfabet configuration that you can import to another tenant.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Export.
The configuration is exported.
an Alfabet configuration
You can delete Alfabet configurations that you no longer require. To be on the save side, you can export Alfabet configurations before you delete them.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. You cannot delete the Default configuration or the active configuration.
Click Delete.
The configuration is deleted.
The URL for the interface is entered when mapping the ARIS database to Alfabet. Users require
in Alfabet.If you still use Alfabet REST API version 1, the login specified in the Alfabet import configuration is used for authentication. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database. The access permissions of the configured login therefore define which Alfabet objects the ARIS users with access to the actions can see.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Warning
When accessing the Alfabet RESTful API, the login data is transferred with the HTTP header. Therefore, you must ensure that the transfer is encrypted.
To Alfabet Web User Interface. Users must log in to Alfabet themselves.
, users require read access in theTo create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.ARIS users access Alfabet directly or indirectly. Depending on the action, a different type of authentication is used:
Mapping single Alfabet objects, importing objects in bulk or synchronizing data requires read access via the .
Interface to Alfabet used to exchange data.
Therefore, RESTful API must be activated and ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
as well as in Alfabet. For more information, read the Alfabet reference manual of theAlfabet is an IT planning and portfolio management system. Based on answering the questions, when, where, how, and why to make changes in the IT portfolio, it is used to increase IT investment returns and reduce transformation risks.
When configured, the ARIS - Alfabet Interoperability Interface allows users to .
It is easy to navigate between the systems. For example, from a business process in Alfabet, you can jump to the corresponding function or to a model in ARIS that contains the function. You can jump, for example, from an application system to the related application in Alfabet.
You can do the following
You can map an Alfabet object to an ARIS object. Multiple mapping is not possible. By default, objects of the Application system type type can be mapped to objects of the Alfabet Application table. If you want to use other object types or Alfabet tables, you must adapt the configuration files according to the Alfabet REST API version in use.
Prerequisite
The database is
with Alfabet.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
Activate the Contents tab bar.
Click Alfabet >
Map Alfabet object. The Select Alfabet object dialog opens. All Alfabet objects are listed that match the .
ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be 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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 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.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
Select the Alfabet object class or table, for example, Application. You will see only those Alfabet objects you have the to use. If you start typing the object name into the Filter field, the number of entries will decrease.
Click Refresh, if objects are missing in the list. If an object is not available, you can create it in Alfabet.
Double-click the Alfabet object you want to map to the ARIS object.
The attributes defined in the configuration file are applied to the Alfabet object. For the Application system type type these are the following attributes by default:
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.
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.
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.
The Alfabet object is mapped to the ARIS object. The name of the Alfabet object is now used for the ARIS object. Additional attributes have been entered for this object in the Alfabet attribute type group.
The mapping remains until the object is unmapped. Administrators can delete all mappings at once.
You can create a missing Alfabet object to be mapped to an ARIS object.
Prerequisites
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to an object of the Application system type type.
Activate the Contents tab bar.
Click Alfabet >
Map Alfabet object. The Select Alfabet object dialog opens.
Select the Alfabet table, for example, Application.
Click Create new Alfabet object. The Alfabet login dialog opens.
Create the object in Alfabet.
In ARIS in the Select Alfabet object dialog click Refresh.
The new object is listed in the table.
You can map the new object to an ARIS object.
You can delete the mapping between an ARIS object and an Alfabet object.
Prerequisite
The database is
with Alfabet.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object. Unless you have changed the configuration, objects of the Application system type type may be mapped to Alfabet objects.
Activate the Contents tab bar.
Click Alfabet >
Unmap Alfabet object.
The mapping is removed without prompting. All attributes in the Alfabet attribute type group are deleted. The name of the Alfabet object continues to be used for the ARIS object.
Administrators can do the following
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
If Alfabet objects and connections were imported that no longer exist in Alfabet, you can decide how to treat these elements in ARIS. You can either leave them unchanged, delete the mapping, mark them as deleted, or delete the elements from the database.
Procedure
Log into the database.
Click Properties.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
In ARIS Designer, click ARIS > Administration.
In the Start tab bar, click Alfabet > Alfabet synchronization. A warning is displayed.
Warning
Note that the selected synchronization options cannot be undone. We recommend backing up the database before starting the operation.
Click OK.
The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.
Click Yes to review the log file and check which objects have been synchronized.
Click No to close the dialog.
You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.
Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.
ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.
You can import all Alfabet objects to a selected database group.
Prerequisite
The database is
with Alfabet.Procedure
Using the Explorer tab, log in to the database.
Select the database group as a target for all Alfabet objects to be imported.
Activate the Contents tab bar.
Click Import > Import all Alfabet data.
This functionality is also available on the Administration tab (Start tab bar > Alfabet > Import all Alfabet data). A dialog for you to complete the procedure opens.
Click Yes to review the import log file, or click No to close the dialog.
You have successfully imported all
from Alfabet into the selected database group at once (bulk import).ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be 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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 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.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
You can synchronize data between the ARIS database and the Alfabet system according to the
.ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be 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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 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.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
Prerequisites
The database is
with Alfabet.Objects are mapped.
.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
Procedure
In ARIS Designer, click ARIS > Administration. The Administration tab opens.
Log in to the database and ensure that the database name is selected.
In the Start tab bar, click Alfabet > Alfabet synchronization. A warning is displayed.
Warning
Note that the selected synchronization options cannot be undone. We recommend backing up the database before starting the operation.
Click OK.
The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.
Click Yes to review the log file and check which objects have been synchronized.
Click No to close the dialog.
You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.
Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.
ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.
You can delete all mappings between ARIS objects and Alfabet objects in ARIS Designer. You can optionally delete only the link parameters or the object definitions.
Prerequisite
The database is
with Alfabet.You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Warning
Note that the selected actions cannot be undone. We recommend backing up the database before starting the operation.
Procedure
In ARIS Designer, click ARIS > Administration. The Administration tab opens.
Log in to the database.
In the Start tab bar, click Alfabet > Delete Alfabet mappings. The dialog opens.
Select Delete mapping if you want to delete only the mappings between ARIS and Alfabet objects. The objects themselves will not be deleted from the database.
Select Delete object if you want to delete the mappings between ARIS objects and Alfabet objects along with the corresponding objects.
Click OK. A dialog opens for you to complete the procedure.
Click Yes to review the import log file, or click No to close the dialog.
All mapping is removed. All attributes in the Alfabet attribute type group are deleted. The names of the Alfabet objects continue to be used for the ARIS objects. If you have enabled the corresponding option, the objects are deleted as well.
This use case shows how to
import all Alfabet objects to ARIS and start Alfabet synchronization. This keeps your database up to date.Scheduled reports are reports that start automatically at a defined point in time.
They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.
For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.
You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.
The Scheduled reports group is displayed if you have the Report automation .
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Scenario
You write two report scripts to be executed by scheduled reports. The first one imports Alfabet objects, the second one starts the synchronization.
Prerequisite
The database is
with Alfabet.You have the Report automation for the related database.
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
You are
for this tenant.The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.
superuser
The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.
system
The system user system assumes the of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.
The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Designer) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.
The following administrator roles are defined:
Database administrators
Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.
Database administrators perform the following tasks at the server level:
Create databases
Delete databases
Backup databases
Restore databases using backups
Reorganize databases
Users with defined function privileges can perform additional actions at the database level.
Configuration administrators
A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.
They perform the following tasks:
Define the modeling conventions and adapt the appearance to match the corporate design of the company.
Create filter
Import filters
Export filters and templates
Create templates
Import templates
Create languages
Create font formats
Define the contents of ARIS Method that are available in the database.
Create model types
Derive model types
Derive object symbols
Create attribute type groups
Create attribute types
Create attribute type symbols
Define symbols for an attribute value
Define symbols for alternative attribute values
Change configurable method names in multiple languages
Script administrators
Script administrators require the Script administrator function privilege in ARIS Administration.
Script administrators perform the following tasks:
Write report scripts
Define report scripts (design view)
Delete scripts
Define rules (semantic check)
Define rule types (semantic check)
Define profiles (semantic check)
Define macros
Export scripts
Import scripts
Import script template
Export script template
Transfer custom or modified scripts of previous ARIS versions
Publisher administrators
Publisher administrators require the Publisher administrator function privilege in ARIS Administration.
Publisher administrators perform the following tasks:
Create Publisher export
Update Publisher export
Delete Publisher export
Analysis publisher
Analysis publishers require the function privilege of the same name in ARIS Administration.
Analysis publishers perform the following actions:
Publish queries
Unpublish queries
Publish ad hoc analyses
Unpublish ad hoc analyses
Analysis administrators
Analysis administrators require the function privilege of the same name in ARIS Administration.
Analysis administrators perform the following actions:
Export query
Import query
Export ad hoc analysis
Import ad hoc analysis
Back up analysis and queries
Restore analyses and queries
.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
Procedure
This procedure is part of the use case.
To import Alfabet objects and start the synchronization automatically, write the two report scripts.
Prerequisite
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
You are
for this tenant.The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.
superuser
The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.
system
The system user system assumes the of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.
The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Designer) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.
The following administrator roles are defined:
Database administrators
Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.
Database administrators perform the following tasks at the server level:
Create databases
Delete databases
Backup databases
Restore databases using backups
Reorganize databases
Users with defined function privileges can perform additional actions at the database level.
Configuration administrators
A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.
They perform the following tasks:
Define the modeling conventions and adapt the appearance to match the corporate design of the company.
Create filter
Import filters
Export filters and templates
Create templates
Import templates
Create languages
Create font formats
Define the contents of ARIS Method that are available in the database.
Create model types
Derive model types
Derive object symbols
Create attribute type groups
Create attribute types
Create attribute type symbols
Define symbols for an attribute value
Define symbols for alternative attribute values
Change configurable method names in multiple languages
Script administrators
Script administrators require the Script administrator function privilege in ARIS Administration.
Script administrators perform the following tasks:
Write report scripts
Define report scripts (design view)
Delete scripts
Define rules (semantic check)
Define rule types (semantic check)
Define profiles (semantic check)
Define macros
Export scripts
Import scripts
Import script template
Export script template
Transfer custom or modified scripts of previous ARIS versions
Publisher administrators
Publisher administrators require the Publisher administrator function privilege in ARIS Administration.
Publisher administrators perform the following tasks:
Create Publisher export
Update Publisher export
Delete Publisher export
Analysis publisher
Analysis publishers require the function privilege of the same name in ARIS Administration.
Analysis publishers perform the following actions:
Publish queries
Unpublish queries
Publish ad hoc analyses
Unpublish ad hoc analyses
Analysis administrators
Analysis administrators require the function privilege of the same name in ARIS Administration.
Analysis administrators perform the following actions:
Export query
Import query
Export ad hoc analysis
Import ad hoc analysis
Back up analysis and queries
Restore analyses and queries
Procedure
In ARIS Designer, click ARIS > Administration.
Click Navigation in the bar panel if the Navigation bar is not activated yet.
In the Explorer tree, double-click the Evaluations folder.
Double-click the Reports folder. The report categories are displayed.
Right-click the category to which you want to assign the report script or create a new category.
Click New > Report. The Script Wizard opens.
For the first example specify the Name and Description in the required languages, for example, the name Import all Alfabet objects and the description Imports all objects from Alfabet as defined in the interface configuration into selected database groups.
Deactivate the Opens dialogs check box.
Click Next.
Select the Group as context for the report to be started, and click Next.
Deactivate the Generate output file check box and navigate to the Restrict access page.
Restrict the access for the report to be executed.
Click Finish. Script Editor opens.
Write the code, for example:
var alfaIntegration = Context.getComponent("AlfabetIntegration");
var result = alfaIntegration.doImport(ArisData.getSelectedGroups()[0], null)
Save the script and write the second report, for example, Synchronize Alfabet objects.
This report will synchronize already imported Alfabet objects.
Select Database as context for the report to be started.
Use this code as example:
var alfaIntegration = Context.getComponent("AlfabetIntegration");
var result = alfaIntegration.doSynchronize(ArisData.getActiveDatabase(), 3);
Now you have two reports that will be started by scheduled reports.
This procedure is part of the use case.
To import Alfabet assets and start the synchronization automatically ,create two scheduled reports for your two reports to be execute
.Scheduled reports are reports that start automatically at a defined point in time.
They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.
For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.
You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.
The Scheduled reports group is displayed if you have the Report automation .
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Prerequisite
You have the Report automation for the related database.
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Procedure
Click ARIS > Administration or ARIS > Explorer. The Administration or Explorer tab opens.
Log in to the database.
Click Navigation in the bar panel if the Navigation bar is not activated yet.
In the Explorer tree, click the folder Scheduled reports.
To create a schedule, click New >
Create scheduled report. The Report Automation Wizard opens.
Specify the name of the first schedule, e. g, Import Alfabet assets daily.
Specify the password of the current user, and click Next.
Select the Import all Alfabet assets report that you have created earlier, and click Next.
Select the database group for the Alfabet assets to be saved in, and click Next.
Specify when and how often the report should be executed, and click Finish.
Create the second schedule for the Synchronize Alfabet assets report to be executed. The steps to be carried out are similar. In this case, select the database as start context.
The reports will be executed as defined. If the first execution is in the future, the report is automatically active and runs as soon as the defined point in time is reached.
Back to the use case
You can configure ARIS - Alfabet Interoperability Interface in ARIS if you have access to ARIS Enterprise - Server or ARIS Enterprise - Enterprise Server and you have the Configuration administrator function privilege.
To manage Alfabet configurations, in ARIS, click Application launcher >
Administration > Conventions > Alfabet import.
You can do the following:
Alfabet configuration
To prevent Alfabet configurations from being overwritten by ARIS updates, you can no longer modify the related XML files in ARIS Designer or edit the Default configuration in ARIS. To modify the configuration, you must duplicate the Default Alfabet configuration or an already modified configuration and adapt the contained Alfabet import configuration. The Default configuration is overwritten with each ARIS update to provide you with the latest features.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. The Default configuration always contains the latest features.
Click Duplicate.
The configuration is duplicated.
You can change and activate the configuration as required.
Alfabet configuration
Import an Alfabet configuration that you have exported earlier to be used on the current tenant.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Import. If you are re-importing this Alfabet configuration, a confirmation dialog is displayed,
even if you have changed the file name, where you can confirm overwriting the existing
Alfabet configuration.
The configuration is imported.
You can change and activate the configuration as required.
of an Alfabet configuration
You can edit the name and description in multiple languages.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Display details.
Select the language.
Enter the name and description (optional).
Click Save.
The changes details are displayed.
Edit the name and description in all required languages in turn.
The connection between ARIS and Alfabet is established by ARIS database attributes. The Alfabet RESTful API interface is configured in ARIS using the Alfabet configuration and related reports available in Alfabet. The Alfabet import configuration is contained in the Default Alfabet configuration. The Default configuration is overwritten with each ARIS update to provide you with the latest features. To prevent your modified Alfabet configuration from being overwritten by ARIS updates, you can no longer modify the related XML files in ARIS Designer or edit the Default configuration. To modify the configuration, you must duplicate the Default Alfabet configuration and modify the Alfabet import configuration in your copy.
The Alfabet import configuration defines the general mapping for models, connections, and assignments. It handles the data transfer between ARIS and Alfabet using Alfabet RESTful API version 2.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class.
If you want to define other ARIS object types or Alfabet object classes, you must modify the Alfabet configuration and adapt the related reports that are used in the Alfabet system to transfer the defined data to ARIS.
Prerequisite
Make sure that the defined attribute types are available for each object type.
Alfabet RESTful API version 2 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The Alfabet import configuration is displayed.
Adapt the configuration as required. Tags are explained in these examples.
Click Save configuration.
The configuration is adapted.
You must activate the Alfabet configuration to be used. You can modify the Select Alfabet object dialog available for users. Make sure to . All elements in both the reports and the Alfabet configuration must correspond to each other.
Alfabet reports supporting the default configuration are shipped with Alfabet releases 10.5p2 and later. You can adapt these reports in Alfabet or define your own reports. If you did so, make sure to adapt your Alfabet configuration accordingly.
The reports reduce the amount of data transferred from Alfabet to ARIS. The reports make a set of used properties available 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 lifecycle attributes of an Application system type object.
At least the following properties must be returned by reports:
all mapped properties
all properties used as a condition for ARIS type determination
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.
Further information on the interface and on how to configure the data exchange is available in the related manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You can create an Alfabet configuration from scratch. If you do so, you must write the entire configuration by yourself. To save time, you can duplicate the Default configuration instead and modify the configuration as required.
Prerequisite
In ARIS Designer, you have
the database with Alfabet.Make sure that the defined attribute types are available for each object type.
Alfabet RESTful API v2 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click Create import configuration. If the insecure API version 1 was activated, make sure to write the Alfabet import configuration on the API version 2 tab. Tags are explained in these examples.
Click Save configuration.
The configuration file is saved.
You must activate the Alfabet configuration to be used. You can modify the Select Alfabet object dialog available for users.
an Alfabet configuration
To make an Alfabet configuration to be used on a tenant, you must activate the required configuration.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. The Default configuration always contains the latest features but will be overwrittten with each
ARIS update.
Click Activate.
The configuration is used for actions performed by the ARIS - Alfabet Interoperability Interface.
an Alfabet configuration
Export an Alfabet configuration that you can import to another tenant.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Export.
The configuration is exported.
an Alfabet configuration
You can delete Alfabet configurations that you no longer require. To be on the save side, you can export Alfabet configurations before you delete them.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. You cannot delete the Default configuration or the active configuration.
Click Delete.
The configuration is deleted.
The URL for the interface is entered when mapping the ARIS database to Alfabet. Users require
in Alfabet.If you still use Alfabet REST API version 1, the login specified in the Alfabet import configuration is used for authentication. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database. The access permissions of the configured login therefore define which Alfabet objects the ARIS users with access to the actions can see.
Warning
When accessing the Alfabet RESTful API, the login data is transferred with the HTTP header. Therefore, you must ensure that the transfer is encrypted.
To Alfabet Web User Interface. Users must log in to Alfabet themselves.
, users require read access in theTo create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Users require
.ARIS users access Alfabet directly or indirectly. Depending on the action, a different type of authentication is used:
Mapping single Alfabet objects, importing objects in bulk or synchronizing data requires read access via the .
Interface to Alfabet used to exchange data.
Therefore, RESTful API must be activated and ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
as well as in Alfabet. For more information, read the Alfabet reference manual of theAlfabet is an IT planning and portfolio management system. Based on answering the questions, when, where, how, and why to make changes in the IT portfolio, it is used to increase IT investment returns and reduce transformation risks.
When configured, the ARIS - Alfabet Interoperability Interface allows users to .
It is easy to navigate between the systems. For example, from a business process in Alfabet, you can jump to the corresponding function or to a model in ARIS that contains the function. You can jump, for example, from an application system to the related application in Alfabet.
You can do the following
You can map an Alfabet object to an ARIS object. Multiple mapping is not possible. By default, objects of the Application system type type can be mapped to objects of the Alfabet Application table. If you want to use other object types or Alfabet tables, you must adapt the configuration files according to the Alfabet REST API version in use.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
Activate the Contents tab bar.
Click Alfabet >
Map Alfabet object. The Select Alfabet object dialog opens. All Alfabet objects are listed that match the .
ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
Select the Alfabet object class or table, for example, Application. You will see only those Alfabet objects you have the to use. If you start typing the object name into the Filter field, the number of entries will decrease.
Click Refresh, if objects are missing in the list. If an object is not available, you can create it in Alfabet.
Double-click the Alfabet object you want to map to the ARIS object.
The attributes defined in the configuration file are applied to the Alfabet object. For the Application system type type these are the following attributes by default:
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.
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.
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.
The Alfabet object is mapped to the ARIS object. The name of the Alfabet object is now used for the ARIS object. Additional attributes have been entered for this object in the Alfabet attribute type group.
The mapping remains until the object is unmapped. Administrators can delete all mappings at once.
You can create a missing Alfabet object to be mapped to an ARIS object.
Prerequisites
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to an object of the Application system type type.
Activate the Contents tab bar.
Click Alfabet >
Map Alfabet object. The Select Alfabet object dialog opens.
Select the Alfabet table, for example, Application.
Click Create new Alfabet object. The Alfabet login dialog opens.
Create the object in Alfabet.
In ARIS in the Select Alfabet object dialog click Refresh.
The new object is listed in the table.
You can map the new object to an ARIS object.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
You can delete the mapping between an ARIS object and an Alfabet object.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object. Unless you have changed the configuration, objects of the Application system type type may be mapped to Alfabet objects.
Activate the Contents tab bar.
Click Alfabet >
Unmap Alfabet object.
The mapping is removed without prompting. All attributes in the Alfabet attribute type group are deleted. The name of the Alfabet object continues to be used for the ARIS object.
Administrators can do the following
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
If Alfabet objects and connections were imported that no longer exist in Alfabet, you can decide how to treat these elements in ARIS. You can either leave them unchanged, delete the mapping, mark them as deleted, or delete the elements from the database.
Procedure
Log into the database.
Click Properties.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
In ARIS Designer, click ARIS > Administration.
In the Start tab bar, click Alfabet > Alfabet synchronization. A warning is displayed.
Warning
Note that the selected synchronization options cannot be undone. We recommend backing up the database before starting the operation.
Click OK.
The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.
Click Yes to review the log file and check which objects have been synchronized.
Click No to close the dialog.
You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.
Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.
ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.
You can import all Alfabet objects to a selected database group.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Procedure
Using the Explorer tab, log in to the database.
Select the database group as a target for all Alfabet objects to be imported.
Activate the Contents tab bar.
Click Import > Import all Alfabet data.
This functionality is also available on the Administration tab (Start tab bar > Alfabet > Import all Alfabet data). A dialog for you to complete the procedure opens.
Click Yes to review the import log file, or click No to close the dialog.
You have successfully imported all
from Alfabet into the selected database group at once (bulk import).ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
You can synchronize data between the ARIS database and the Alfabet system according to the
.ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.
To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must modify the configuration according to the Alfabet RESTful API in use.
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Configure Alfabet REST API v2
If you still use the insecure Alfabet RESTful API version 1 that is no longer recommended, you can activate and modify the outdated version.
Alfabet RESTful API version 1 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 Mapping definition as a guide for entering the attribute types.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure configuration is displayed on the API version 1 tab.
Adapt the configuration as required. Tags are explained in these
.For information on how to use the XML tags, see the listed descriptions and examples and the commented lines of the Alfabet import configuration. To avoid redundancy, the tags are usually linked only the first time they are used.
The 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 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 ="VALUENODE" ="Values" ="Stereotype" ="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. 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
API name of an object type, a model type, or a symbol type.
<
="Initiative" ="Initiatives" ="ST_INITIATIVE" />condition
Defines a conditional mapping based on a property's value. 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
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.
aristype
API name of an object type, a model type, or a symbol type.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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
Optionally overwrites the default group name of the <table> element for items meeting this condition.
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
Creates one assigned model per imported object. Cannot be used as table subelement.
model
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
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.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value 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 XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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
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/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
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
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
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
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 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
API name for the model type of the ARIS model to be assigned, for example, MT_APPL_SYS_TYPE_DGM.
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
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.
Required only if the add-parent attribute is set to true.
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 (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
Name of the additional Alfabet table.
property
Name of the property of the additional table that refers to the current table element, for example, Owner.
In example 3 of the foreignattr element, which is a list of attr elements, is accepted. This list defines the attributes to be imported.
, theExample 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" ="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>
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 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
to for exchanging data.< ="" ="T66JADHPYTWW3A7U2ACUFYUZZU7BPCFL" ="httpclient"/>
user
Controls the login to Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
for exchanging data. The user name, token, and access mode must be specified.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
You can find further information about the token and authorization in the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
. 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.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
token
User token. This value depends on the user name. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
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 -->
< ="OT_APPL_SYS_TYPE" ="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
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 Mapping definition.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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>
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
< ="APPLICATION" ="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 Mapping definition.
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.
<
="ObjectState" ="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.
<
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 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
API name of the ARIS attribute type. This name is used as 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), 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="
" />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.
<
="NextVersion" ="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.
<
="AT_ALFA_LINK_1" ="AT_ALFA_NAVI1" ="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
="1033" ="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 tables, for example, BUSINESSSUPPORT, to be imported as process support units (PSU) are mapped using the psutable XML property.
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 subelements. 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.
< ="BUSINESSSUPPORT" ="Business support" ="OT_PROCESS_SUPPORT_UNIT">
psutable XML property
Each psutable element defines one specific Alfabet table to be imported as process support map (PSM). Thus, each table must be defined in a separate psutable element.
name
Name of the Alfabet table to be imported as process support unit (PSU), for example, BUSINESSSUPPORT.
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.
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-->
<
="CREATION_USER" ="AT_CREATOR" />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.
<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 XML property
The cxn XML properties along with their attr subelements define the relationship between the related objects.
In this example the property XML property of the value object, in combination with the cxntype XML property of the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property of 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>
The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
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. -->
</psutable>
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
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 subelement.
<table name="BUSINESSPROCESSMODEL" arisgroupname="Business processes" aristype="MT_VAL_ADD_CHN_DGM" cxntypes="CT_IS_PRCS_ORNT_SUPER" isgroup="true">
<items table="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 -->
</table>
Table element
The use of this element is the same as described here. However, the overview-model XML property cannot be used in this context.
XML properties
name
Alfabet table name, for example, VALUENODE.
aristype
API name of an ARIS model type.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup to be created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the provided Alfabet property, such as ARIS_GUID, maintained for an Alfabe 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
Defines a conditional mapping based on a property's value. 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.
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.
'attr' subelement
Maps an Alfabet property value, for example , String, Date, etc. Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="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.
<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 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.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value to be checked against the value of the condition XML property for conditional attribute import.
'items' subelement of a table element
XML properties
table
Table 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 table to find these objects. This can be a list of item elements if the model references to more than one table.
property
Property name.
If the 'table' property is used: property of the table containing the connection to the model.
Otherwise: property of the element which contains the model items.
symbol
API name for the symbol type of the ARIS object used in the assigned model, for example, ST_VAL_ADD_CHN_SML_2.
A pure connection table can be recognized by the fact that no property ID is defined in it.
table element
XML properties
Only name and aristype are valid attributes.
name
Alfabet table name, for example, VALUENODE.
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.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a subelement.
'assign' subelement of a table element
Creates an assignment for all connections that are imported from this table. This can be performed only if the target reference is a model.
XML properties
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.
Required only if the add-parent attribute is set to true.
'attr' subelement
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 subelement).
'cxn' subelement
Defines the properties to contain the source and the target of the connection.
property XML property
Name of the Alfabet property. The property must be of the Reference or ReferenceArray type.
Refer to 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 from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
role
Defines the role of the object referenced by the property.
Possible values are: source or target.
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.
Example
<table 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 -->
</table>
<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>
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="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>
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="APPLICATION" arisgroupname="Application" aristype="OT_APPL_SYS_TYPE" isgroup="false" overview-model="MT_APPL_SYS_TYPE_DGM,ST_APPL_SYS_TYPE">
<foreignattr table="TIMESTATUS" ="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>
In this 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.
Click Save configuration.
The configuration file is adapted.
You must activate the Alfabet configuration to be used. You can the Select Alfabet object dialog available for users.
Define the dialog content that you want to show users when they are mapping ARIS and Alfabet objects.
Prerequisite
Alfabet RESTful API v1 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The insecure Alfabet RESTful API v1 is on this tenant.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2.
Prerequisites
ARIS Server Administrator is installed.
You know the credentials of the superuser, or you have the Server administrator function privilege.
Click Start > Programs > ARIS > Administration > ARIS Server Administrator 10.0 if you accepted the program group suggested by the installation program. Under a Linux operating system, execute the arisadm.sh shell script instead. To do so, enter: su -c arisadm.sh aris10. The command prompt opens and ARIS Server Administrator is launched in interactive mode.
Establish a connection to the ARIS Server and tenant:
Syntax: server <ARIS Server name>:<port number> <tenant> <user name> <password>
Example: server arissrv:1080 default system manager or server arissrv:443 default system manager -ssl
To activate the insecure version for the current tenant, enter set abs.alfabet.v1config.visible "true"
The secure version is no longer in use but available on the API version 2 tab.
The Alfabet configuration allows you to Mapping definition and the Alfabet import configuration of the insecure RESTful API v1 on the API version 1 tab.
theProcedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The insecure Alfabet import configuration and Mapping definition are displayed on the API version 1 tab.
In the Alfabet import configuration, modify the values in this section:
="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.
="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.
="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 when you connected the ARIS database to the Alfabet system.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.
Prerequisites
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Objects are mapped.
.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
Procedure
In ARIS Designer, click ARIS > Administration. The Administration tab opens.
Log in to the database and ensure that the database name is selected.
In the Start tab bar, click Alfabet > Alfabet synchronization. A warning is displayed.
Warning
Note that the selected synchronization options cannot be undone. We recommend backing up the database before starting the operation.
Click OK.
The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.
Click Yes to review the log file and check which objects have been synchronized.
Click No to close the dialog.
You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.
Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.
ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.
You can delete all mappings between ARIS objects and Alfabet objects in ARIS Designer. You can optionally delete only the link parameters or the object definitions.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Warning
Note that the selected actions cannot be undone. We recommend backing up the database before starting the operation.
Procedure
In ARIS Designer, click ARIS > Administration. The Administration tab opens.
Log in to the database.
In the Start tab bar, click Alfabet > Delete Alfabet mappings. The dialog opens.
Select Delete mapping if you want to delete only the mappings between ARIS and Alfabet objects. The objects themselves will not be deleted from the database.
Select Delete object if you want to delete the mappings between ARIS objects and Alfabet objects along with the corresponding objects.
Click OK. A dialog opens for you to complete the procedure.
Click Yes to review the import log file, or click No to close the dialog.
All mapping is removed. All attributes in the Alfabet attribute type group are deleted. The names of the Alfabet objects continue to be used for the ARIS objects. If you have enabled the corresponding option, the objects are deleted as well.
This use case shows how to
import all Alfabet objects to ARIS and start Alfabet synchronization. This keeps your database up to date.Scheduled reports are reports that start automatically at a defined point in time.
They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.
For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.
You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.
The Scheduled reports group is displayed if you have the Report automation .
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Scenario
You write two report scripts to be executed by scheduled reports. The first one imports Alfabet objects, the second one starts the synchronization.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have the Report automation for the related database.
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
You are
for this tenant.The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.
superuser
The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.
system
The system user system assumes the of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.
The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Designer) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.
The following administrator roles are defined:
Database administrators
Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.
Database administrators perform the following tasks at the server level:
Create databases
Delete databases
Backup databases
Restore databases using backups
Reorganize databases
Users with defined function privileges can perform additional actions at the database level.
Configuration administrators
A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.
They perform the following tasks:
Define the modeling conventions and adapt the appearance to match the corporate design of the company.
Create filter
Import filters
Export filters and templates
Create templates
Import templates
Create languages
Create font formats
Define the contents of ARIS Method that are available in the database.
Create model types
Derive model types
Derive object symbols
Create attribute type groups
Create attribute types
Create attribute type symbols
Define symbols for an attribute value
Define symbols for alternative attribute values
Change configurable method names in multiple languages
Script administrators
Script administrators require the Script administrator function privilege in ARIS Administration.
Script administrators perform the following tasks:
Write report scripts
Define report scripts (design view)
Delete scripts
Define rules (semantic check)
Define rule types (semantic check)
Define profiles (semantic check)
Define macros
Export scripts
Import scripts
Import script template
Export script template
Transfer custom or modified scripts of previous ARIS versions
Publisher administrators
Publisher administrators require the Publisher administrator function privilege in ARIS Administration.
Publisher administrators perform the following tasks:
Create Publisher export
Update Publisher export
Delete Publisher export
Analysis publisher
Analysis publishers require the function privilege of the same name in ARIS Administration.
Analysis publishers perform the following actions:
Publish queries
Unpublish queries
Publish ad hoc analyses
Unpublish ad hoc analyses
Analysis administrators
Analysis administrators require the function privilege of the same name in ARIS Administration.
Analysis administrators perform the following actions:
Export query
Import query
Export ad hoc analysis
Import ad hoc analysis
Back up analysis and queries
Restore analyses and queries
.
Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.
Procedure
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration > Synchronization options.
Select the actions that you want to use for ARIS objects and connections if an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.
Click OK.
The selected options are applied for future Alfabet synchronizations.
Procedure
This procedure is part of the use case.
To import Alfabet objects and start the synchronization automatically, write the two report scripts.
Prerequisite
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
You are
for this tenant.The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.
superuser
The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.
system
The system user system assumes the of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.
The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Designer) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.
The following administrator roles are defined:
Database administrators
Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.
Database administrators perform the following tasks at the server level:
Create databases
Delete databases
Backup databases
Restore databases using backups
Reorganize databases
Users with defined function privileges can perform additional actions at the database level.
Configuration administrators
A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.
They perform the following tasks:
Define the modeling conventions and adapt the appearance to match the corporate design of the company.
Create filter
Import filters
Export filters and templates
Create templates
Import templates
Create languages
Create font formats
Define the contents of ARIS Method that are available in the database.
Create model types
Derive model types
Derive object symbols
Create attribute type groups
Create attribute types
Create attribute type symbols
Define symbols for an attribute value
Define symbols for alternative attribute values
Change configurable method names in multiple languages
Script administrators
Script administrators require the Script administrator function privilege in ARIS Administration.
Script administrators perform the following tasks:
Write report scripts
Define report scripts (design view)
Delete scripts
Define rules (semantic check)
Define rule types (semantic check)
Define profiles (semantic check)
Define macros
Export scripts
Import scripts
Import script template
Export script template
Transfer custom or modified scripts of previous ARIS versions
Publisher administrators
Publisher administrators require the Publisher administrator function privilege in ARIS Administration.
Publisher administrators perform the following tasks:
Create Publisher export
Update Publisher export
Delete Publisher export
Analysis publisher
Analysis publishers require the function privilege of the same name in ARIS Administration.
Analysis publishers perform the following actions:
Publish queries
Unpublish queries
Publish ad hoc analyses
Unpublish ad hoc analyses
Analysis administrators
Analysis administrators require the function privilege of the same name in ARIS Administration.
Analysis administrators perform the following actions:
Export query
Import query
Export ad hoc analysis
Import ad hoc analysis
Back up analysis and queries
Restore analyses and queries
Procedure
In ARIS Designer, click ARIS > Administration.
Click Navigation in the bar panel if the Navigation bar is not activated yet.
In the Explorer tree, double-click the Evaluations folder.
Double-click the Reports folder. The report categories are displayed.
Right-click the category to which you want to assign the report script or create a new category.
Click New > Report. The Script Wizard opens.
For the first example specify the Name and Description in the required languages, for example, the name Import all Alfabet objects and the description Imports all objects from Alfabet as defined in the interface configuration into selected database groups.
Deactivate the Opens dialogs check box.
Click Next.
Select the Group as context for the report to be started, and click Next.
Deactivate the Generate output file check box and navigate to the Restrict access page.
Restrict the access for the report to be executed.
Click Finish. Script Editor opens.
Write the code, for example:
var alfaIntegration = Context.getComponent("AlfabetIntegration");
var result = alfaIntegration.doImport(ArisData.getSelectedGroups()[0], null)
Save the script and write the second report, for example, Synchronize Alfabet objects.
This report will synchronize already imported Alfabet objects.
Select Database as context for the report to be started.
Use this code as example:
var alfaIntegration = Context.getComponent("AlfabetIntegration");
var result = alfaIntegration.doSynchronize(ArisData.getActiveDatabase(), 3);
Now you have two reports that will be started by scheduled reports.
This procedure is part of the use case.
To import Alfabet assets and start the synchronization automatically ,create two scheduled reports for your two reports to be execute
.Scheduled reports are reports that start automatically at a defined point in time.
They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.
For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.
You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.
The Scheduled reports group is displayed if you have the Report automation .
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Prerequisite
You have the Report automation for the related database.
Use the following function privileges to control the users' authorizations.
Analysis tab
You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.
You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
You have the following options:
Rename analysis groups
Select an analysis object and display its KPIs in the KPIs area
Obtain information on the composition of a KPI
Navigate through the structure of the analysis objects in the Graphic area
Create tables from templates
Deactivate analysis objects
Delete analysis groups
Open saved tables
Run what-if analyses
Edit values
Obtain information on the composition of a KPI
Create tables from templates
Open saved tables
Run what-if analyses
Data management tab
You can manage data.
You have the following options:
Merge existing dimension combinations and/or analysis objects.
Delete existing dimension combinations
Deactivate dimension combinations
Activate saving points
Deactivate saving points
KPIs tab
You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).
Administration tab
You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.
Procedure
Click ARIS > Administration or ARIS > Explorer. The Administration or Explorer tab opens.
Log in to the database.
Click Navigation in the bar panel if the Navigation bar is not activated yet.
In the Explorer tree, click the folder Scheduled reports.
To create a schedule, click New >
Create scheduled report. The Report Automation Wizard opens.
Specify the name of the first schedule, e. g, Import Alfabet assets daily.
Specify the password of the current user, and click Next.
Select the Import all Alfabet assets report that you have created earlier, and click Next.
Select the database group for the Alfabet assets to be saved in, and click Next.
Specify when and how often the report should be executed, and click Finish.
Create the second schedule for the Synchronize Alfabet assets report to be executed. The steps to be carried out are similar. In this case, select the database as start context.
The reports will be executed as defined. If the first execution is in the future, the report is automatically active and runs as soon as the defined point in time is reached.
Back to the use case
You can configure ARIS - Alfabet Interoperability Interface in ARIS if you have access to ARIS Enterprise - Server or ARIS Enterprise - Enterprise Server and you have the Configuration administrator function privilege.
To manage Alfabet configurations, in ARIS, click Application launcher >
Administration > Conventions > Alfabet import.
You can do the following:
Alfabet configuration
To prevent Alfabet configurations from being overwritten by ARIS updates, you can no longer modify the related XML files in ARIS Designer or edit the Default configuration in ARIS. To modify the configuration, you must duplicate the Default Alfabet configuration or an already modified configuration and adapt the contained Alfabet import configuration. The Default configuration is overwritten with each ARIS update to provide you with the latest features.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. The Default configuration always contains the latest features.
Click Duplicate.
The configuration is duplicated.
You can change and activate the configuration as required.
Alfabet configuration
Import an Alfabet configuration that you have exported earlier to be used on the current tenant.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Import. If you are re-importing this Alfabet configuration, a confirmation dialog is displayed,
even if you have changed the file name, where you can confirm overwriting the existing
Alfabet configuration.
The configuration is imported.
You can change and activate the configuration as required.
of an Alfabet configuration
You can edit the name and description in multiple languages.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Display details.
Select the language.
Enter the name and description (optional).
Click Save.
The changes details are displayed.
Edit the name and description in all required languages in turn.
The connection between ARIS and Alfabet is established by ARIS database attributes. The Alfabet RESTful API interface is configured in ARIS using the Alfabet configuration and related reports available in Alfabet. The Alfabet import configuration is contained in the Default Alfabet configuration. The Default configuration is overwritten with each ARIS update to provide you with the latest features. To prevent your modified Alfabet configuration from being overwritten by ARIS updates, you can no longer modify the related XML files in ARIS Designer or edit the Default configuration. To modify the configuration, you must duplicate the Default Alfabet configuration and modify the Alfabet import configuration in your copy.
The Alfabet import configuration defines the general mapping for models, connections, and assignments. It handles the data transfer between ARIS and Alfabet using Alfabet RESTful API version 2.
Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class.
If you want to define other ARIS object types or Alfabet object classes, you must modify the Alfabet configuration and adapt the related reports that are used in the Alfabet system to transfer the defined data to ARIS.
Prerequisite
Make sure that the defined attribute types are available for each object type.
Alfabet RESTful API version 2 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The Alfabet import configuration is displayed.
Adapt the configuration as required. Tags are explained in these examples.
Click Save configuration.
The configuration is adapted.
You must activate the Alfabet configuration to be used. You can modify the Select Alfabet object dialog available for users. Make sure to . All elements in both the reports and the Alfabet configuration must correspond to each other.
Alfabet reports supporting the default configuration are shipped with Alfabet releases 10.5p2 and later. You can adapt these reports in Alfabet or define your own reports. If you did so, make sure to adapt your Alfabet configuration accordingly.
The reports reduce the amount of data transferred from Alfabet to ARIS. The reports make a set of used properties available 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 lifecycle attributes of an Application system type object.
At least the following properties must be returned by reports:
all mapped properties
all properties used as a condition for ARIS type determination
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.
Further information on the interface and on how to configure the data exchange is available in the related manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You can create an Alfabet configuration from scratch. If you do so, you must write the entire configuration by yourself. To save time, you can duplicate the Default configuration instead and modify the configuration as required.
Prerequisite
In ARIS Designer, you have
the database with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Make sure that the defined attribute types are available for each object type.
Alfabet RESTful API v2 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click Create import configuration. If the insecure API version 1 was activated, make sure to write the Alfabet import configuration on the API version 2 tab. Tags are explained in these examples.
Click Save configuration.
The configuration file is saved.
You must activate the Alfabet configuration to be used. You can modify the Select Alfabet object dialog available for users.
an Alfabet configuration
To make an Alfabet configuration to be used on a tenant, you must activate the required configuration.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. The Default configuration always contains the latest features but will be overwrittten with each
ARIS update.
Click Activate.
The configuration is used for actions performed by the ARIS - Alfabet Interoperability Interface.
an Alfabet configuration
Export an Alfabet configuration that you can import to another tenant.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration.
Click Export.
The configuration is exported.
an Alfabet configuration
You can delete Alfabet configurations that you no longer require. To be on the save side, you can export Alfabet configurations before you delete them.
Click Application launcher >
Administration > Conventions > Alfabet import.
Select the Alfabet configuration. You cannot delete the Default configuration or the active configuration.
Click Delete.
The configuration is deleted.
The URL for the interface is entered when mapping the ARIS database to Alfabet. Users require
in Alfabet.If you still use Alfabet REST API version 1, the login specified in the Alfabet import configuration is used for authentication. Login credentials, Web service URL, and User interface URL can also be in the Alfabet integration property dialog of the related database. The access permissions of the configured login therefore define which Alfabet objects the ARIS users with access to the actions can see.
You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
You can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
Warning
When accessing the Alfabet RESTful API, the login data is transferred with the HTTP header. Therefore, you must ensure that the transfer is encrypted.
To Alfabet Web User Interface. Users must log in to Alfabet themselves.
, users require read access in theYou can navigate to mapped Alfabet objects from ARIS.
Prerequisite
The database is
with Alfabet.You can connect any ARIS database with an Alfabet system in ARIS Designer.
Prerequisites
You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.
Your Administrator has configured the interface in ARIS.
You have the Database management function privilege.
Procedure
Start ARIS Designer.
Using the Explorer tab, log in to the database.
Click Properties. The dialog opens.
In the Selection tab, click Alfabet integration.
Enable Connect to Alfabet.
In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.
In the User interface URL field, enter the Uniform Resource Locator to be used for access to the . This URL is required to enable users to to Alfabet objects from ARIS.
In the User name (optional) and the API password/token fields, specify the user credentials as required.
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.
For more information about the password/token and authorization, read the Alfabet Interface for RESTful Web Services manual. You can open or download documents from the Documentation Web site. Documents are also contained in the ARIS installation package (see Documents > English folder structure) that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended).
If you still use this insecure version, make sure to switch to Alfabet RESTful API version 2 as soon as possible.
Click Test connection to validate the specified values. A dialog shows the test result.
If the test was successful, click OK to close the dialogs.
Log out of the database and lock in again so that the specified connection parameters are applied.
The database is connected to the Alfabet system.
Users can map ARIS objects to Alfabet objects.
You have
to the Alfabet Web User Interface.Procedure
Using the Explorer tab, log in to the database.
Navigate to a mapped object of the Application system type type or select the object in a model.
In the Start tab bar, click Go to > Alfabet object.
Log in to Alfabet, if required.
The object is displayed.
To create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.