ARIS - Alfabet Interoperability Interface

Alfabet is an IT planning and portfolio management system. Based on answering the questions, when, where, how, and why to make changes in the IT portfolio, it is used to increase IT investment returns and reduce transformation risks.

When configured in ARIS, the ARIS - Alfabet Interoperability Interface allows users to reuse objects from connected ARIS databases and Alfabet databases and switch to the other system. It is easy to navigate between the systems. For example, from a business process in Alfabet, you can switch to the corresponding function or to a model in ARIS that contains the function. You can switch, for example, from an application system to the related application in Alfabet.

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.

You can do the following:

Duplicate 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 > Conventions > Alfabet import.

  2. Selected itemsSelect the Alfabet configuration. The Default configuration always contains the latest features.

  3. Click Duplicate Duplicate.

The copy of the configuration is created.

You can change and activate the configuration as required.

Import 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 > Conventions > Alfabet import.

  2. Selected itemsSelect the Alfabet configuration.

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

Display details 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 > Conventions > Alfabet import.

  2. Selected itemsSelect the Alfabet configuration.

  3. Click Display details Display details.

  4. Select the language.

  5. Enter the name and description (optional).

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

  7. Click Save.

The changed name and description are displayed.

Modify an Alfabet configuration

Add language 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 > Conventions > Alfabet import.

  2. Click Add language Create import configuration.

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

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

  5. 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 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 > Conventions > Alfabet import.

  2. Selected itemsSelect the Alfabet configuration. The Default configuration always contains the current features but gets overwritten with each ARIS update.

  3. Click Activate Activate.

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

Export Export an Alfabet configuration

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

  1. Click Application launcher Application launcher > Administration Administration > Conventions > Alfabet import.

  2. Selected itemsSelect the Alfabet configuration.

  3. Click Export Export.

The configuration is exported.

Delete 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 > Conventions > Alfabet import.

  2. Selected itemsSelect the Alfabet configuration. You cannot delete the Default configuration or the active configuration.

  3. Click Delete Delete.

The configuration is deleted.

You can do the following

Map Alfabet object to ARIS object

You can map an Alfabet object to an ARIS object. Multiple mapping is not possible. By default, you can map objects of the Application system type object type to objects of the Alfabet Application class. If you want to use other object types or Alfabet classes, you must adapt the configuration files according to the Alfabet REST API version in use.

Prerequisite

The database is connected with Alfabet.

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:

  1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

  2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

  6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

    Objects

    Do not change

    Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

    Delete mapping

    Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

    This cannot be undone.

    Mark objects as deleted

    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.

    Delete objects

    Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

    This cannot be undone.

    Connections

    Do not change

    If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

    Delete mapping

    Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

    This cannot be undone.

    Mark connections as deleted

    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.

    Delete connections

    Deletes ARIS connections whose related connections no longer exist in Alfabet.

    This cannot be undone.

  7. Click Test connection to validate the specified values.

  8. If the test was successful, click Save to close the dialog.

The database is connected to the Alfabet system.

Procedure

  1. Using the Explorer tab, log in to the database.

  2. Navigate to a mapped object of the Application system type object type or select the object in a model.

  3. Activate the Contents tab bar.

  4. Click Alfabet Alfabet > Map Alfabet object Map Alfabet object. The Select Alfabet object dialog opens. All Alfabet objects are listed that match the settings for individual mapping.

    ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.

    To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents 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.

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

    For security reasons, we recommend that you use Alfabet RESTful API version 2.

    Configure Alfabet REST API v2

    Configure Alfabet REST API v1

  5. Select the Alfabet object class, for example, Application. You will see only those Alfabet objects you have the privileges to use. If you start typing the object name into the Filter field, the number of entries will decrease.

    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 Alfabet REST API version 2.

      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 read access 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 specified 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:

      1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

      2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

      6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

        Objects

        Do not change

        Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Mark objects as deleted

        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.

        Delete objects

        Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Connections

        Do not change

        If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

        This cannot be undone.

        Mark connections as deleted

        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.

        Delete connections

        Deletes ARIS connections whose related connections no longer exist in Alfabet.

        This cannot be undone.

      7. Click Test connection to validate the specified values.

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

  6. Click Refresh Refresh, if objects are missing in the list. If an object is not available, you can create it in Alfabet.

  7. Double-click the Alfabet object you want to map to the ARIS object.

    The attributes defined in the configuration file are applied to the Alfabet object. For the Application system type type these are the following attributes by default:

    Name

    By default, the Name attribute will be overwritten when exchanging data.

    If you map an ARIS object to an Alfabet object, the name of the Alfabet object will be used in future. The object name is overwritten in ARIS.

    Description/Definition

    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.

    Release

    By default, the Release attribute will be overwritten when exchanging data.

    If you map an ARIS object to an Alfabet object, the Alfabet property Version will be updated.

