i4connected Knowledgebase 5.6

Report definitions

Abstract

Check out this description of the i4connected Report definitions and learn more about how to manage them.

Reports are generated using SQL Reporting services which need information from the i4connected application in order to choose the right data for the report. Hence, the users having the appropriate permissions, can manually fill in static report definitions.

Viewing the list of Report definitions

The Reports panel lists all the Report definitions to which the currently logged in user has access to.

Reports_list.jpg

The Reports list panel

In this view, Reports visibility is granted on basis of the following prerequisites:

The list of Reports can be filtered by typing in the search field the report name or part of the report name. The list will be filtered to display only the corresponding results.

Tip

For more details about the Simple filtering mechanism please also visit the dedicated article here.

By clicking the Refresh toolbar button the user can update the list of Reports.

Adding Report definitions

The top menu of the Reports panel provides the option to add new reports in the i4connected system, for users having the Manage report definitions permission enabled.

By clicking the Add button, the Add report panel is opened, allowing the user to set up a new i4connected report based on an existing Reporting Service report.

Add_report_panel.jpg

Add report panel

Following Report properties and parameters can be added by the user, in the Report panel:

  • Report name (mandatory) - the name of the i4connected report. This name will be listed in the Reports panel as well as anywhere else in the i4connected portal.

  • Description - the optional description of the report.

  • Select owner - name of the new Report owner.

    Note

    When adding a new Report the creator user is by default set as Report owner.

    The Owner can be changed in Edit report mode, by all the users having access to the Report.

  • Server report URL (mandatory) - the path to the appropriate directory in Reporting Service, which contains the targeted report. The Server report url can be either manually typed in the designated field or can be selected from the list of reported addresses, by clicking the Browse reports button.

    Browse_reports.jpg

    The Select report addresses panel

    Note

    This URL path must exclude the path to the server and Reporting Service, as this path should be already existing in the i4connected portal's configuration files. The Server report URL must start with a forward slash /.

  • Email subject (mandatory) - the subject of the Report email that will be sent to the user.

  • Email body (mandatory) - the body of the Report email sent to the user.

  • Report group (mandatory) - the report group to which the report belongs.

  • Photo - the photo displayed in the i4connected portal, next to the report's name and description.

  • Report parameters - the report parameters are used for scheduling the i4connected report. If a report parameter is enabled, it will be mandatory to valuate it, when scheduling the report. If the report parameter is disabled, it will not be available when scheduling the report. The following report parameters can be enabled and used for scheduling reports: Organizational Units, Sites, Areas, Devices, Site Types, Events, Event Types and Event Groups.

  • Custom report parameters - allow the administrator to set up custom parameters by specifying a Name and format Type. Also, the administrator can define if the custom parameter is required or optional. All the custom parameters for the current report are listed in the Custom report parameters area. The following custom parameter types can be used:

    • String - expects a textual value (e.g. "day")

    • Number - expects a numerical value (e.g. "1")

    • Boolean - expects a Boolean value (the user can select between values "Yes" and "No")

    • DateTime - expects a date (the user can select the date and time from a calendar view)

    • StringArray - expects a range of textual values (e.g. "day", "month", etc)

    • NumberArray - expects a range of numerical values (e.g. "1", "2", "3", etc)

    Custom_report_parameters.jpg

    Custom report parameters area

    The actual valuation of custom parameter occurs only at the report scheduling step.

    By clicking on the Browse report parameters field, the Select report parameters panel is opened. In this view, all custom parameters existing in the Reporting server are listed, allowing the user to reuse them.

    Select_report_params.jpg

    Select Report parameters panel

Editing Report definitions

Changing a Report's parameters and general settings can be done in the Edit report panel, by users users having the Manage report definitions permission enabled.

Edit_report_panel.jpg

The Edit report panel

In this view users will find all the properties and parameters described under Adding report definitions article.

Note

The Reports that have been previously scheduled or archived, will no longer allow the user to organise changes at level of Custom parameters. An information message is displayed: "You can not add or edit custom report parameters because report is scheduled by current user or other users."

Custom_reps_info.jpg

Custom report parameters locked

By clicking the Reset button, all the organized but unsaved changes can be reset.

Reset_report.jpg

Reset button

The Edit Report panel provides the user with two save options:

  • Save and Close button will preserve the changes and close the Edit report panel.

  • Save and Add New button will preserve the changes and consequently the Add report panel will be opened.

Delete Report definitions

Users having at least the Manage report definitions permission enabled can remove redundant Report definitions by clicking the Delete toolbar button of the Edit report panel.

Delete_report.jpg

Reset button

The Delete Report panel asks the confirmation code in order to delete the Report. Once deleted, the report will no longer be visible in the Reports list.

Warning

When deleting a Report definition all its associated Report schedules will be deleted as well.

Delete_report.jpg

Delete Report panel