ARIS macros

ARIS comes with many standard macros. The macros are listed in categories on the Administration > Evaluations Evaluations > Create group Macros tab. These scripts are available depending on the package you have purchased and on the privileges the user was granted. If in the General properties dialog of a macro script the Available to users option is selected, the macro can be selected in the Macro Wizard for execution.

Macros support you in the automated context-specific execution of comprehensive actions. Use macros to automate actions on the client side. You can only change open models if you use a macro. Usually, each macro command leads to a server call, which in case of complex macros may result in significant runtime delays. In these cases, it is recommended that you write your own report scripts instead of a macro.

You can use macros to automatically run reports or semantic checks, for example.

Once models have been saved, you can automatically check adherence to corporate consistency rules, for example. Macros also assist you in:

Using event-driven macros (vetoable), you can suppress associated standard functionality. You can define a macro that starts, for example, a semantic check automatically when a user saves a model. The semantic check is triggered by the Model is to be saved (vetoable) event. To suppress the save operation for non-compliant models, you must include the line Context.setProperty("event.veto", "1") into the corresponding statement block. The model is only saved if the semantic check rules are met.You can also start Process Governance processes. Predefined, event-driven macros are available for this. They only need to be linked with an executable process within the Governance Automation Models reference database.

You start macros using either menu items or buttons.

If you are familiar with the JavaScript and ARIS Script programming languages, you can write your own macro scripts or adapt copies of existing standard scripts.

ARIS is supplied with numerous standard scripts. We generally recommend documenting all changes to scripts externally so that the documentation can be used to ensure that they are incorporated correctly during the update process.

Reports/Macros/Report templates and files

Do not make any changes to the standard scripts we supply. Always adapt copies of report, macro, and JS files, and any other files. There are exceptions, for example, the file atsall<language code>.js.

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.

If you have changed files we supplied but not copied them, before the update (updatesystemdb) they must be exported and then imported after the update. This enables you to retain your adapted standard scripts from the previous version. However, in this case you do not receive any corrections or updates to the files we supplied.

Semantic checks

We recommend creating custom rule types and custom profiles for semantic checks, in which the ARIS standard rule types and rules are referenced.

This is not possible for configurable rule types (relationship attribute rules, model attribute rules, object attribute rules, existence rules, and allocation rules). If you have added rules to these rule types, you must export the rule types before the update and then import them after the update.