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.

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

Procedure

  1. Write report scripts.

    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. Click Next.

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

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

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

    12. Click Finish. Script Editor opens.

    13. Write the code, for example:

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

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

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

      This report will synchronize already imported Alfabet objects.

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

    16. Use this code as example:

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

      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 the synchronization automatically ,create two scheduled reports for your two reports to be execute automatically.

    Prerequisite

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

    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