Write a macro and make it available to all users connected to this ARIS Server. Modify standard macros only if this is recommended and described in product related documents. Other modifications can cause program errors.
If you want to create custom macros based on standard macro scripts, make changes to copies. Standard scripts and JS files are overwritten each time the program is updated. Any changes to original files are lost.
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.
Prerequisite
You are script administrator for this tenant.
Procedure
In ARIS Architect, click ARIS > Administration.
Click Navigation in the bar panel if the Navigation bar is not activated yet.
In the Explorer tree, double-click the Evaluations folder.
Double-click a macro. The macro categories are displayed.
Click the category to which you want to add the macro or create a new category.
Click New > Macro. The Script Wizard opens.
Specify the entries in the required languages. Entries for which a string table is specified in the script should imperatively be specified in all languages. Name and Description are especially important.
If required, disable the Available to users check box if you created a macro but have not checked it yet. Scripts can still be edited in the Script Editor (ARIS Architect). Click Next.
On the following pages, specify the database items for which the macro can be started, or select an event after which the macro will automatically be run.
You can also start a report or a semantic check with the macro. If this macro is available only to a restricted number of users, make sure that these restrictions exactly match the ones of the report or the semantic check profile to be started by this macro.
If required, specify additional settings and click Finish. If you write the macro yourself, Script Editor opens.
Write the script in Script Editor. For editing, use the commands in the Start and Debug tab bars.
Please use only methods from the object model for macros and transformation scripts.
You can adjust the script code at any time and for example, provide your own help pages. If you do not want to write a script from scratch, simply adapt the copy of an ARIS Script commands, move the mouse pointer to a command in the script code and press the F1 key.
to suit your requirements. To obtain information onARIS 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.
Click Debug > Check syntax in the menu bar. If syntax errors occurred in the script you can quickly eliminate them using the list output.
Save the macro.
Check the script before releasing it. To do so, open the script and click Run (F9).
The macro has been created. If you made it available to all users, they can select it on this tenant in the Macro Wizard.