How can I Schedule Reports? | Paytronix Knowledge Base

Overview

Scheduled Reports allow you to view, create, edit, and delete scheduled reports. Any report in the `Run Reports` section can be configured as a scheduled report to be sent to an email alias or an FTP on a recurring basis.

Before you Start

Ensure you have the proper permissions to utilize the Scheduled Report feature. If you do not currently have access, contact your User Admin to get the proper permissions added to your account. You will need to be assigned the following permissions:

Merchant Setup Scheduled Report - Read
Merchant Setup Scheduled Report - Write
Merchant Setup Scheduled Report - Delete

Please contact Paytronix if you have additional questions about the Scheduled Reports feature.

Using Scheduled Reports

This tool lives within the Store Administration section of the PXS homepage under Store Administration > Scheduled Reports.

Prerequisites

These two components are limited to being created or modified by Paytronix Support. Once the changes are made, they are available for use in the configuration of a new Scheduled Report. You can re-use these components from past requests or scheduled reports if appropriate. Please contact Paytronix support ([email protected]) with the following requirements specified to get these components configured:

Event Schedule – this defines how often the report is delivered
1. Report Schedule Name
2. Recurrence - Daily, Weekly, Quarterly, Annually, etc.
3. Hour and Minute - military time of day (EST) the report should be sent
4. Start and End date – these are optional fields, will run continuously on the schedule provided if not specified|
Scheduled Report Drop – this defines where and how the report will be sent
1. If report is to be delivered via email:
  1. Email alias created and maintained by your corporate office – the alias should include all necessary recipients of the report
  2. Email subject line
  3. Filename
2. If the report is to be delivered via SFTP or FTP:
  1. Host URL
  2. SFTP
    Username
    Public key will be provided to you for install on the SFTP
  3. FTP
    Username
    Password
  4. Filename

Creating a Scheduled Report

Select the report that is needed to be scheduled for recurring delivery
Configure the Scheduled Report by providing the necessary parameters:
1. Event Schedule – Defines when the report is executed. Use existing or request a new Event Schedule to be created by Paytronix. Details in the previous section.
2. Label – Name of the Scheduled Report, should be a short description of the purpose of the report for future reference
3. Is Active – Should be checked. This specifies whether this Scheduled Report is active or not.
4. User to run reports as – Always select user ‘Scheduled Reports’
5. Scheduled Report drop – Defines where the report is sent when it is executed. Use existing or request a new Scheduled Report Drop to be created by Paytronix. Details in the previous section.
6. Output Format – select preferred output format
7. Report Parameters – this will vary depending on the report you are configuring, see the specific report’s help page in the Customer Resource Center for details.
Select ‘Submit’ to schedule the report. As a confirmation of successful configuration, you will see the a new entry in the Scheduled Report home page:

Viewing a Scheduled Report

Viewing a Scheduled Report enables you to see more detail about the report as it is currently configured without the possibility of making edits. Select the magnifying glass icon to view an existing Scheduled Report:

Editing a Scheduled Report

Editing an existing Scheduled Report allows you to make changes to the current configuration of the report. Select the pencil icon to edit an existing Scheduled Report:
It is possible to edit all the parameters specified in the Create a Scheduled Report section. You should be cognizant of reports configured by or for others within your organization and reach out to the recipients prior to making changes. Once the changes are submitted, they will be permanent. The system does not keep a record of past configurations of a scheduled report.

Copy a Scheduled Report

Copying an existing Scheduled Report allows you to create a copy of an existing report. This is useful if you want to configure a report of the same type as a currently existing one, while making some parameter changes. Select the papers icon to copy Scheduled Report:
Selecting ‘Submit’ will create the new report. You should see both the original Scheduled Report you copied from unchanged, and a new line item for the newly created Scheduled Report:

Delete a Scheduled Report

Deleting an existing Scheduled Report allows you to remove the Scheduled Report permanently. This may be impossible due to a variety of factors associated with past occurrences. If the goal is to stop or pause a report that you may need again later, it is suggested to mark it as inactive by editing the existing Scheduled Report.
To attempt a deletion, select the red cross icon to delete a Scheduled Report:
A confirmation page will ask for explicit approval to proceed with the deletion, select Yes if you are confident in the need to delete. There is no way to recover a deleted Scheduled report after this action has been approved.
The Scheduled Reports home page should no longer contain the Scheduled Report record if the deletion was successful.