Write a report script. Authorized users on this tenant can run all scripts.
If you want to adapt an ARIS standard script, always make changes to copies. Standard scripts and JS files are overwritten each time the program is updated. Any changes to original files are lost.
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
Procedure
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 the Reports folder. The report categories are displayed.
Right-click the category to which you want to assign the report script or create a new category.
Click New > Report. 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. You can specify security settings to prevent unauthorized script changes or restrict execution.
Disable the Available to users check box if required - for example, if you have created a report but have not completely programmed the script yet. Scripts can still be edited in the Script Wizard. Click Next.
Select the database items for which the script is to be started, and click Next.
Select an evaluation filter if necessary. The method content is restricted to the content that is activated in both the method filter you used when logging in to the database and the evaluation filter you selected.
Enable the Generate output file check box, the Enter source text (code view) option, and, in the Supported output formats box, enable the file formats that users can select for the output when running the report.
If required, specify additional settings and click Finish. 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 reports and semantic checks. 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.
ARIS 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.
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.
Check the script before releasing it. Activate the Debug tab bar and click Run (F9).
The script is created. If you made it available to all users, they can select it on this ARIS Design Server in the Report Wizard.
ARIS 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.
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.
If you provide report scripts for ARIS Publisher you need to ensure that reports evaluate only the contexts Database, Group, Model, or Object, that they access items in read-only mode and do not call dialogs, and that only methods allowed for ARIS Publisher are used.