Configuring DMS Advanced Reports
Prerequisites
- The Advanced Reporting for DMS extension is installed, included in the active project, configured, and the templates are synchronized.
Refer to the Setup Checklist for DMS Advanced Reports.
Configure a Report Rule
A report rule creates an association between a target object (for example, a SiPass server) and a particular type of report (for example, Door Access Summary). Once such a rule is created, selecting the target object allows the associated report to be executed in the Application Viewer tab.
- System Manager is in Engineering mode.
- System Browser is in Management View.
- The default view is set to Show Description.
- In System Browser, select Project > System Settings > Application Link Rules.
- Select the Rule Editor tab.
- In System Browser, select the Manual navigation check box.
- In the Trigger Conditions expander, drag one or more report-target objects from any view in System Browser onto the Path area.
NOTE: You can select a parent folder to add a building or partition.
- For reference information, see Rule Editor Workspace.
- In the Output expander, from the Application drop-down list, select the type of report, which in this case can be:
- DMS Report (Alarm Summary Report)
- DMS Report (Door Access Summary report)
- The parameters fields for the selected report are displayed underneath.
- Do not modify the Report Template. This corresponds to selected report type.
- If the report is intended for manual execution in the viewer:
- In the Format field select html.
- There is no need to set the remaining fields, as the values set here will not apply when a report is executed manually. When a report is executed in Application Viewer, the parameters applied will be those entered by the operator into the Parameters dialog box.
- If the report is intended for scheduled/automated execution, for example in a reaction or script:
- In the Format field select pdf, docx, or xslx.
- Set the remaining fields as required. The values set here will be propagated to any fixed link you create from this rule. But you can also adjust these parameters in the fixed links themselves.
- Click Save As
.
- In the Save Object As dialog box, select the Application Link Rules destination folder, then enter a name and description for the report rule.
- Click OK.
- The new rule is added to System Browser.
To test the rule (only if output format is html) see Execute a DMS Report From a Target Object.
Create a Link to Execute a DMS Report
Operators can run a DMS report by selecting a target object for which a report rule was configured, as described above. However, you can also provide a link through which an operator can directly run a report, without having to find the target object. These links are also used for the automated execution of reports, in macros, scripts or reactions.
- A report rule is configured, that associates a target object to a DMS Report.
- System Manager is in Operating mode.
- In System Browser, select the target object of the report rule.
- In the Application Viewer tab, select the desired report.
NOTE: If the target object has only one associated report, it is automatically selected.
- The Parameters dialog box for the report displays. However you do not need to configure these here, as the entered values will not be stored in the link.
Instead, the parameter values stored in the link are those set in the Output expander of the report rule.
- Click Save As .
- In the Save As dialog box, enter the name and description for the link.
- The saved link displays in the Applications > Links folder. If you select the link, the Extended Operation tab shows the report parameters configured in the report rule.
To test the link see Execute a DMS Report from a Link.
Set Credentials and Parameters for a DMS Report Link
When a link is manually selected by an operator, the corresponding report is executed with the operator's credentials, and applying the parameters that the operator enters in the Parameter dialog box. However, if a link will be used for automated execution of a report, you must configure the credentials under which the report will be executed, and the parameter values to apply.
- A link to execute a DMS report is configured.
- System Manager is in Operating mode.
- System Browser is in Application View.
- In System Browser, select Applications > Links > [DMS Report link].
- Click Set Credentials
.
- From the drop-down list, select the User Account under which the report will be executed.
- Click OK.
- In the Extended Operation tab, adjust the values P2 through P9 as required.
These parameter values will be applied when the report link is automatically executed, for example in a script or reaction. In particular:
- The P2 value must be PDF, DOCX, or XSLS. This allows the automated report output to be saved to a file.
Automate Execution of a DMS Report
You can configure a reaction that, for example, executes a report at specified intervals, and stores the output on disk, or sends it to an email recipient.
- You configured a DMS report rule that associates a target object to a DMS Report.
- System Manager is in Engineering mode.
- System Browser is in Management View.
- In System Browser select Applications > Logic > Reactions.
- Select the Reaction tab.
- Open the Triggers expander and then open the Time and Organization Modes expander.
- Set when you want the report to be generated. For example, to run the report every working day at 6pm:
- In Set Start Time enter 6:00:00 PM.
- Deselect the Set End Time check box.
- Under Effective Days set the Recurrence to Weekly (every 1 week on...) and select the check boxes for days Monday through Friday.
- Open the Output expander and then open the Actions expander.
- From under Applications > Links, drag the desired report link into the Scope/Target area.
- Expand the parameters in the Command column.
- From the drop-down list at the top, select either:
- Execute: The report output will be saved to a file on disk.
- Email: The report output will be saved to a file on disk, and also emailed as an attachment to the configured recipient.
- From the Output Format drop-down list, select PDF, XSLX, or DOCX.
NOTE: This value must match the P2 value configured in the Extended Operation tab for the report link. See Set Credentials and Parameters for a Report Link.
- In the File Name field, enter the prefix for naming the report output files. This will be concatenated with the timestamp to form the file name.
- In File Path, enter the location on disk where the report files will be stored.
- In Section, select Save document.
- In the Time Stamp field, enter the desired format for the timestamp that is appended to the report name. For example, dd-mm-yy-hh-mm.
- Click Save As .
- In the Save Object As dialog:
- Select the location where you want to save the reaction.
- Enter a name and description for the reaction.
- Click OK.
- The report will be automatically executed with the specified schedule (every workday at 6pm) and the output saved as a file on disk.
