Preset Reporting

Reports -> Preset Reports

Reports can be setup with the Report Wizard, saved as presets report, and then run when required with a single click of a button. Preset reports can also be scheduled to run automatically at a preset time interval. Reports can also be emailed to a user or a specified email address (if the appropriate module have been installed).

Browse Preset Reports

Browse Preset Reports

Add New Report

To create a new preset report, click the Insert button. The Report Wizard will appear to guide you through to setup a new report.

Delete Selected Report

To delete an existing preset report, select the report you would like to delete and click the Delete button. You will be asked if you wish to delete the selected preset report. This is because once you confirm the deletion it is not possible to recover the preset report.

Edit Existing Report

To edit an existing preset report, select the report you would like to edit and click Edit button. Changing the report type of a saved preset report is not possible.

Run Report Manually

To run an existing preset report manually, select the report you would like to run manually and click the Run Report Manually button.

Run Report Manually

To setup a preset manual report select Manual.

Uncheck the Print Preview check box and set Output Type if you want the report to be sent straight out automatically, otherwise the report print preview will appear.

Note: Setting Output Type to an Email type for a report by user will not show Email and Email Message fields as the report will be sent to the email address defined in the user record. See Reports By User for more information.

Click the Next button to save the report in final wizard step.

Run Report Manually

Run Report Manually Output Type Email PDF

Run a Report Automatically

To setup a preset scheduled report select Automatic and set the Output Type. Print Preview is disabled for automatic reports.

Click the Next button to schedule and save the report in final wizard step. The Scheduled Preset Report can be run by a client(a workstation) or by a task.

Preset Reports Settings(Legacy)

Scheduled Preset Report Settings run from client

Preset Reports Settings(Task)

Scheduled Preset Report Settings run by a task

Enter a descriptive name for the new report in the Description field.

Choose if the report is Run From Client (Legacy) or run by a task.

Schedule First Run Date and use number of Days/Months to set the interval of the automatic report (i.e. a report run with days set to 7, will run once a week, with a report range of 7 days).

Some reports provide filter to set Start Date and End Date for the time frame of the report data. For automatic scheduled reports, Start Date and End Date are computed by the Run Date, Days, and Month. E.g. setting up a daily log report (Days set to 1, Month set to 0) with first run date on 01/02/2012 10:00:00 a.m. will override Start Date to 31/01/2012 10:00:00 a.m. and End Date to 01/02/2012 10:00:00 a.m.

With " Run From Client" selected, the Computer field specifies the name of the computer that will run the report, by default this will be the current computer.

Note: At the time the preset report is scheduled to run the computer set to run the report must have Patriot Client Program running.

When run report by a task, the Task dropdown list specifies which task to use for generating reports. More on setting up report task in the next section.

Creating a task for Running Preset Reports

Running the report by a task is recommended because it run report out of Patriot Task Service and does not require the Patriot Client running.

Report Task can be added or configured in the same way as the other tasks, but set the task type to "Reports"

Reports Task Settings

Task settings panel for the Reports Task

Enter a Description of the task.

Select the Computer that this task is to be run on. By default, it is the name of this computer.

Backup: Check this box if you wish this task to be defined as a backup task. This will prevent the backup tasks showing in a faulted state when the primary task service is running.

Enter a System Account No. This is the account number which the status of the Reports task will be logged against. For the Reports task, use a Notes Client No of NOTE000101.

Creating a special Patriot account for Running Preset Reports

Preset Reports have two important points that are required for it to be sent out at the scheduled time:

If the preset reports will be sent out from a workstation that is often unattended, it is best to have this logged in as an operator that only has access to reports, and has all auto-logout or inactivity logout options disabled. This is especially important if you have the UL module registered on your licence, or if all your operators are configured to automatically logout after a certain time.

Follow the steps below to create a dedicated account for Preset Reporting.

Add a Security Group for reporting:

  1. From the menu, select Security -- Operators -- Security Groups.
  2. Insert a new Security Group.
  3. Change the group type to Background Reports.

    Creating a security group for reports
    Security Groups with a group type of Background Reports are only able to access reports.
  4. Save the new group.

Add an operator for reporting:

  1. From the menu, select Security -- Operators -- Operators.
  2. Insert a new operator, and enter a username and password.
  3. Assign the new Background Reports Security Group created above.

    Creating an operator for reports
    Operator with the Background Reports security group assigned to it.
  4. Save the new operator.

Now this newly created operator can be used to log into Patriot on the server or workstation which is used for sending out preset reports. Automatic logout will be disabled for this operator. Only reports can be viewed - maintenance or monitoring cannot be performed by a background reports user.

Related Pages