Skip to main content

Get help for ARIS

Manage evaluation scripts

ARIS is supplied with numerous standard scripts. Authorized ARIS users can analyze and process data using scripts that you provide.

If you have the Admin role and the Script administrator privilege, you can manage ARIS reports, scheduled reports, semantic checks, and macros for each tenant. You can also manage all files that are used by different scripts and handle fonts used for evaluation. To manage evaluation scripts, click Application launcher Application launcher > Administration Administration > Evaluations.

When updating ARIS, all ARIS standard scripts and files are overwritten and customer-specific changes to these files are discarded. Copied scripts and files and those you have created yourself are not overwritten. Always adapt copies of report, macro, and JS files, and any other files.

If you are familiar with the JavaScript and ARIS Script programming languages, you can edit or write your own scrips using the related API for ARIS reports and macros.

What do you want to do?

The easiest way to write a script is to adapt a copy of an existing one.

  1. Click Application launcher Application launcher > Administration Administration > Script Editor and open the required file.

  2. Click Enable editing > Create a copy. The script is copied, and you can modify the code as required.

  3. Write the script in Script Editor.

    ARIS Script Editor supports you with all the functions of a common script editor, e.g., monitoring variables or you can create a list indicating where a method selected in the script is used. You can specify script texts in other languages for translation. Use the commands provided. To obtain information on ARIS Script commands, move the mouse pointer to a command in the script code. For more information, click Help to show all commands or open the Script API help. You can use individual Java classes in your scripts.

    In the ARIS Script Editor, copy and paste are only available if you use secure https connections. Otherwise, the browser blocks the functionality. Make sure you allow copy and paste when your browser asks for permission. This question appears only once per server. If you have denied the use, change the browser settings.

Further information and scripting tutorials are available in the ARIS Community at:

After you have written your script, you can check the validity of the syntax of the code.

  1. Click Debug.

  2. Click Run Run.

  3. Select the execution context. Depending on the context defined, this can be a database, group, or model, etc. This context applies until you click Configure Debug data > Clear configuration.svg Clear configuration.

  4. Specify the output options, and click Finish.

The script runs and the steps being performed are displayed. If errors occur during execution, they are displayed and execution is paused.

ARIS Script Editor supports you with all the functions of a common script editor, e.g., monitoring variables or you can create a list indicating where a method selected in the script is used.

Specify report parameters

Manage common files

Manage macros

Manage semantic checks

Manage scheduled reports

Manage fonts used by scripts and model generation