The Alfabet object is mapped to the ARIS object. The name of the Alfabet object is now used for the ARIS object. Additional attributes have been entered for this object in the Alfabet attribute type group.

The mapping remains until the object is unmapped. Administrators can delete all mappings at once.

Create Alfabet object

You can create a missing Alfabet object to be mapped to an ARIS object.

Prerequisites

  • The database is connected with Alfabet.

    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:

    1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

    2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

    6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

      Objects

      Do not change

      Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Mark objects as deleted

      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.

      Delete objects

      Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Connections

      Do not change

      If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

      This cannot be undone.

      Mark connections as deleted

      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.

      Delete connections

      Deletes ARIS connections whose related connections no longer exist in Alfabet.

      This cannot be undone.

    7. Click Test connection to validate the specified values.

    8. If the test was successful, click Save to close the dialog.

    The database is connected to the Alfabet system.

  • You have access to the Alfabet Web User Interface.

    ARIS users access Alfabet directly or indirectly. Depending on the action, a different type of authentication is used:

    • Mapping single Alfabet objects, importing objects in bulk or synchronizing data requires read access via the Alfabet REST API version 2.

      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 read access 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 specified 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:

      1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

      2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

      6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

        Objects

        Do not change

        Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Mark objects as deleted

        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.

        Delete objects

        Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Connections

        Do not change

        If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

        This cannot be undone.

        Mark connections as deleted

        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.

        Delete connections

        Deletes ARIS connections whose related connections no longer exist in Alfabet.

        This cannot be undone.

      7. Click Test connection to validate the specified values.

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

Procedure

  1. Using the Explorer tab, log in to the database.

  2. Navigate to an object of the Application system type type.

  3. Activate the Contents tab bar.

  4. Click Alfabet Alfabet > Map Alfabet object Map Alfabet object. The Select Alfabet object dialog opens.

  5. Select the Alfabet table, for example, Application.

  6. Click Create new Alfabet object. The Alfabet login dialog opens.

  7. Create the object in Alfabet.

  8. In ARIS in the Select Alfabet object dialog click Refresh Refresh.

The new object is listed in the table.

You can map the new object to an ARIS object.

Switch to Alfabet

You can navigate to mapped Alfabet objects from ARIS.

Prerequisite

  • The database is connected with Alfabet.

    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:

    1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

    2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

    6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

      Objects

      Do not change

      Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Mark objects as deleted

      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.

      Delete objects

      Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Connections

      Do not change

      If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

      This cannot be undone.

      Mark connections as deleted

      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.

      Delete connections

      Deletes ARIS connections whose related connections no longer exist in Alfabet.

      This cannot be undone.

    7. Click Test connection to validate the specified values.

    8. If the test was successful, click Save to close the dialog.

    The database is connected to the Alfabet system.

  • You have access to the Alfabet Web User Interface.

    ARIS users access Alfabet directly or indirectly. Depending on the action, a different type of authentication is used:

    • Mapping single Alfabet objects, importing objects in bulk or synchronizing data requires read access via the Alfabet REST API version 2.

      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 read access 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 specified 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:

      1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

      2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

      6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

        Objects

        Do not change

        Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Mark objects as deleted

        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.

        Delete objects

        Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Connections

        Do not change

        If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

        This cannot be undone.

        Mark connections as deleted

        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.

        Delete connections

        Deletes ARIS connections whose related connections no longer exist in Alfabet.

        This cannot be undone.

      7. Click Test connection to validate the specified values.

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

Procedure

  1. Using the Explorer tab, log in to the database.

  2. Navigate to a mapped object of the Application system type type or select the object in a model.

  3. In the Start tab bar, click Go to Go to > Alfabet object.

  4. Log in to Alfabet, if required.

The object is displayed.

Unmap Alfabet object

You can delete the mapping between an ARIS object and an Alfabet object.

