Use case: How to work with report script templates
This use case illustrates how you create your own report script from a report script template.
Report script templates are predefined report scripts, which you can adapt according to your requirements in the design view of Script Editor. No programming knowledge is necessary to create a report script in design view.
To create report scripts using report script templates, you need to be familiar with ARIS Method.
Scenario
You want to evaluate EPCs in your database using a report. In particular, you want to output all EPCs as graphics and a list of the functions contained including a detailed description and information on times and costs. Your report should be executable on all groups of your database.
To do this, you create a report script from a report script template and set the relevant queries.
You have selected the appropriate perspective in the Perspective Wizard so that all relevant folders are displayed on the Administration tab.
You have selected the Configuration & Administration working environment in the Perspective Wizard.
You have the required privileges for the different tasks. The various privileges are listed in the procedure descriptions below.
Double-click an ARIS Server in the Navigation bar.
In the navigation tree, click the folder Evaluations > Reports.
Right-click the category to which you want to assign the report script or create a new category.
Select 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.
Click Next.
Select Group as the context.
This ensures that the report can be run for all groups of a database.
Click Next.
Select Use report script template (design view).
Select the Blank template.
As output formats, select HTML and RTF.
This allows the report to be output in HTML or RTF format.
Click Next.
Select Use cover page.
This results in a cover page being output during report creation, which you can then set up.
Click Finish.
The report script is based on the selected template, opens in design view, and is saved in the selected category.
To hide the cover page displayed, click the Collapse () button in the Structure column.
Your report script now looks as follows.
Example: Blank template report script in design view
To display the cover page, click Expand in the Cover page row of the Structure column.
The cover page is displayed.
Click anywhere in the displayed cover page and enter the title as text, for example, Evaluation of EPCs in selected groups.
Insert a line break behind the title.
In the new line, enter the text Date:.
Insert a text box behind it to display the current date.
Right-click behind Date: and select Insert > Text field.
Select Date for the text box.
Click OK.
Select the line with the title, and, in the tab bar, select SansSerif as the font type, 20 as the font size, Bold as the font style, and Centered as the alignment.
Click the Collapse () button in the Structure column.
The cover page is hidden.
The cover page is set and is displayed reduced to one line. The current date of the text box is inserted when the report is run. The cover page of your report script looks as follows when it is expanded.
In headers and footers general information is output, such as company name, report name, date, and page numbers. You can insert the relevant text fields in header and footer.
Select the Table of contents entry from the Available text fields list.
Click OK.
A Static area section with a Table of contents text box is automatically inserted. The table of contents is automatically created and displayed when the report is run. Your report now looks as follows.
The group path of each group is to be output as a first-level heading. To output the heading for each group, you must insert the heading in the Structure of report scripts in the design view area of the Selected groups section.
All EPCs of the selected groups are to be queried and output as graphics. Moreover, the name of each model is to be displayed as heading of the corresponding model.
For this purpose, you insert a subsection for the relevant query in the repetition area, define the data for the query, and output the heading and the EPC graphic using a data field.
A list of the functions contained in the individual EPCs is to be output. Moreover, the specified descriptions and the data on time and costs are displayed in each case.
For this, insert a data table in the repetition area of the EPC query. The data table queries all functions of the EPCs, and the name, description, time, and costs of the functions are output using data fields.
Right-click the second row under the title Functions.
Click Insert >Data field in the Start tab bar.
Select the data element Name.
Click Next.
Click Finish.
A data field which lists the individual function names of an EPC is inserted.
In the same manner, in the second row of the Description column, insert a data field with the Attribute (filterable by type) data element and the Description/Definition attribute type.
In the remaining columns, insert additional data fields with the Attribute (filterable by type) data element in the same way.
For the Average processing time column, select the Average processing time attribute type.
For the Costs column, select the Costs attribute type.
The individual queries are inserted into the second row of the data table. Your report should look as follows.