A report is a script that can be applied to similar database content. You can use a report, for example, to collect database content and group it according to specific aspects, output the relationships between database elements, generate comparison tables, or display multiple uses of database items. You can also use reports to change database content, such as entering attribute values or correcting the layout of models.
You can generate reports in the repository or in the modeling component for the selected objects or the open model.
ARIS is supplied with numerous standard scripts. Authorized ARIS users can analyze and process data using scripts that you provide. The package and license that you have purchased will determine the range of reports available to you.
If you have the ARIS Enterprise Admin license privilege and the Script administrator function privilege, you can perform basic report management in ARIS Administration. If you are familiar with the JavaScript and ARIS Script programming languages, you can edit or write your own scrips in ARIS Architect.
To manage reports in ARIS Administration, click Application launcher >
Administration >
Configuration > Evaluations and select Reports. If you modify scripts, always make the changes in copies of standard scripts and files.
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.
All scripts are organized in a clear structure using categories.
Categories
You can if you have no category selected.
Use categories to organize your scripts in a clear structure.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Click Create category.
Enter the name of the new category and click Apply.
The category is displayed only in the current language.
To display the category in multiple interface languages, you must rename the category in each language. If you do not specify a category in a particular language, the category is displayed in English.
If you select a category, you can do the following:
You can change the name of a category or specify the name in a different language. You cannot change the name of the Standard category.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the category and click Rename.
Select the related language.
Enter the name in the selected language and click Apply.
The category is renamed in the current language.
You can delete a category and all the scripts that it contains. Software AG recommends that you first export the scripts in order to have backup files.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the category that you want to delete. You cannot delete the Standard category.
Click Delete.
Click Delete to confirm.
The category and all scripts that it contains are deleted.
You can import scripts from export files or import common files that a script uses during runtime. This enables you to provide scripts from another tenant or import scripts from a previous version.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Click the category into which you want to import the script.
Click Import.
Select the related import file and click Open.
If the script already exists in a category, you must confirm in order to import a copy into the selected category.
If the script executes imported common files during runtime, you can enable the required file and confirm the import of the file. Otherwise, the current common file on the tenant is used.
The script is imported.
If you select a report, you can do the following:
Edit report properties
You can rename report scripts in multiple languages or change other text attributes.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
Select the language in which you want to edit the text fields.
Overwrite the name, subject, author, company, or description, as required.
Select the next language, if required, and edit the text fields in turn.
Click Apply.
The changes are saved.
.
You can decide whether users can start a report or not.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
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.
Click Apply.
Authorized users can execute the report.
.
By default, some reports are available in ARIS. You can easily change the set of reports available in ARIS.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
Disable Available only in ARIS Architect.
Click Apply.
The report is available in ARIS.
.
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 ARIS Architect 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. , 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 ARIS Architect online help.
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 ARIS Architect 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.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
The General settings are displayed.
Use evaluation filters to reduce the number of items that are evaluated and listed in the output.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
Click Evaluation filter and enable Use evaluation filter. All evaluation filters created for this tenant are listed.
Select the related filter.
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.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
Click Output.
Enable Generate output file and select the required file types.
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.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script..
Click Edit properties.
Click Page layout and change the settings as required.
Click Apply to save the changes.
Output files in the PDF, RTF, or DOC format use the defined page settings.
.
You can change advanced properties, such as Enable timeout, Complexity, and imported files.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
Click Advanced properties.
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.
If you want to optimize load balancing, in the Complexity field select the required value for resource usage.
If the script imports files at runtime, the related files are enabled.
Click Apply to save the changes.
The advanced properties are saved.
.
By default, all users of a tenant are allowed to access report scripts.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Select the related category and select the script.
Click Edit properties.
In the Author field, press the keys CTRL+ALT+SHIFT+K. The Security settings are shown at the bottom of the page.
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.
Click OK.
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.
Click Apply to save the changes.
Security settings are applied.
Duplicate standard scripts and files to prevent your changes from being lost. During a system update, all standard scripts and files are automatically overwritten to provide you with the newest features.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Click the category in which you keep the script.
Select the related script and click Duplicate.
The script has been duplicated.
You can modify the duplicated script. The duplicated script will not be overwritten during an ARIS update because it has a new GUID.
You can delete scripts that you no longer require, such asa report scrips. If you export the scripts first, you can make them available again at any time.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Click the category in which you keep the script.
Select the script and click Delete.
Click Delete to confirm.
The script is no longer available on the tenant.
You can save scripts as export files if you want to store different versions or to make scripts available on multiple tenants.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Click the category in which you keep the script.
Select the script and click Export.
If the script executes imported common files during runtime, you can enable the required files and confirm the inclusion of the files in the export file. Otherwise, only the script is exported.
Navigate to the file location where you want to save the file and click Save.
The script has been saved.
By default, all users of a tenant have access to all scripts. You can make scripts available only to members of defined user groups.
Click Application launcher >
Administration >
Configuration > Evaluations and select Reports.
Click the category in which you keep the script.
Select the script, click Restrict access, and enable Restrict access to user groups. All user groups available on this tenant are displayed. Make sure that a related
user group was created in ARIS Administration.
Enable the related user groups and click Apply.
The script can be run only by members of the selected user groups.