Prerequisite

The database is connected with Alfabet.

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:

  1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

  2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

  6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

    Objects

    Do not change

    Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

    Delete mapping

    Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

    This cannot be undone.

    Mark objects as deleted

    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.

    Delete objects

    Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

    This cannot be undone.

    Connections

    Do not change

    If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

    Delete mapping

    Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

    This cannot be undone.

    Mark connections as deleted

    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.

    Delete connections

    Deletes ARIS connections whose related connections no longer exist in Alfabet.

    This cannot be undone.

  7. Click Test connection to validate the specified values.

  8. If the test was successful, click Save to close the dialog.

The database is connected to the Alfabet system.

Procedure

  1. Using the Explorer tab, log in to the database.

  2. Navigate to a mapped object. Unless you have changed the configuration, objects of the Application system type type may be mapped to Alfabet objects.

  3. Activate the Contents tab bar.

  4. Click Alfabet Alfabet > Unmap Alfabet object Unmap Alfabet object.

The mapping is removed without prompting. All attributes in the Alfabet attribute type group are deleted. The name of the Alfabet object continues to be used for the ARIS object.

See also

Delete all Alfabet mappings or mappings and objects

Administrators can do the following

Connect database with Alfabet system

You can connect any ARIS database with an Alfabet system in ARIS Architect.

Prerequisites

  • You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.

  • Your Administrator has configured the interface in ARIS.

  • You have the Database management function privilege.

Procedure

  1. Start ARIS Architect.

  2. Using the Explorer tab, log in to the database.

  3. Click Properties Properties. The dialog opens.

  4. On the Selection tab, click Alfabet integration.

  5. Enable Connect to Alfabet.

  6. In the Web service URL field, enter the Uniform Resource Locator to be used for access to the Alfabet Web service (Alfabet RESTful API). This URL is required for exchanging data. This is the address of the Alfabet Web application.

  7. In the User interface URL field, enter the Uniform Resource Locator to be used for access to the Alfabet user interface. This URL is required to enable users to navigate to Alfabet objects from ARIS.

    Alfabet user interface, which you can use to navigate to Alfabet objects from ARIS. The URL is entered when mapping the ARIS database to Alfabet.

    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:

    1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

    2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

    6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

      Objects

      Do not change

      Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Mark objects as deleted

      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.

      Delete objects

      Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Connections

      Do not change

      If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

      This cannot be undone.

      Mark connections as deleted

      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.

      Delete connections

      Deletes ARIS connections whose related connections no longer exist in Alfabet.

      This cannot be undone.

    7. Click Test connection to validate the specified values.

    8. If the test was successful, click Save to close the dialog.

    The database is connected to the Alfabet system.

    Users require read access.

    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 Alfabet REST API version 2.

      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 read access 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 specified 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:

      1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

      2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

      6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

        Objects

        Do not change

        Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Mark objects as deleted

        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.

        Delete objects

        Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

        This cannot be undone.

        Connections

        Do not change

        If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

        Delete mapping

        Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

        This cannot be undone.

        Mark connections as deleted

        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.

        Delete connections

        Deletes ARIS connections whose related connections no longer exist in Alfabet.

        This cannot be undone.

      7. Click Test connection to validate the specified values.

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

  8. In the User name (optional) and the API password/token fields, specify the user credentials as required.

    If the RESTful API of the Alfabet system is configured for anonymous access, you 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.

    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.

  9. Click Test connection to validate the specified values. A dialog shows the test result.

  10. If the test was successful, click OK to close the dialogs.

  11. Log out of the database and log in again so that the specified connection parameters are applied.

The database is connected to the Alfabet system.

Users can map ARIS objects to Alfabet objects.

Specify options for synchronization

Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.

Procedure

  1. Using the Explorer tab, log in to the database.

  2. Click Properties Properties. The dialog opens.

  3. On the Selection tab, click Alfabet integration > Synchronization options.

  4. Select the actions that you want to use for ARIS objects and connections when an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.

  5. Click OK.

The selected options are applied for future Alfabet synchronizations.

Manage objects and connections

If imported Alfabet objects and connections no longer exist in Alfabet, you can decide on how to treat these elements in ARIS. You can either leave them unchanged, delete the mapping, mark them as deleted, or delete the elements from the database.

