Authoring reports

This topic applies to ArcEditor and ArcInfo only.

Overview of reporting in Workflow Manager

Workflow Manager provides a simple reporting engine that allows you to build reports about the work being managed in your Workflow Manager system. The Report Manager is used to build and edit the reports. Users with the necessary privileges can configure reports in the Workflow Manager client application.

Profile

• Display Name—The display name is used to identify the report in the report table of contents in both the Configuration Manager and the client application.
• Title—The title that will appear at the top of the report when generated.
• Description (Optional)—Allows you to enter more descriptive information about the information being summarized in the report. This text will be displayed to the user under the title when using the report style sheet provided with Workflow Manager.
• Category—The category serves as an organizational tool for the reports. Use this property to organize your reports. The information entered here will be used to build the report table of contents seen in the Configuration Manager and client applications.

Report Fields

The fields selected on this tab represent the information that will be displayed in your reports. These fields also participate in summarizing and grouping the report results.

Display Names

You can replace a field name with an alias—your own descriptive text—to help clarify its meaning. Also, choose the order that the fields will be presented to the user.

Input Filter

You can specify queries and conditions to limit the information used in the report results. For example, you may only want to report on active jobs or work assigned to a particular user or group of users.

Row Summary

With this option, you can group records together and calculate summary statistics. For example, you may want to know how many jobs there are for each unique combination of job status, job type, and assignment.

Report Sections

You may want to further organize your report by creating groups of records based on a specific field. You can do this by checking the Enable Report Sections check box and choosing which report field the groups should be based on. If you want to summarize information for this group of records, choose the field and calculation type.

Output Style

When a report is executed, Workflow Manager returns XML. Workflow Manager uses XSLT style sheets to transform the XML into a more user-friendly format. A couple of different style sheets are provided with Workflow Manager in the <Workflow Manager installation location>/Config/Reporting/Stylesheets directory. You are presented with a preview of the report by clicking Preview Report.

Permissions

You can control who accesses the reports in the client application by restricting access for certain groups in your Workflow Manager system. For example, you may want only users that belong to the managers group to be able to view reports in the system. By checking the Restrict access to the following group check box and enabling the Manager group, you make users in the Technician group unable to see this report listed in the application when they activate the report view.

Note:

Users that have admin access will be able to view and execute all reports in the repositories they have admin access to.

Managing Workflow Manager reports

How to create a Workflow Manager report

Prerequisite:

Open Workflow Manager Administrator and connect to your Workflow Manager database.

You will define the look and feel of your reports in Workflow Manager Administrator. These reports will be available to the users via the report view in the application.

Steps:

1. Select the Reports folder.
2. Right-click and click Add Report to create a new report.

   The Report Manager dialog box appears with the General tab active.

3. Enter a display name, title, and category.

   These are required for creating a report.

4. On the Report Fields tab, select the fields you want to report on by double-clicking or dragging them to the column on the right.

   The selected fields are added to the right panel.

5. After selecting the fields, modify how they will be presented to your users on the Display Names tab.

   For example, you can change the alias from JTX_JOB_TYPES.JOB_TYPE to Job Type.

6. On the Input Filtering tab, you can define the query you want to apply to your reports.

   For example, you may want your reports to show only high-priority jobs.

7. Click the Rows/Section tab to calculate summary statistics for each unique combination of records specified by the report fields selected.

   You can calculate the maximum, minimum, sum, count, average, and standard deviation for any numerical field in the Workflow Manager system tables being used in the report.

8. Click the Grouping/Summary tab to set the field you want to group your results on.

   By checking the Enable Record Grouping check box, you select the first field in the Report Fields tab as the group field.

9. Select a calculation type from the drop-down list and specify a label.

   The calculation is performed on the first field on the Report Fields tab.

10. Select the Output Style tab to choose a style sheet for your report; by default, the Select New Stylesheet button is selected.
11. Click the Browse button to navigate to the location of the style sheet you want to use.

    The sample templates provided by Workflow Manager are located at <Workflow Manager Installation location>\Config\Reporting\Stylesheets.

12. You can preview the report to make sure information presented the way you want.
13. Restrict report access to a certain group or groups by clicking Restrict access to the following groups and selecting the desired group(s). Click OK.

    The report is added to the list of reports in Configuration Manager. It is also available to users in the Workflow Manager application.

How to edit a Workflow Manager report

Prerequisite:

Open Workflow Manager Administrator and connect to your Workflow Manager database.

After reports have been created, you can still make changes to them.

Steps:

1. Select the Reports folder.

   A list of existing reports is displayed on the right view.

2. Select an existing report.
3. Right-click and click Edit Item to modify the properties of the selected report.
4. Navigate through the Report Manager tabs to edit the report properties as desired.

How to delete a Workflow Manager report

Prerequisite:

Open Workflow Manager Administrator and connect to your Workflow Manager database.

You can delete reports that are no longer used or applicable from your repository. A deleted report will not be available for execution in the application.

Steps:

1. Select the Reports folder.
2. Select an existing report.
3. Right-click and click Delete Item to delete the selected report.