Schedule recurring report deliveries
Report schedules render a report on a recurring cadence and deliver it by email or SFTP.
Manage report schedules from the Report tab on the Schedulers page. This guide covers the steps and detail page information that are specific to report schedules. For shared concepts, refer to the schedulers overview guide. Those include permissions, the list view, the Schedule and History detail tabs, auto-disable behavior, and concurrency.
Before you start
For SSH file transfer protocol (SFTP) delivery, gather the SFTP host name (for example, sftp.example.com), port (typically 22), and remote directory path. Make sure a credential with the required SFTP username and secret already exists in the Credential Center. The schedule references this credential and doesn’t store SFTP usernames or passwords directly.
Starting with 8.24.0, saving checks that the Run As user can run the report. For SFTP delivery, it also checks that you have Run permission on the SFTP credential. Permission to edit a schedule doesn’t replace these access requirements.
Also confirm that the report is visible to the intended Run As user and that the user has the least privilege required to run it. If the user is deactivated or loses Run permission, scheduled runs fail.
Create a report schedule
From the Report tab, select New Schedule in the page toolbar. The wizard includes five steps for system administrators and four for other users. The headings below follow the administrator’s sequence.
Step one — Basic information
Use this step to name the schedule and choose whether to send notifications.
| Attribute | Required | Description |
|---|---|---|
| Schedule Name | Yes | A descriptive name for this scheduled job. |
| Send notifications | No | When enabled, recipients receive a report job summary on completion. Failures are also routed to system administrators via the Notification Center. |
Step two — Select report
Use this step to select the report the schedule renders and delivers.
The report picker shows a folder tree of all reports visible to you. It opens in the Folders view by default. Switch to List view to search across all reports without folder navigation. Select a report with its radio button.
Each schedule can deliver one report. To deliver multiple reports on the same cadence, create one schedule for each report.
Step three — Delivery
Use this step to choose the output format and delivery method for the rendered report.
| Attribute | Required | Description |
|---|---|---|
| Output format | Yes | The format of the generated report, such as Excel. |
| Delivery method | Yes | Email to send the report as an email attachment, or SFTP to upload it to a remote file server. |
Email delivery
Use email delivery to send the rendered report as an attachment.
| Attribute | Required | Description |
|---|---|---|
| To | Yes | Recipient address. |
| From | Yes | Sender address. |
| Subject | Yes | Email subject line. |
| Body | No | Optional rich-text email body that accompanies the report. |
SFTP delivery
Use SFTP delivery to upload the rendered report to a remote file server.
| Attribute | Required | Description |
|---|---|---|
| Host | Yes | SFTP host name — for example, sftp.example.com. |
| Port | Yes | SFTP port, typically 22. |
| Credential | Yes | A credential from the Credential Center. The schedule never stores SFTP credentials directly. |
| Path | Yes | Remote directory where Nutrient Workflow Automation uploads the rendered report. |
Step four — Run as user
Starting with 8.24.0, this step appears only for system administrators. For other users, the schedule runs as the user who creates it.
The schedule runs with the selected user’s permissions. Only reports that the Run As user can run will succeed.
For system administrators, the picker is a searchable table with Last Name, First Name, and Email columns. Select a row’s radio button to choose the Run As user.
Nutrient Workflow Automation captures the Run As user at create time. If that user is later deactivated or loses Run permission on the underlying report, the schedule’s runs fail and count toward the auto-disable threshold.
Step five — Schedule
Use this step to set the schedule cadence, start date and time, and optional end date.
You can choose One time or Recurring. For full field descriptions, refer to the schedule section in the Schedulers overview guide.
Example: Schedule a nightly SFTP compliance report
This example creates a nightly compliance report export and uploads it to an SFTP server.
| Wizard step | Configuration |
|---|---|
| Basic information | Name the schedule — for example, Nightly compliance report. Enable notifications if administrators need completion or failure summaries. |
| Select report | Select the compliance report to render. The Run As user must have permission to run this report. |
| Delivery | Select the output format. Choose SFTP; enter the SFTP host, port, and remote path; and select the stored Credential Center credential. Don’t enter a password manually. |
| Run as user | As a system administrator, select the least-privilege account that can run the required report. For other users, the schedule runs as its creator. |
| Schedule | Select Recurring, set the nightly cadence, confirm the timezone, and keep Schedule Status set to Scheduled when you’re ready for automatic runs. |
After you save the schedule, run a one-off validation before you wait for the first automatic run.
- Open the Report tab on the Schedulers page.
- Select the schedule row and click Run Selected. For more information, refer to the row and bulk actions section in the Schedulers overview guide.
- Open the schedule detail page and check the History tab for a Success entry.
- Confirm that the expected report file appears in the configured SFTP path.
- If the run fails, check the History error message. Then verify the SFTP host, port, path, credential, and Run As user, and run the schedule again.
Nutrient Workflow Automation marks a schedule Inactive after five consecutive failures. To recover, fix the underlying SFTP, credential, report permission, or Run As user problem. Then edit the schedule and set the status back to Scheduled. For more information, refer to the auto-disable section in the Schedulers overview guide.
Detail page
The report schedule detail page shows the standard four stat cards: Next Run, Last Run, Success Rate, and Avg Duration. It also shows four information cards specific to report schedules.
| Card | Contents |
|---|---|
| Basic Info | Schedule name and notifications setting. Edit action available. |
| Run As User | The user account the schedule runs as. Only system administrators see the Edit action to select another user. |
| Delivery | Output format and delivery method, plus method-specific fields. Email shows To, From, and Subject. SFTP shows Host, Port, and Path. |
| Job Details | Report (the report name), Created, and Modified dates. |
The Schedule and History tabs are the same across all scheduler types. Refer to the schedule section and history section in the Schedulers overview guide.
Verify and troubleshoot an SFTP report schedule
For a recurring report delivery, use this checklist after completing the wizard:
- On the Report tab, confirm that the schedule appears with the intended status and next run time. Open its Schedule tab to check the cadence and timezone.
- Open the schedule and check its Delivery card for the output format, SFTP host, port, and remote path. Check its Run As User card for the account that has Run permission on the report.
- To test the delivery before its next scheduled run, select the schedule in the list and use Run Selected. This triggers a one-time run without changing the recurring cadence.
- Check the History tab for the run status and any error message. Confirm that the expected report arrived at the SFTP destination.
A report schedule becomes Inactive after five consecutive failed runs and stops running on its cadence. Check History for the error, the Run As user’s report permissions, and the Credential Center credential. After resolving the cause, edit the schedule and set its status back to Scheduled. A Paused schedule also stops its cadence. Set it back to Scheduled before using Run Selected.