Procedure

  1. Log into the database.

  2. Click Properties Properties.

  3. On the Selection tab, click Alfabet integration > Synchronization options.

  4. Select the actions that you want to use for ARIS objects and connections when an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.

  5. Click OK.

  6. In ARIS Architect, click ARIS > Show Administration Administration.

  7. In the Start tab bar, click Alfabet Alfabet > Alfabet synchronization. A warning is displayed.

    Warning

    Note that you cannot undo the selected synchronization options. We recommend backing up the database before starting the operation.

  8. Click OK.

    The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.

  9. Click Yes to review the log file and check which objects have been synchronized.

  10. Click No to close the dialog.

You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.

Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.

ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.

Import all Alfabet objects (bulk import)

You can import all Alfabet objects to a selected database group.

Prerequisite

The database is connected with Alfabet.

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:

  1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

  2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

  6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

    Objects

    Do not change

    Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

    Delete mapping

    Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

    This cannot be undone.

    Mark objects as deleted

    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.

    Delete objects

    Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

    This cannot be undone.

    Connections

    Do not change

    If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

    Delete mapping

    Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

    This cannot be undone.

    Mark connections as deleted

    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.

    Delete connections

    Deletes ARIS connections whose related connections no longer exist in Alfabet.

    This cannot be undone.

  7. Click Test connection to validate the specified values.

  8. If the test was successful, click Save to close the dialog.

The database is connected to the Alfabet system.

Procedure

  1. Using the Explorer tab, log in to the database.

  2. Select the database group as a target for all Alfabet objects to be imported.

  3. Activate the Contents tab bar.

  4. Click Import Import > Import all Alfabet data.

    This functionality is also available on the Administration tab (Start tab bar > Alfabet Alfabet > Import all Alfabet data). A dialog for you to complete the procedure opens.

  5. Click Yes to review the import log file, or click No to close the dialog.

You have successfully imported all configured data from Alfabet into the selected database group at once (bulk import).

ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.

To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents 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.

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

For security reasons, we recommend that you use Alfabet RESTful API version 2.

Configure Alfabet REST API v2

Configure Alfabet REST API v1

See also

Use case - Schedule object import or synchronization

Start Alfabet synchronization

You can synchronize data between the ARIS database and the Alfabet system according to the configuration.

ARIS - Alfabet Interoperability Interface comes with a default configuration. Administrators can modify the configuration, for example, the ARIS object types or Alfabet tables to be used.

To use the interface, ARIS as well as Alfabet must be configured. How to configure ARIS is described in this help set. How to configure Alfabet is described in the Alfabet reference manual. For more information, read the Alfabet reference manual of the ARIS - Alfabet Interoperability Interface. You can open or download documents 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.

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

For security reasons, we recommend that you use Alfabet RESTful API version 2.

Configure Alfabet REST API v2

Configure Alfabet REST API v1

Prerequisites

  • The database is connected with Alfabet.

    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:

    1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

    2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

    6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

      Objects

      Do not change

      Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Mark objects as deleted

      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.

      Delete objects

      Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Connections

      Do not change

      If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

      This cannot be undone.

      Mark connections as deleted

      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.

      Delete connections

      Deletes ARIS connections whose related connections no longer exist in Alfabet.

      This cannot be undone.

    7. Click Test connection to validate the specified values.

    8. If the test was successful, click Save to close the dialog.

    The database is connected to the Alfabet system.

  • Objects are mapped.

  • Required options for the Alfabet synchronization are specified.

    Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.

    Procedure

    1. Using the Explorer tab, log in to the database.

    2. Click Properties Properties. The dialog opens.

    3. On the Selection tab, click Alfabet integration > Synchronization options.

    4. Select the actions that you want to use for ARIS objects and connections when an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.

    5. Click OK.

    The selected options are applied for future Alfabet synchronizations.

Procedure

  1. In ARIS Architect, click ARIS > Show Administration Administration. The Administration tab opens.

  2. Log in to the database and ensure that the database name is selected.

  3. In the Start tab bar, click Alfabet Alfabet > Alfabet synchronization. A warning is displayed.

    Warning

    Note that you cannot undo the selected synchronization options. We recommend backing up the database before starting the operation.

  4. Click OK.

    The data for which you have privileges in Alfabet is synchronized. Objects that are currently being edited are not included. A dialog opens for you to complete the procedure.

  5. Click Yes to review the log file and check which objects have been synchronized.

  6. Click No to close the dialog.

