name XML element (Alfabet login)

name

User name for Alfabet RESTful API. 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. Login credentials, Web service URL, and User interface URL can also be specified in the Alfabet integration property dialog of the related database.

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.

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.

    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.

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.