i4connected Knowledgebase 5.6

Scheduling reports

Abstract

Yes, scheduling Reports is possible in the i4connected portal! Check out this article for more details about this functionality.

Users having the Schedule reports permission enabled, can schedule Reports in the Report schedule panel.

i4connected automatically sends the reports to the users having the reports assigned, by means of Entity role assignments, considering the calendar settings. The report is delivered via the selected format (PDF or Excel), to the specified email addresses.

Warning

The report delivery may be delayed by several minutes due to various reasons, such as the rendering time or the time interval used by the server to check for scheduled reports.

Assigning Reports to users

When creating a new Report definition it will be automatically assigned to the creator user, hence becoming the owner of that Report. Further on, users having the View users and Manage users permissions enabled can assign reports to other users, as well.

This can be done by a system administrator, in the Users panel, by selecting a user in detailed view mode and selecting the Reports tile.

Reports_tile.jpg

User's Reports tile

As soon as the Reports tile has been selected, the Reports panel is opened. In this view, the system administrator can manage the Reports assigned to a user.

By clicking the Change button the Select Reports panel is opened, listing all the Reports available for the currently logged in user.

Select_reports.jpg

The Select reports panel

Note

All the Reports assigned to a user, under the user profile, will be available for scheduling, regardless if the user has view permissions enabled for them or not.

Report schedules

The Report schedule panel is available for all users having the Schedule reports permission enabled. As earlier indicated, only the reports assigned under a user's profile will be available for scheduling.

The Report schedule is presented as a monthly calendar, where by default the current month is selected. In this view, the already existing schedules can be viewed, updated, or deleted.

report_schedule.jpg

The Report schedule panel

In this view, the user can switch from the Calendar view to the List view, by toggling between the respective buttons.

toggle_button.jpg

Enable the list view

The scheduler date can be also changed using the Calendar option, allowing the user to jump to another month of the current year, the past year(s), and even future year(s).

calendar_button.jpg

The Calendar selector

Existing schedules are represented by specific icons in the calendar view. The user can distinguish between two types of reports: SQL Server Reports SQL.jpg and Application Reports Application_report.jpg.

Clicking on a day where the report icons are displayed, the calendar is expanded to show the full report name(s) and the exact delivery time.

calendar_day.jpg

Expand calendar to view scheduled reports

It is also possible to define new Report schedules by clicking the Add toolbar button, in the Report schedule panel.

add.jpg

The Add Report schedule button

The Add button opens the Add Report Schedule panel which allows the user to select an existing report and customize its scheduling parameters.

Add_report_schedule.jpg

Add report schedule panel