You have overwritten the attributes of all mapped objects and connections with the current values from the Alfabet system.

Mappings for ARIS master objects whose mapped objects no longer exist in Alfabet were deleted.

ARIS objects and connections whose mapped master objects or connections no longer exist in Alfabet were handled according to your selection.

See also

Use case - Schedule object import or synchronization

Delete all Alfabet mappings or mappings and objects

You can delete all mappings between ARIS objects and Alfabet objects in ARIS Architect. You can optionally delete only the link parameters or the object definitions.

Prerequisite

  • The database is connected with Alfabet.

    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:

    1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

    2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

    6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

      Objects

      Do not change

      Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Mark objects as deleted

      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.

      Delete objects

      Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Connections

      Do not change

      If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

      This cannot be undone.

      Mark connections as deleted

      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.

      Delete connections

      Deletes ARIS connections whose related connections no longer exist in Alfabet.

      This cannot be undone.

    7. Click Test connection to validate the specified values.

    8. If the test was successful, click Save to close the dialog.

    The database is connected to the Alfabet system.

  • You have used the Perspective Wizard to activate the ARIS - Alfabet Interoperability subject, and have selected at least the Modeling working environment.

Warning

Note that the selected actions cannot be undone. We recommend backing up the database before starting the operation.

Procedure

  1. In ARIS Architect, click ARIS > Show Administration Administration. The Administration tab opens.

  2. Log in to the database.

  3. In the Start tab bar, click Alfabet Alfabet > Delete Alfabet mappings. The dialog opens.

  4. Select Delete mapping if you want to delete only the mappings between ARIS and Alfabet objects. The objects themselves will not be deleted from the database.

    Select Delete object if you want to delete the mappings between ARIS objects and Alfabet objects along with the corresponding objects.

  5. Click OK. A dialog opens for you to complete the procedure.

  6. Click Yes to review the import log file, or click No to close the dialog.

All mapping is removed. All attributes in the Alfabet attribute type group are deleted. The names of the Alfabet objects continue to be used for the ARIS objects. If you have enabled the corresponding option, the objects are deleted as well.

See also

Unmap Alfabet object

Use case - Schedule object import or synchronization

This use case shows how to automatically import all Alfabet objects to ARIS and start Alfabet synchronization. This keeps your database up to date.

Scheduled reports are reports that start automatically at a defined point in time.

They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.

For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.

You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.

The Scheduled reports group is displayed if you have the Report automation function privilege.

Use the following function privileges to control the users' authorizations.

Analysis tab

You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.

You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.

You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

You have the following options: 

  • Rename analysis groups

  • Select an analysis object and display its KPIs in the KPIs area

  • Obtain information on the composition of a KPI

  • Navigate through the structure of the analysis objects in the Graphic area

  • Create tables from templates

  • Deactivate analysis objects

  • Delete analysis groups

  • Open saved tables

  • Run what-if analyses

  • Edit values

  • Obtain information on the composition of a KPI

  • Create tables from templates

  • Open saved tables

  • Run what-if analyses

Data management tab

You can manage data.

You have the following options: 

  • Merge existing dimension combinations and/or analysis objects.

  • Delete existing dimension combinations

  • Deactivate dimension combinations

  • Activate saving points

  • Deactivate saving points

KPIs tab

  • You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

Administration tab

You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.

Scenario

You write two report scripts to be executed by scheduled reports. The first one imports Alfabet objects, the second one starts the synchronization.

