Scheduling Reports in MINT

From IMSMA Wiki
Jump to: navigation, search

In MINT it is possible to schedule a report, i.e. to let the system execute it regularly, based on a defined time pattern. A report can thus be created once and then run regularly, each time on the newest available data. The result of a report can be stored in different formats such as PDF, Excel, Word, etc. in the MINT repository, and/or can be sent out by email to a specified list of recipients. Therefore, it is possible to actively notify users who do not need to have a MINT account.

Schedule a report

In order to schedule a report, follow these steps:

  1. In the repository, right-click on a report and select Schedule...
    MINT report schedule.png
  2. In the Scheduled Jobs window, click Create Schedule
    MINT report schedule job.png
  3. The job schedule editor is composed of four tabs:
    1. Schedule: allows to specify a schedule for the report execution. The recurrence can be None, Simple or Calendar. None means that the job is executed only once (either immediately or at a specified date). The Simple mode allows to specify a time interval and an end date for the job execution. The Calendar mode allows to schedule the job according to a calendar, e.g. every Monday in certain months at 8 am. Once the configuration is done, click on the next tab to proceed.
    2. Parameters: this tab is only enabled if the report to be scheduled has input controls (filters). If there are any, then the values for those input controls need to be specified. In this example, the report has the following parameters: a start date between two date values, a type of activity and a province. A value needs to be specified for each of those parameters.
      MINT report schedule parameters.png
      Once the configuration is done, click on the next tab to proceed.
    3. Output: this section allows to specify what the output of the report execution should be. Three options need to be specified:
      1. Output Format: check one or several output formats (e.g. CSV, DOCX, Excel, PDF, etc.)
      2. File Handling: specify if a new run should overwrite the previous output(s) or not. If not, a timestamp pattern can be defined in order to differentiate between the outputs. This allows to keep a history of reports in a structured way and can thus be very useful.
      3. Output destination: specify where to save the output - this can be a folder in the repository or alternatively an FTP server. It is recommended to create an archive folder in the repository to save the report outputs.
      4. Once the configuration is done, click on the next tab to proceed.

      5. Notification: allows to specify email recipients whom the outputs should be automatically sent to. Specify recipients in To, cc, eventually bcc of the email, a subject and an email text. Finally, specify whether the email should only contain a link to the report output (in which case the user needs to have an account to log in to MINT) or include the output as an attachment (according to the format(s) specified in the Output tab; in that case the user does not need any account for MINT). It is also possible to send status notifications, i.e. whether or not the report run successfully. This can be useful information for the MINT administrator. It is possible to choose to send status notifications only in case of failure, in case of success, or both.
    4. Once all configuration is done, click Save to save the job and provide a name and optionally a description.
    5. The job is then displayed in the job list and can further be edited, disabled or deleted by clicking on the respective icons.

      MINT report schedule job list.png

    Note that the job list is always report-specific, i.e. only the jobs for the particular chosen report are displayed - there is no global view of all jobs defined within an organisation.

    In the repository, the clock icon next to a report indicated that a job is scheduled for that report:

    MINT report schedule icon.png