Custom Reporting Schedules
You can manually run a custom report directly from the report template at any time, or you can create a schedule. The schedule allows you to automate the process of running a report. You can schedule the report to run a single time in the future, or you can you choose a recurring date and time. If you schedule a report to run, the report is distributed to the recipients list by email.
Deactivate any schedules that you no longer want to run. This prevents your system from slowing down by running too many reports unnecessarily.
Key Facts About Custom Report Schedules
-
Scheduled custom and data download reports enter a queue when the scheduled time arrives. The queue then run in order. This helps maintain good performance at high volume times, like at the end of a quarter or year.
- You can create a recurring schedule that occurs on certain days, weeks, or months. It can occur on several days throughout the week on a regular basis, a single day per week, every other week, every third week of a month, and so forth.
- You can set the report to run indefinitely or set a date on which the schedule stops running the report.
- You can request as many reports as needed and they will go into your custom reporting queue. Up to 12 reports can be queued up at a time. As finished reports drop out of the queue, new requests are added to the queue.
- These schedules determine the recipients of the report. You can send the generated report to users in your CXone environment, external email addresses, or you can set up an SFTP connection to a server of yours and specify it as a location to distribute the report. You must configure the SFTP account before the schedule, or you can modify the schedule later to include the SFTP account as a recipient.
- One key difference between a scheduled report and a manually run report is language. Scheduled reports are generated in English. A manually-run report can be displayed in any supported language, as the report is run directly in the browser rather than through the CXone system.
- Reports will fail to send if the file size is greater than the CXone email limit.
Create Custom Report Schedules
Required permissions: Custom Reports Scheduling Create
- Click the app selector and select Reporting.
- Select Schedules under Custom Reports.
- Click Create New.
-
Configure the Name & Other Details page.
Learn more about fields in this step
Field Description Name Name for the report schedule. Report Template Automatically applies this schedule to the selected report template. Delete After How frequently the generated reports are purged from the system. Schedule Type Determine whether you want the report to run on a One Time or Recurring basis. Starts On Specifies the date and time the report first runs. The Starts On time is set based on the time zone of the user creating the custom reporting schedule. Recurs This option displays if you selected Recurring as the Schedule Type.
Specifies the date and time that the report first runs.
- Daily: Runs the report daily or every few days. When you select Daily, the following field appears:
- Every __ Day(s): Specifies the number of days between each time the report runs.
- Weekly: Runs the report weekly or every few weeks. When you select Weekly, the following fields appear:
- Every __ Week(s) on: Specifies the number of weeks between each time the report runs.
- Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday: Indicate which days of the week the report runs.
- Monthly: Runs the report monthly or every few months. When you select Monthly, the following options appear. You must select and configure one.
- Day __ of Every __ Month(s): Specifies the day of the month the report runs and the number of months between each time the report runs. For example, the report might run on the 20th every other month.
- The __ of every __ Month(s): Specifies the day of the month the report runs in terms of the day of the week and the week of the month. It also specifies the number of months between each time the report runs. For example, the report might run on the second Tuesday of each month.
Ends This option displays if you selected Recurring as the Schedule Type.
Specifies when the schedule ends.
- Never: The schedule never ends unless you manually deactivate or change it.
- On: The schedule ends on a specific date at a specific time. Select a date and time in the fields on the right.
- After: The schedule ends after a specific number of occurrences. Type the number of occurrences in the field to the right.
-
Click Next.
-
Determine the recipients of the report on the Report Distribution page. You can select CXone users in the Email Recipients table, enter semicolon-separated External Email Addresses to send the report to users without CXone access, or select a custom SFTP account.
-
Click Next.
-
Configure how you want potential errors to be handled on the On Errors page. Note: you can copy all recipients that you selected in the previous step by clicking Copy Email Distribution List.
Learn more about fields in this stepIf the report fails to generate correctly and throws an error, you can choose to have the system automatically try to generate the report again for up to three attempts. You can also notify users or others outside the system that the report failed to generate after three attempts. The system does not reschedule reports that fail all three attempts and do not have a future scheduled date.
Field Definition Automatic Restart When selected, specifies that the system should automatically try again to run reports that failed after 15 minutes. The system continues to retry the report for up to three attempts if the report continues to fail.
Copy Email Distribution List Copies the settings from the report distribution list to the on error notification list. All people who receive the report when it generates also receive a notification if the report fails to render. Clear Email List Removes all currently selected recipients of the on error notification email. All checkboxes in Email Recipients become cleared and the External Email Addresses box clears. - Click Save.
- Click Activate to activate the schedule. Custom report schedules are inactive upon creation; you must manually activate the schedule for it to apply to the selected custom report template. Only the creator of the report or users with the Custom Report Schedules Administrator permission can activate it. Note: before making any changes to an existing report schedule, you must first deactivate the schedule.