You can still activate and configure the Alfabet RESTful API version 1, but Software AG does not recommend that, because version 1 is not secure and is outdated.
Alfabet RESTful API version 1 is available for objects of the Application system type type by default. You can map objects 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 and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The non-secure 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 non-secure 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 modify the Mapping definition and the Alfabet import configuration of the non-secure RESTful API v1 on the API version 1 tab.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. The non-secure configuration is displayed on the API version 1 tab.
Modify 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 that is 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 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
of an object type, a model type, or a symbol type.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
<
="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 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
of the ARIS object type to be used. If an ARIS symbol type is specified here, the object type is derived from the symbol. In addition, the default symbol of the imported item is set to this symbol type.Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
<condition value="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 that is created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
aristype
of an object type, a model type, or a symbol type.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
overview-model
Optionally creates an overview model and places an occurrence of each table object that meets this condition in the model.
check-master
Checks for the existence of the specified Alfabet property, such as ARIS_GUID, maintained for an Alfabet object with the ARIS GUID of the corresponding ARIS object. If the ARIS database contains this GUID, the related ARIS object is used as the master instead of the Alfabet object, for example:
check-master="ARIS_GUID"
The attributes and properties of the master object are not overwritten by the import and a master is not removed if the object has been deleted in Alfabet.
condition
Defines a conditional mapping based on a property's value. If the value is specified and corresponds to one of the values listed 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
of the ARIS object type to be used. If an ARIS symbol type is specified here, the object type is derived from the symbol. In addition, the default symbol of the imported item is set to this symbol type.Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
arisgroupname
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' sub-element 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 sub-element.
model
MT_APPL_SYS_TYPE_DGM.
for the model type of the ARIS model to be assigned, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
child-symbol
ST_APPL_SYST_TYPE.
for the symbol type of the ARIS object used in the assigned model, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
Not used if the referenced element is the model itself.
add-parent
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
ST_APPL_SYS_TYPE.
for the symbol type of the superior ARIS object used in the assigned model, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
Required only if the add-parent attribute is set to true.
'attr' sub-element
Maps an Alfabet property value, for example , String or Date, Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="AT_EVALUATION_START" />
attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
aris XML property
of the ARIS attribute.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
An empty string (""): not mapped/ignored.
<attr alfabet="EndDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_END" />
<attr alfabet="StartDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_START" />
<attr alfabet="EndDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_END" />
In this case, the value of the "StartDate" property is written to the aris attribute "AT_EVALUATION_START" only if the alfabet property "Status" has the value "Evaluation", etc.
When used as a sub-element of the <cxn> element (see below), the property is mapped to an attribute of the connection.
All XML properties
attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
aris XML property
of the ARIS attribute.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
An empty string (""): not mapped/ignored.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
'cxn' sub-element
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.
See the Documentation of the Alfabet Meta-Model. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
cxntype
of the ARIS connection type.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
Empty string (""): not mapped/ignored.
Value="-1": do not create a connection. Is allowed only if an assignment definition is available as a sub-element.
srctotarget
Defines the direction of a connection.
Value true:
From class element to referenced element.
Value false:
From referenced element to class element.
forceexist
Specifies whether or not the import forces the target or source object of a referenced object to exist in the database. If the value is set to true, the target or source object will be created using the mapping definition of the referenced object. Only if the target or source object exists will a connection be imported. Whether the target object or the source object must exist depends on the value specified in the srctotarge XML property.
The default value is false.
make-parent-group
Specifies that the group containing the referenced element will become the superior group of the element in question.
You must set the parent mapping to isgroup="true".
connected-objtype
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
).Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
assigned-model
Creates an occurrence of the target object and the corresponding connection in the assigned model if the table element has an assigned sub-element.
The value corresponds to the symbol type number (see
).Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
'assign' sub-element of a 'cxn' element
Creates an assignment to a model either in addition to a connection, instead of a connection, or to a model if the referenced item is a model derived from an additional Alfabet 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
MT_APPL_SYS_TYPE_DGM.
for the model type of the ARIS model to be assigned, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
child-symbol
ST_APPL_SYST_TYPE.
for the symbol type of the ARIS object used in the assigned model, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
Not used if the referenced element is the model itself.
add-parent
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
ST_APPL_SYS_TYPE.
for the symbol type of the superior ARIS object used in the assigned model, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
Required only if the add-parent attribute is set to true.
srctotarget
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' sub-element 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.
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 configured in ARIS as well as in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
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. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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 open the Alfabet object, users require read access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
To create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
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.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 configured in ARIS as well as in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
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. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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 open the Alfabet object, users require read access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
To create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
Interface to Alfabet used to exchange data.
Therefore, RESTful API must be activated and configured in ARIS as well as in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
The URL for the interface is entered when mapping the ARIS database to Alfabet. Users require
in Alfabet.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 .
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. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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 open the Alfabet object, users require read access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
To create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
< ="" ="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.Interface to Alfabet used to exchange data.
Therefore, RESTful API must be activated and configured in ARIS as well as in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
The URL for the interface is entered when mapping the ARIS database to Alfabet. Users require
in Alfabet.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 .
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. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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 open the Alfabet object, users require read access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
To create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
You can connect any ARIS database with an Alfabet system. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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 and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
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 must 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.Interface to Alfabet used to exchange data.
Therefore, RESTful API must be activated and configured in ARIS as well as in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
The URL for the interface is entered when mapping the ARIS database to Alfabet. Users require
in Alfabet.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 .
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. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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 open the Alfabet object, users require read access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
To create Alfabet objects, users require write access in the Alfabet Web User Interface. Users must log in to Alfabet themselves.
You can connect any ARIS database with an Alfabet system. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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. When you have configured the Alfabet import, users can reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. To connect a database to an Alfabet system, do the following:
Click Application launcher >
Administration >
Configuration > Databases.
Select the database and click
Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.
In the Web service URL field, enter the URL to the Alfabet Web application. The URL is used for accessing the Alfabet Web service (Alfabet RESTful API). The Web service URL is required for exchanging data.
In the User interface URL field, enter the URL to be used for accessing the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.
In the User name and the API password/token fields, specify the user credentials as required.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
Warning
For security reasons, we recommend that you use Alfabet RESTful API version 2. Do not activate Alfabet REST API v1 (not recommended). Software AG strongly recommends to switch to Alfabet RESTful API version 2 as soon as possible.
Select the required synchronization options for
whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.Objects
Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.
Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS objects whose mapped Alphabet objects are no longer available.
For these objects, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS objects whose mapped objects no longer exist in Alfabet.
This cannot be undone.
Connections
If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.
Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.
This cannot be undone.
Identifies all ARIS connections whose related Alphabet connections are no longer available in Alfabet.
For these connections, the Alfabet - Deletion candidate attribute (AT_ALFA_DELETE_CANDIDATE, 4152) is set to true.
Deletes ARIS connections whose related connections no longer exist in Alfabet.
This cannot be undone.
Click Test connection to validate the specified values.
If the test was successful, click Save to close the dialog.
The database is connected to the Alfabet system.
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 granted privileges.
For more information about the password and token, and authorization, see the Alfabet Interface for RESTful Web Services manual. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
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 a specific ARIS item that is provided during Alfabet integration. Therefore, you must define each ARIS item type in a separate object element.
aristype
of an object type, a model type, or a symbol type.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
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 table property name, for example, ObjectState.
The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
You enter only one condition property for filtering.
Value
Value of the specified Alfabet class property to be used for filtering table items.
In this example, the ObjectState property value is Active. The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
<
aris=" " />attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
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
Alfabet import configuration.
of the ARIS attribute type. This name is used as an identifier for the attribute from theName for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
By default, the Name (AT_NAME), Description (AT_DESC), Release (AT_REL_3), and Alfabet Link 1 (AT_ALFA_LINK_1) types are used. Of course, you can change the object type attributes to be used, or transfer other attributes. For example, if you do not want to use the Release (AT_REL_3) attribute type for the release (version), modify both configuration files.
If you have changed the default ARIS object type (OT_APPL_SYS_TYPE) to be imported, make sure that all the attribute types required for Alfabet integration are available for the object type you want to use instead.
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
Alfabet Link 1 (AT_ALFA_LINK_1) attribute type will be used for saving the URL to the Alfabet object.
for the attribute type of the ARIS link attribute to be used for navigating to the Alfabet object. By default, theName for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
title
link title attribute to be used. By default, the Alfabet Navigation 1 attribute type will be used for storing the link's title text.
for the attribute type of the ARISName for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
This text is entered in the defaultvalue XML property. It is displayed for all languages that are not explicitly specified in the title locale XML property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS - Alfabet synchronization report.
defaultvalue
Non-localized default text for the link's title text.
This text is displayed for all languages that are not explicitly specified in the title locale XML property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS-Alfabet synchronization report.
<title
="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 logged into the ARIS database in another language, for example, German, the values of the German attributes are displayed in English.
value
Localized title text.
</link>
</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 value and the User interface URL value that you specified when you connected the ARIS database to the Alfabet system.
</dialog-columns>
Bulk import from Alfabet
In the <!-- Bulk mapping --> section, you can configure the Alfabet synchronization and the bulk import functionality.
< ="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. You can overwrite this setting by specifying cxn sub-elements.
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 table property name, for example, ObjectState.
The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
You enter only one condition property for filtering.
Value
Value of the specified Alfabet class property to be used for filtering table items.
In this example, the ObjectState property value is Active. The specified value of this Alfabet class property is used as a filter. Only Alfabet database table items of the specified value can be mapped.
<
aris=" " />attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
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
Alfabet import configuration.
of the ARIS attribute type. This name is used as an identifier for the attribute from theName for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
By default, the Name (AT_NAME), Description (AT_DESC), Release (AT_REL_3), and Alfabet Link 1 (AT_ALFA_LINK_1) types are used. Of course, you can change the object type attributes to be used, or transfer other attributes. For example, if you do not want to use the Release (AT_REL_3) attribute type for the release (version), modify both configuration files.
If you have changed the default ARIS object type (OT_APPL_SYS_TYPE) to be imported, make sure that all the attribute types required for Alfabet integration are available for the object type you want to use instead.
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 sub-element 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. You can overwrite this setting by specifying cxn sub-elements.
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
Alfabet Link 1 (AT_ALFA_LINK_1) attribute type will be used for saving the URL to the Alfabet object.
for the attribute type of the ARIS link attribute to be used for navigating to the Alfabet object. By default, theName for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
title
link title attribute to be used. By default, the Alfabet Navigation 1 attribute type will be used for storing the link's title text.
for the attribute type of the ARISName for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
This text is entered in the defaultvalue XML property. It is displayed for all languages that are not explicitly specified in the title locale XML property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS - Alfabet synchronization report.
defaultvalue
Non-localized default text for the link's title text.
This text is displayed for all languages that are not explicitly specified in the title locale XML property. The title is write protected in ARIS and is entered during the mapping to Alfabet or the ARIS-Alfabet synchronization report.
<title
="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 logged into the ARIS database in another language, for example, German, the values of the German attributes are displayed in English.
value
Localized title text.
</link>
</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 sub-elements. The connection mapping using the properties xobject and yobject along with the cxntype, and the connected-objtype XML properties define two subgroup levels.
If the PSU already exists in ARIS, it will be reused. Therefore, the referenced xobject and yobject objects must already exist.
< ="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
of the ARIS object type to be used for process support units.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
By default, the Process support unit object type (OT_PROCESS_SUPPORT_UNIT) is used in ARIS. The aristype value must be exactly the same as in the ARIS - ALFABET-mapping.xml file.
<!-- these attributes are mapped as attributes of the PSU object-->
<
="CREATION_USER" ="AT_CREATOR" />attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
aris XML property
of the ARIS attribute.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
An empty string (""): not mapped/ignored.
<attr alfabet="LAST_UPDATE_USER" aris="AT_LUSER" />
<attr alfabet="LAST_UPDATE" aris="AT_LAST_CHNG_2" />
<attr alfabet="CREATION_DATE" aris="AT_CREAT_TIME_STMP" />
cxn XML property
The cxn XML properties along with their attr sub-elements define the relationship between the objects.
In this example, the property XML property with the value object, combined with the cxntype XML property with the value CT_BELONGS_TO_PROC_SUPPORT_UNIT, and the connected-objtype XML property with the value OT_APPL_SYS_TYPE define the relationship between process support units and application system types.
<!-- the following attributes define the connection attributs for connection from the application system type to the PSU object: -->
<attr aris="AT_EXTERNAL_ID" alfabet="refstr" /> <!-- for cxns we do not map refstr/guid by default, so it must be listed here -->
<attr alfabet="StartDate" aris="AT_PHASE_IN_AS_IS" />
<attr alfabet="EndDate" aris="AT_PHASE_OUT_PLAN" />
<attr alfabet="ObjectState" aris="AT_PROC_SUPPORT_STATUS" />
<attr alfabet="Description" aris="AT_DESC" />
<attr alfabet="ID" aris="AT_ID" />
<attr alfabet="Name" aris="AT_CXN_ROLE" />
<attr alfabet="Status" aris="AT_REM" />
</cxn>
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 must specify the model items: see items sub-element.
<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
of an ARIS model type.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup that is created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the specified Alfabet property, such as ARIS_GUID, maintained for an Alfabet object with the ARIS GUID of the corresponding ARIS object. If the ARIS database contains this GUID, the related ARIS object is used as the master instead of the Alfabet object, for example:
check-master="ARIS_GUID"
The attributes and properties of the master object are not overwritten by the import and a master is not removed if the object has been deleted in Alfabet.
condition
Defines a conditional mapping based on a property's value. If the value is specified and corresponds to one of the values listed 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
that are to be shown for the ARIS connection types contained in the model. These names are shown only if the corresponding connections exist between the objects contained in the model.Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
'attr' sub-element
Maps an Alfabet property value, for example , String or Date, Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="AT_EVALUATION_START" />
attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
aris XML property
of the ARIS attribute.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
An empty string (""): not mapped/ignored.
<attr alfabet="EndDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_END" />
<attr alfabet="StartDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_START" />
<attr alfabet="EndDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_END" />
In this case, the value of the "StartDate" property is written to the aris attribute "AT_EVALUATION_START" only if the alfabet property "Status" has the value "Evaluation", etc.
When used as a sub-element of the <cxn> element (see below), the property is mapped to an attribute of the connection.
All XML properties
attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
aris XML property
of the ARIS attribute.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
An empty string (""): not mapped/ignored.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
'items' sub-element 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 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
ST_VAL_ADD_CHN_SML_2.
for the symbol type of the ARIS object used in the assigned model, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
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 must specify the model items: see items sub-element.
<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
of an ARIS model type.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
arisgroupname
Name of the ARIS database group.
If the entire table is imported, arisgroupname is the name of the subgroup that is created for the table content.
If arisgroupname is empty or not specified, no subgroup will be created.
check-master
Checks for the existence of the specified Alfabet property, such as ARIS_GUID, maintained for an Alfabet object with the ARIS GUID of the corresponding ARIS object. If the ARIS database contains this GUID, the related ARIS object is used as the master instead of the Alfabet object, for example:
check-master="ARIS_GUID"
The attributes and properties of the master object are not overwritten by the import and a master is not removed if the object has been deleted in Alfabet.
condition
Defines a conditional mapping based on a property's value. If the value is specified and corresponds to one of the values listed 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
that are to be shown for the ARIS connection types contained in the model. These names are shown only if the corresponding connections exist between the objects contained in the model.Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
'attr' sub-element
Maps an Alfabet property value, for example , String or Date, Reference or ReferenceArray properties are not allowed here.
< ="StartDate" ="Status" ="Evaluation" ="AT_EVALUATION_START" />
attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
aris XML property
of the ARIS attribute.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
An empty string (""): not mapped/ignored.
<attr alfabet="EndDate" condition="Status" value="Evaluation" aris="AT_EVALUATION_END" />
<attr alfabet="StartDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_START" />
<attr alfabet="EndDate" condition="Status" value="Pilot" aris="AT_TO_BE_PHASED_IN_END" />
In this case, the value of the "StartDate" property is written to the aris attribute "AT_EVALUATION_START" only if the alfabet property "Status" has the value "Evaluation", etc.
When used as a sub-element of the <cxn> element (see below), the property is mapped to an attribute of the connection.
All XML properties
attr XML property
Defines the handling of attributes.
If at least one attr sub-element is specified, this restricts the list of attributes imported into ARIS to the list of attr elements listed here.
alfabet
Name of the Alfabet property.
aris XML property
of the ARIS attribute.
Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
An empty string (""): not mapped/ignored.
XML properties for conditional attribute import
condition
Property that has to be checked against the value. Only if the value of the property equals the given value is the attribute imported.
value
Value that is checked against the value of the condition XML property for conditional attribute import.
'items' sub-element 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 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
ST_VAL_ADD_CHN_SML_2.
for the symbol type of the ARIS object used in the assigned model, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
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
for ARIS connection types. The connection types are tried one after another until a type is found that is valid between the source and target object type. This is useful if the source and target objects are of more than one type.Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
Value -1 (= do not create a connection) is allowed only if an assignment definition has been specified as a sub-element.
'assign' sub-element of a 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
ST_APPL_SYS_TYPE.
for the symbol type of the superior ARIS object used in the assigned model, for example,Name for ARIS Method items that are assigned to a specific type number. Type number and API name are unique identifiers for database items that are used to define types in ARIS Method.
Information about API names is available in ARIS ( Application launcher >
Administration >
Configuration > Conventions > Method) and in ARIS Architect on the Administration tab below the Method folder structure. Specific information from the Method help is available when you
select an item, for example, an object, a connection, or a model, and press Ctrl + F1 in ARIS Architect.
Required only if the add-parent attribute is set to true.
'attr' sub-element
Maps properties to ARIS connection attributes. This is not applicable to imports including assignments only. The syntax is the same as in the general description (see attr sub-element).
'cxn' sub-element
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.
See the Documentation of the Alfabet Meta-Model. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
role
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 or source object of a referenced object to exist in the database. If the value is set to true, the target or source object will be created using the mapping definition of the referenced object. Only if the target or source object exists will a connection be imported. Whether the target object or the source object must exist depends on the value specified in the srctotarge XML property.
The default value is false.
Example
<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 use. 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 and the Technical Help from the Documentation Web site. Documentation is also contained in the ARIS installation package that is available in the ARIS Download Center.
You have the Configuration administrator function privilege.
The non-secure 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 non-secure 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 modify the Mapping definition and the Alfabet import configuration of the non-secure RESTful API v1 on the API version 1 tab.
Procedure
Click Application launcher >
Administration > Conventions > Alfabet import.
Click the Alfabet configuration. You cannot modify the Default configuration. Thehe non-secure 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 value and the User interface URL value that you specified when you connected the ARIS database to the Alfabet system.
</dialog-columns>
Save the changes.
The dialog is changed according to your modification.