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.
Prerequisite
You are
for this tenant.The administrator roles described in the following are defined via various privileges at the server and database level. Depending on the roles assigned to the administrators they can carry out specific functions.
superuser
The user superuser is created automatically. By default, this user is assigned the User management, License management, and Configuration administrator function privileges. This user can also enable this function privilege for other users. Users of the superuser type do not use up a license. They manage the system administration, but cannot use ARIS products due to license restrictions. The default password is superuser. You should change the default password to prevent unauthorized access. The password of the superuser is very important, as it is the only user who cannot be deleted. You can change all user data except for the user name. The superuser can recreate the other default users (system, arisservice, guest) if they were deleted.
system
The system user system assumes the of the system administrator and has all function and access privileges in all databases of a tenant. Authorized persons can use this emergency user to log in to any database, even if you are using an external system, such as LDAP, for authentication.
The name system cannot be changed. The System user check box for this user (Function privileges properties page in ARIS Architect) cannot be disabled either. You should immediately change the password manager to prevent unauthorized access.
To avoid problems, you should create additional system users. Having more than one system user can avoid problems, for example, if one system user has forgotten his password. If you forgot the passwords of all your system users, the full range of functions is no longer available and full data access is no longer possible.
The following administrator roles are defined:
Database administrators
Database administrators require the Database administrator function privilege in ARIS Administration. Users with this role have all function and access privileges and can edit data of all databases of the client.
Database administrators perform the following tasks at the server level:
Create databases
Delete databases
Backup databases
Restore databases using backups
Reorganize databases
Users with defined function privileges can perform additional actions at the database level.
Configuration administrators
A Configuration administrator requires the Configuration administrator function privilege in ARIS Administration.
They perform the following tasks:
Define the modeling conventions and adapt the appearance to match the corporate design of the company.
Define the contents of ARIS Method that are available in the database.
Script administrators
Script administrators require the Script administrator function privilege in ARIS Administration.
Script administrators perform the following tasks:
Write report scripts
Delete scripts
Transfer custom or modified scripts of previous ARIS versions
Analysis publisher
Analysis publishers require the function privilege of the same name in ARIS Administration.
Analysis publishers perform the following actions:
Analysis administrators
Analysis administrators require the function privilege of the same name in ARIS Administration.
Analysis administrators perform the following actions:
You require knowledge of ARIS Method and of the JavaScript and ARIS Script programming languages.
Procedure
In ARIS Architect, 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 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.
Reports/Macros/Report templates and files
Do not make any changes to the standard scripts we supply. Always adapt copies of report, macro, and JS files, and any other files. There are exceptions, for example, the file atsall<language code>.js.
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 tenant in the Report Wizard.
If you need additional evaluation scripts, you can create report output in the design view. If you are familiar with the JavaScript and ARIS Script programming languages, you can write your own report scripts or adapt .
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.
Reports/Macros/Report templates and files
Do not make any changes to the standard scripts we supply. Always adapt copies of report, macro, and JS files, and any other files. There are exceptions, for example, the file atsall<language code>.js.
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.