Prerequisite

  • The database is connected with Alfabet.

    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:

    1. Click Application launcher Application launcher > Administration Administration > Configuration Configuration > Databases.

    2. Selected items Select the database and click Properties Properties > Alfabet configuration. The Alfabet integration settings of database "..." bar opens.

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

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

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

    6. Select the required synchronization options for objects and connections whose mapped objects or connections no longer exist in Alfabet. The selected actions are executed automatically during data synchronization.

      Objects

      Do not change

      Mapped objects that no longer exist in Alfabet remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Mark objects as deleted

      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.

      Delete objects

      Deletes ARIS objects whose mapped objects no longer exist in Alfabet.

      This cannot be undone.

      Connections

      Do not change

      If connections between Alfabet objects were modified or deleted in Alfabet, these connections remain unchanged in the ARIS database.

      Delete mapping

      Deletes mappings from ARIS connections whose corresponding connections no longer exist in Alfabet.

      This cannot be undone.

      Mark connections as deleted

      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.

      Delete connections

      Deletes ARIS connections whose related connections no longer exist in Alfabet.

      This cannot be undone.

    7. Click Test connection to validate the specified values.

    8. If the test was successful, click Save to close the dialog.

    The database is connected to the Alfabet system.

  • You have the Report automation function privilege for the related database.

    Use the following function privileges to control the users' authorizations.

    Analysis tab

    You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.

    You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.

    You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

    You have the following options: 

    • Rename analysis groups

    • Select an analysis object and display its KPIs in the KPIs area

    • Obtain information on the composition of a KPI

    • Navigate through the structure of the analysis objects in the Graphic area

    • Create tables from templates

    • Deactivate analysis objects

    • Delete analysis groups

    • Open saved tables

    • Run what-if analyses

    • Edit values

    • Obtain information on the composition of a KPI

    • Create tables from templates

    • Open saved tables

    • Run what-if analyses

    Data management tab

    You can manage data.

    You have the following options: 

    • Merge existing dimension combinations and/or analysis objects.

    • Delete existing dimension combinations

    • Deactivate dimension combinations

    • Activate saving points

    • Deactivate saving points

    KPIs tab

    • You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

    Administration tab

    You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.

  • You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.

  • You are script administrator for this tenant.

    The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.

    superuser

    The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.

    system

    The system user system assumes the administrator role of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.

    The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Architect) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.

    To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.

    The following administrator roles are defined:

    Database administrators

    Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.

    Database administrators perform the following tasks at the server level:

    Users with defined function privileges can perform additional actions at the database level.

    Configuration administrators

    A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.

    They perform the following tasks:

    Script administrators

    Script administrators require the Script administrator function privilege in ARIS Administration.

    Script administrators perform the following tasks:

    Analysis publisher

    Analysis publishers require the function privilege of the same name in ARIS Administration.

    Analysis publishers perform the following actions:

    Analysis administrators

    Analysis administrators require the function privilege of the same name in ARIS Administration.

    Analysis administrators perform the following actions:

  • Required options for the Alfabet synchronization are specified.

    Select the required actions for ARIS objects or connections whose mapped master objects or connections no longer exist in Alfabet.

    Procedure

    1. Using the Explorer tab, log in to the database.

    2. Click Properties Properties. The dialog opens.

    3. On the Selection tab, click Alfabet integration > Synchronization options.

    4. Select the actions that you want to use for ARIS objects and connections when an authorized ARIS user starts the Alfabet synchronization but objects or connections no longer exist in Alfabet.

    5. Click OK.

    The selected options are applied for future Alfabet synchronizations.

