Skip to main content

Get help for ARIS Architect

Configure Alfabet Interoperability Interface

You can configure ARIS - Alfabet Interoperability Interface in ARIS if you have access to ARIS Enterprise - Server or ARIS Enterprise - Enterprise Server and you have the Configuration administrator function privilege.

To manage Alfabet configurations, in ARIS, click Application launcher Application launcher > Administration Administration > Conventions > Alfabet import.

Duplicate Alfabet configuration

To prevent overwriting custom Alfabet configuration settings during the ARIS updates, you can no longer modify the related XML files in ARIS Architect or edit the Default configuration. To modify the Default configuration, you must duplicate the Default Alfabet configuration and customize the Alfabet import configuration in the copy. The Default configuration gets updated with each ARIS update to include all current features.

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Select the Alfabet configuration. The Default configuration always contains the latest features.

  5. Click Duplicate Duplicate.

The copy of the configuration is created.

You can change and activate the configuration as required.

Import Alfabet configuration

Import an Alfabet configuration that you have exported earlier to use on the current tenant.

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Select the Alfabet configuration.

  5. Click Import Import. Even if you renamed the configuration file before re-importing it, you should still confirm that you want to overwrite the existing Alfabet configuration.

The configuration is imported.

You can change and activate the configuration as required.

Change name and description of an Alfabet configuration

You can edit the name and description in multiple languages.

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Select the Alfabet configuration.

  5. Click Show details Show details.

  6. Select the language.

  7. Enter the name and description (optional).

  8. Edit the name and description in all required languages in turn.

  9. Click Save.

The changed name and description are displayed.

Modify an Alfabet configuration

The connection between ARIS and Alfabet is enabled through ARIS database attributes. The Alfabet RESTful API interface is configured in ARIS using the Alfabet configuration and related reports available in Alfabet. The Alfabet import configuration is included in the Default Alfabet configuration. The Default configuration gets updated with each ARIS update to include all current features. To prevent overwriting custom Alfabet configuration settings during the ARIS updates, you can no longer modify the related XML files in ARIS Architect or edit the Default configuration. To modify the Default configuration, you must duplicate the Default Alfabet configuration and customize the Alfabet import configuration in the copy.

The Alfabet import configuration defines the general mapping for models, connections, and assignments. The configuration handles the data transfer between ARIS and Alfabet using Alfabet RESTful API version 2.

Alfabet interoperability is available for objects of the Application system type type by default. Objects can be mapped to Alfabet objects of the Application Alfabet object class.

If you want to define other ARIS object types or Alfabet object classes, you must modify the Alfabet configuration and adapt the related reports that are used in the Alfabet system to transfer the defined data to ARIS.

Prerequisite

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

  • Alfabet RESTful API version 2 is activated and configured in Alfabet. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. Read the documents on the ARIS Documentation website or download them from the ARIS Download Center.

  • You have the Configuration administrator function privilege.

Procedure. Procedure

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Click the Alfabet configuration. You cannot modify the Default configuration. The Alfabet import configuration is displayed.

  5. Modify the configuration as required. Tags are explained in these examples.

  6. Click Save configuration.

The configuration is modified.

You must activate the Alfabet configuration to use. You can modify the Select Alfabet object dialog available for users. Make sure to modify the Alfabet reports related to the updated configuration. All elements in both the reports and the Alfabet configuration must correspond to each other.

Create an Alfabet configuration

You can create an Alfabet configuration from scratch. In this case, you must specify all configuration settings. Make sure that the defined attribute types are available for each object type. You can also duplicate the Default configuration and modify the configuration as required.

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Click Add language Create import configuration.

  5. Specify the name and description in the required languages and click Save. The new configuration is listed.

  6. Click the name of the new configuration. If the non-secure API version 1 was activated, make sure to write the Alfabet import configuration on the API version 2 tab. Tags are explained in these examples.

  7. Click Save configuration.

The configuration file is saved.

You must activate the Alfabet configuration to use. You can modify the Select Alfabet object dialog available for users.

Activate an Alfabet configuration

To use an Alfabet configuration on a tenant, you must activate the required configuration.

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Select the Alfabet configuration. The Default configuration always contains the current features but gets overwritten with each ARIS update.

  5. Click Activate Activate.

The configuration is used for the actions of the ARIS - Alfabet Interoperability Interface.

Export an Alfabet configuration

Export an Alfabet configuration that you can import to another tenant.

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Select the Alfabet configuration.

  5. Click Export Export.

The configuration is exported.

Delete an Alfabet configuration

You can delete Alfabet configurations that you no longer require. As a backup, you can export Alfabet configurations before you delete them.

  1. Click Application launcher Application launcher > Administration Administration. Configuration Configuration is displayed.

  2. Click Conventions.

  3. Click Alfabet import.

  4. Select the Alfabet configuration. You cannot delete the Default configuration or the active configuration.

  5. Click Delete Delete.

The configuration is deleted.