Skip to main content

Get help for ARIS

Macro properties

When you select a macro, you can do the following:

Edit macro properties

You can rename macro scripts in multiple languages or change other text attributes.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Select the language in which you want to edit the text fields.

  6. Overwrite the name, subject, author, company, or description, as required.

  7. Select the next language, if required, and edit the text fields in turn.

  8. Click Apply.

The changes are saved.

You can decide whether a macro script is available or not.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Enable Available to users.

  6. Click Apply.

Authorized users can use the macro.

You can specify the database items for which the script can be started. Users can run the script only for the database items you specify as context.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Click Context and enable the related options. If you enabled Model or Object, you can specify the types for which users can start the script.

    If you select model types on which derived model types are based and the Include derived types check box is not enabled, the script can still be run for the derived model types. If you enable model types on which derived model types are based, but have disabled the derived types, the script is still available for the disabled derived model types.

  6. Click Apply to save the changes.

The script is available for the selected context.

.

You can specify events that trigger macro execution.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Click Context and in the Context type field, select Event-based context.

  6. Select the required event. If events are missing, click Add template Add event.

  7. Select the missing events and click Add template Add.

  8. If you enable Can be started only by an event, the macro can no longer be started by users.

The macro uses the selected events.

Use evaluation filters to reduce the number of items that are evaluated and listed in the output.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Click Evaluation filter and enable Use evaluation filter. All evaluation filters created for this tenant are listed.

  6. Select the related filter.

  7. Click Apply to save the changes.

The script evaluates only items that are contained in the evaluation filter.

You can specify whether a script generates an output file and select the file type of the output file.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Click Output.

  6. Enable Generate output file and select the required file types.

  7. Click Apply to save the changes.

You can select the file formats to use for the generated output files. If in the scripts you use fonts that are not installed on the operating system on the machine on which ARIS server is running, you must add these missing fonts. If a font is missing, the content using the font is not readable. The missing fonts are not rendered correctly in the output files, or when pasting a copied model to another application.

If the PDF, RTF, or DOC format was enabled as possible output format for a script, you can change the page properties for generated output files.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Click Page layout and change the settings as required.

  6. Click Apply to save the changes.

Output files in the PDF, RTF, or DOC format use the defined page settings.

You can change the set of files that the script imports during runtime.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations and select Macros.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Click Advanced properties.

  6. If the script imports files at runtime, related common files are enabled. If you disable files, the script may no longer run properly.

  7. Click Apply to save the changes.

The advanced properties are saved.