Modify configuration of Alfabet REST API v2

The connection between ARIS and Alfabet is established by ARIS database attributes. The Alfabet REST API v2 interface is configured using the ARIS-ALFABET-mappingV2.xml configuration file and related Alfabet reports.

This file defines the general mapping for models, connections, and assignments. It handles the data transfer between ARIS and Alfabet using Alfabet RESTful API v2. Script administrators can adapt this file.

Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class. If you want to define other ARIS object types or Alfabet object classes, you must:

Adapt the related reports

Alfabet reports supporting the default configuration are shipped with Alfabet releases 10.5p2 and later. You can adapt these reports in Alfabet or define your own reports.

The report reduces the amount of data transferred from Alfabet to ARIS. The reports make a set of used properties available and enable access to properties that are not defined in the current class, but that should become ARIS attributes of the imported object, such as lifecycle attributes of an Application system type object. If a referenced report is not available in Alfabet, the import log reports this issue. In this case, the import tries to fall back to the default import without using the report.

Further information on the interface and on how to configure the data exchange is available in the related manual. The Alfabet reference manual of the ARIS - Alfabet Interoperability Interface can be found on the Alfabet installation media. You can also download it from Empower.

Adapt the ARIS-ALFABET-mappingV2.xml configuration file

Warning

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

Prerequisite

Procedure

  1. In ARIS Architect, click ARIS > Show Administration Administration.
  2. Click the group Evaluations > Reports in the Navigation bar.
  3. Open the IT Architecture category.
  4. Double-click the file ARIS-ALFABET-mappingV2.xml. The file opens in Script Editor.
  5. Add further entries or change entries related to the modifications made in the report, as required.
  6. Save the changes and close the file.

The configuration file is adapted.