Create macro

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

  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 a macro. The macro categories are displayed.
  5. Click the category to which you want to add the macro or create a new category.
  6. Click New > Macro Macro. The Script Wizard opens.
  7. 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.
  8. 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.
  9. 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.

  10. 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 existing script to suit your requirements. To obtain information on ARIS Script commands, move the mouse pointer to a command in the script code and press the F1 key.

  11. Click Debug > Check syntax in the menu bar. If syntax errors occurred in the script you can quickly eliminate them using the list output.
  12. Save the macro.
  13. Check the script before releasing it. To do so, open the script and click Run 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.

See also

What is a macro?

Configure quick-start for frequently used reports

Configure quick-start for frequently used semantic checks

Restrict script access to specific user groups