Skip to main content

Get help for ARIS

Report properties

You can edit the report properties.

Change the name, subject, author, company, and description in multiple languages.

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

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations Evaluations and select Reports.

  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.

.

Make a report available to users

You can decide whether users can start a report or not.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations Evaluations and select Reports.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Enable Available to users.

    If a macro that executes the report script will get started by an event, you must also enable the Available to users check box for the report script. To use an event to start a macro, in the Edit macro properties - Context dialog of the macro, select Event in the Content field.

  6. Click Apply.

Authorized users can execute the report.

.

Make a report available in ARIS

By default, some reports are available in ARIS. You can easily change the set of reports available in ARIS.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations Evaluations and select Reports.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Disable Available only in Administration client.

  6. Click Apply.

The report is available in ARIS.

.

Check the 'Open dialog', 'Recoverable', and 'Write to database' settings

You can check general properties such as the related ARIS version and the GUID of a script. If you want to start a report by schedule, make sure the script does not require user input during runtime. If the Open dialog control is enabled, you cannot run a script as a scheduled report. Do not change the settings Open dialog or Writes to database in ARIS Administration. If you disable the settings, the script can no longer open dialogs or write to databases. In this case the scripts might not execute properly. If you change the settings, the script requires modification in Administration client to run without exceptions.

If the Recoverable control is enabled, a unique runtime ID is written or received from Process Governance. If the report runs successfully, the ID is deleted. If the report execution is interrupted, a caller can restart the report with exactly this runtime ID. All data stored for this ID (key/value pairs) are added to the script. The script can now use these values to determine what happened during the last execution and resume. For more information about advanced script management, see the Administration client online help.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations Evaluations and select Reports.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

The General settings are displayed.

How to handle interrupted report execution

If the ARIS server is restarted unexpectedly or data is restored while a report is running, the report is stopped immediately. The state of execution remains unclear. This can lead to data inconsistency if, for example, a Process Governance workflow was executing several reports that modify data or a long-running report was writing to the database.

If you activate the Recoverable control (Report properties > General) for related reports, a unique runtime ID is written or received from Process Governance. If the report runs successfully, the ID is deleted. If report execution is interrupted, a caller can restart the report with exactly this runtime ID. All data stored for this ID (key/value pairs) are added to the script. The script can now use these values to determine what happened during the last execution and resume.

To test this, start the script debugger in Administration client and the runtime ID is created. If you interrupt the execution of the debugger (Stop) and start it again (Start/Step into/Step over), the key/value pairs are stored. The stored values are retained and the script can react to them. The runtime ID is not deleted until you call Reset execution data or you close the debugger.

Select an evaluation filter to reduce the number of evaluated items.

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 Evaluations and select Reports.

  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.

.

Change output options

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 Evaluations and select Reports.

  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.

.

Change page layout

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 Evaluations and select Reports.

  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.

.

Change advanced properties, such as 'Enable timeout', 'Complexity', and imported files

You can change advanced properties, such as Enable timeout, Complexity, and imported files.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations Evaluations and select Reports.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. Click Advanced properties.

  6. If ARIS slows down because of long-running reports, enable Enable timeout and enter the allowed time interval before the report is automatically terminated if no useful result is delivered during this time.

  7. If you want to optimize load balancing, in the Complexity field select the required value for resource usage.

  8. If the script imports files at runtime, the related files are enabled.

  9. Click Apply to save the changes.

The advanced properties are saved.

.

Change security settings

By default, all users of a tenant are allowed to access report scripts.

  1. Click Application launcher Application launcher > Administration Administration.

  2. Click Evaluations Evaluations and select Reports.

  3. Select the related category and select the script.

  4. Click Edit Edit properties.

  5. In the Author field, press the keys CTRL+ALT+SHIFT+K. The Security settings are shown at the bottom of the page.

  6. Select the required options.

    You can allow execution but deny editing to prevent users from changing the script code. Or you can restrict execution to users whose assigned licenses contain a defined string. You can also combine both options.

  7. Click OK.

  8. Enter a password.

      Warning

      You must remember this password. Otherwise, you cannot modify the script code or change the security settings for this script again.

    1. Click Apply to save the changes.

    Security settings are applied.