Using the Add Report Schedule panel the user can define the schedule by means of the following parameters:

  • Color - sets the color marking the schedule, in the calendar. Selection is done from the color picker tool.

    color.jpg
  • Name - sets the name of the report.

  • Distribution list - allows the scheduler user to add the email addresses of the other users, to which the scheduled report will be sent.

    The distribution list is a free text field that expects one or multiple valid email addresses. When introducing multiple email addresses, they should only be separated by the semicolon ; symbols, whitespaces are not permitted.

    distribution_list.jpg

    Distribution list

  • Select schedule - the actual schedule from a chronological point of view can be:

    • the Daily report delivery can be scheduled to occur at an exact time (Start time), every weekday, or at specific daily intervals, during a predefined period of time (Start time / End time).

      daily.jpg
    • the Weekly report delivery can be scheduled to occur at the exact time (Start time), on predefined days of the week, during the specified period of time (Start date / End date).

      weekly.jpg
    • the Monthly report delivery can be scheduled to occur at the exact time (Start time), on predefined days of the month, during the specified period of time (Start date / End date).

      monthly.jpg
    • The Yearly report delivery can be scheduled to occur at the exact time (Start time), on a predefined day of the month, during the specified period of the time (Start date / End date).

      yearly.jpg
  • Report type - allows the user to select the type of report to create, choosing between the following options:

    • SQL Server Report

      • Report - sets the Report that will be scheduled.

        By clicking the Report button, the Reports list will be opened, allowing the user to select the desired report to be scheduled. In this view, the Reports list will display only the reports assigned to the user.

        report_selector.jpg

        Select report for the schedule

      • Supported output type - sets the format type supported by the current report. The user can select the format type from the drop-down list. The supported format types are PDF or Excel.

        Supported_output_type.jpg

        Supported output type

      • Custom report parameters - this area is enabled only after a report has been added to the schedule. This option allows the user to configure values for the custom parameters available for the selected Report.

        This area will show all the custom parameters defined for the currently selected Report, allowing the user to manually fill in the desired values.

        Custom_report_parameters.jpg

        Example of Custom report parameters area

    • Application Report

      application_report_panel.jpg

      Tip

      For more details on how to schedule an application report, please visit the dedicated tutorial, here.

      • Report - sets the Application report that will be scheduled.

        By clicking the Application report button, the Applications list will be opened, allowing the user to select the desired application to be scheduled. In this view, the Applications list will display only the applications available for the currently logged-in user.

        application_selector.jpg
      • Subpage path - an optional sub-page of the i4designer project. The sub-page path is given by the project's sub-page exact name.

      • Site - allows the user to select a Site as an additional reporting parameter. The list of Sites is opened when clicking the respective Sites selector. The list of Sites will be by default filtered to only show the Sites available for the currently logged in user.

      • Area - allows the user to select an Area as an additional reporting parameter. The list of Areas is opened when clicking the respective Areas selector. The list of Areas will be by default filtered to only show the Areas available for the currently logged in user.

      • Device - allows the user to select a Device as an additional reporting parameter. The list of Devices is opened when clicking the respective Devices selector. The list of Devices will be by default filtered to only show the Devices available for the currently logged in user.

      • Organizational unit - allows the user to select an Organizational unit as an additional reporting parameter. The list of organizational units is opened when clicking the respective Sites selector. The list of organizational units will be by default filtered to only show the Sites available for the currently logged in user.

      • Navigation parameters - an optional set of parameters that allow the user to parametrize the available components.

        Navigation parameters can be added by clicking the Add parameter button plus.jpg. The user needs to manually input the Parameter Name and Value. Inserted parameters can be removed by clicking the Delete button delete.jpg.

        Navigation_parameters.jpg

        The Navigation parameters

        Tip

        For a step-based tutorial describing the usage of the Navigation parameters, please follow the dedicated article, here.Using custom parameters

        Besides the custom navigation parameters, the i4connected platform is also injecting a set of standard parameters. The standard parameters are capable of automatically resolving parsed information.

        This table lists the parameters that can be used by the application designer and which will be automatically available to the applications targeting the i4connected platform:

      • I4C_SITE_ID - Contains the ID of the site to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • A site

        • An area

        • A device connected to a site

      • I4C_SITE_NAME - Resolved at startup, it contains the name of the site (untranslated).

        Note

        Available if the application is attached to:

        • A site

        • An area

        • A device connected to a site

      • I4C_AREA_ID - Contains the ID of the area to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • An area

        • A device connected to an area

      • I4C_AREA_NAME - Resolved at startup, it contains the name of the area (untranslated).

        Note

        Available if the application is attached to:

        • An area

        • A device connected to an area

      • I4C_ORG_ID - Contains the ID of the organizational unit to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • An organizational unit

        • A device connected to an organizational unit

      • I4C_ORG_NAME - Resolved at startup, it contains the name of the organizational unit (untranslated).

        Note

        Available if the application is attached to:

        • An organizational unit

        • A device connected to an organizational unit

      • I4C_DEVICE_ID - Contains the ID of the device to which the application is attached. Injected via query parameters.

        Note

        Available if the application is attached to:

        • A device

      • I4C_DEVICE_NAME - Resolved at startup, it contains the name of the device.

        Note

        Available if the application is attached to:

        • A device

      • I4C_DEVICE_DESCRIPTION - Resolved at startup, it contains the description of the device.

        Note

        Available if the application is attached to:

        • A device

      • I4C_DEVICE_ALIAS - Resolved at startup, it contains the alias of the device.

        Note

        Available if the application is attached to:

        • A device

To save the new Report schedule the user can click the Save button or the Save and Archive button.

Tip

For more details about the Report archives please also check the next article.

A scheduled report can be opened in edit mode by selecting it in the expanded calendar view. When editing a Report schedule, the user can select the type of report that should be edited, choosing between the SQL Server Report and Application Report.

The user can also change all the report schedule properties and the values of the Report parameters and Custom report parameters.

edit_report.jpg

The Edit Report schedule panel

The deletion of report schedules follows the same method as any other object inside the i4connected portal. Clicking the Delete button opens the Delete Report Schedule panel. Here, the confirmation code can be typed, in order to confirm the deletion operation. Once deleted, the schedule will no longer be visible in the Report Schedule calendar.

Note

Deleting a Report schedule will NOT delete the Report definition itself. To delete the report, use the delete functionality from the Reports panel.

Delete_Report_schedule.jpg

The Delete Report schedule panel