Procedure

  1. Write report scripts in ARIS Architect.

    This procedure is part of the use case.

    To import Alfabet objects and start the synchronization automatically, write the two report scripts.

    Prerequisite

    Procedure

    1. In ARIS Architect, click ARIS > Show Administration Administration.

    2. Click Navigation Navigation in the bar panel if the Navigation bar is not activated yet.

    3. In the Explorer tree, double-click the Evaluations Evaluations folder.

    4. Double-click the Reports folder. The report categories are displayed.

    5. Right-click the category to which you want to assign the report script or create a new category.

    6. Click New > Report Report. The Script Wizard opens.

    7. For the first example, specify the Name and Description in the required languages, for example, the name Import all Alfabet objects and the description Imports all objects from Alfabet as defined in the interface configuration into selected database groups.

    8. Deactivate the Opens dialogs check box.

    9. Click Next.

    10. Select the Group as context for the report to be started, and click Next.

    11. Deactivate the Generate output file check box and navigate to the Restrict access page.

    12. Restrict the access for the report to be executed.

    13. Click Finish. Script Editor opens.

    14. Write the code, for example:

      var alfaIntegration = Context.getComponent("AlfabetIntegration");

      var result = alfaIntegration.doImport(ArisData.getSelectedGroups()[0], null)

    15. Save the script and write the second report, for example, Synchronize Alfabet objects.

      This report will synchronize already imported Alfabet objects.

    16. Select Database as context for the report to be started.

    17. Use this code as example:

      var alfaIntegration = Context.getComponent("AlfabetIntegration");

      var result = alfaIntegration.doSynchronize(ArisData.getActiveDatabase(), 3);

    Now you have two reports that will be started by scheduled reports.

  2. Create scheduled reports

    This procedure is part of the use case.

    To import Alfabet assets and start synchronization automatically, create two scheduled reports to run your two reports automatically.

    Scheduled reports are reports that start automatically at a defined point in time.

    They run in the background and you can view the results later. For example, you can define that a report that strongly affects system performance is to run only at night when no one is working with the system.

    For reports to be able to run completely automatically, dialogs must not be opened by the report during report execution. For reports that you cannot run automatically, the Opens dialogs check box is enabled on the properties pages.

    You can deactivate a schedule to prevent automatic execution, but still keep the schedule in general. You can activate the schedule anytime.

    The Scheduled reports group is displayed if you have the Report automation function privilege.

    Use the following function privileges to control the users' authorizations.

    Analysis tab

    You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.

    You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.

    You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

    You have the following options: 

    • Rename analysis groups

    • Select an analysis object and display its KPIs in the KPIs area

    • Obtain information on the composition of a KPI

    • Navigate through the structure of the analysis objects in the Graphic area

    • Create tables from templates

    • Deactivate analysis objects

    • Delete analysis groups

    • Open saved tables

    • Run what-if analyses

    • Edit values

    • Obtain information on the composition of a KPI

    • Create tables from templates

    • Open saved tables

    • Run what-if analyses

    Data management tab

    You can manage data.

    You have the following options: 

    • Merge existing dimension combinations and/or analysis objects.

    • Delete existing dimension combinations

    • Deactivate dimension combinations

    • Activate saving points

    • Deactivate saving points

    KPIs tab

    • You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

    Administration tab

    You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.

    Prerequisite

    You have the Report automation function privilege for the related database.

    Use the following function privileges to control the users' authorizations.

    Analysis tab

    You can analyze dependencies between analysis objects and KPIs. All analysis objects contained in the database are displayed. The rule set defines this structure for the transfer of analysis objects. The graphic is used to display the structure of analysis objects.

    You can evaluate KPIs using tables created with templates and relate the analysis objects, dimensions and KPIs to each other.

    You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

    You have the following options: 

    • Rename analysis groups

    • Select an analysis object and display its KPIs in the KPIs area

    • Obtain information on the composition of a KPI

    • Navigate through the structure of the analysis objects in the Graphic area

    • Create tables from templates

    • Deactivate analysis objects

    • Delete analysis groups

    • Open saved tables

    • Run what-if analyses

    • Edit values

    • Obtain information on the composition of a KPI

    • Create tables from templates

    • Open saved tables

    • Run what-if analyses

    Data management tab

    You can manage data.

    You have the following options: 

    • Merge existing dimension combinations and/or analysis objects.

    • Delete existing dimension combinations

    • Deactivate dimension combinations

    • Activate saving points

    • Deactivate saving points

    KPIs tab

    • You can enter base KPI values. Fields with a blue background indicate calculated values. Fields with a white background are editable. Fields with a gray background are not editable and indicate KPIs that are not defined for the analysis object displayed in the dimension displayed (for example, because the rule set has now changed or because an analysis object no longer exists).

    Administration tab

    You can import configuration files, and manage dimension types, dimensions, input screens, rule sets, table templates, users, and user groups.

    Procedure

    1. Click ARIS > Administration or ARIS > Explorer. The Administration or Explorer tab opens.

    2. Log in to the database.

    3. Click Navigation Navigation in the bar panel if the Navigation bar is not activated yet.

    4. In the Explorer tree, click the folder Scheduled reports Scheduled reports.

    5. To create a schedule, click New New > Report Create scheduled report. The Report Automation Wizard opens.

    6. Specify the name of the first schedule, e. g, Import Alfabet assets daily.

    7. Specify the password of the current user, and click Next.

    8. Select the Import all Alfabet assets report that you have created earlier, and click Next.

    9. Select the database group for the Alfabet assets to be saved in, and click Next.

    10. Specify when and how often the report should be executed, and click Finish.

    11. Create the second schedule for the Synchronize Alfabet assets report to be executed. The steps to be carried out are similar. In this case, select the database as start context.

    The reports will be executed as defined. If the first execution is in the future, the report is automatically active and runs as soon as the defined point in time is reached.

    Back to the use case