Scheduling ReportsReports may be scheduled for distribution at a future date and time. This functionality is particularly useful for contact centers that run specific reports and distribute them to the same users on a regular basis. Scheduling reports automates the process of running reports with specific parameters and distributing reports via email or FTP/SFTP.To schedule a report or to update the settings of a scheduled report, follow these steps:# Click '''Run Report'''.As described in ''How to Schedule a Report'', clicking '''Schedule this report for distribution''' brings up a new dialog with report schedule properties and other report parameters. The dialog includes three tabs: Parameters, Email Delivery, and FTP Delivery. The properties of these tabs are described as follows.[[File:Scheduled-Reports-Parameters-5399.png|650px|thumbnail|center|Parameters tab properties]]Select the '''Enabled''' checkbox to enable the report to be scheduled for distribution.In this section of Parameters, define when and how often the report will be scheduled to be run.''Recurrence'' is the frequency that the report will be run and distributed.Select one of four options:* Hourly* Daily* Weekly* MonthlySpecify the time and the timezone in which the report will be scheduled to run.Specify how often the report should be run, or if the report should be run only once. Available repeat options include every 15 minutes, 30 minutes, 1 hour, 2 hours, etc. For example, a report scheduled to run every 15 minutes will include data for the previous 15 minutes.If you selected how often the report run should be repeated, you should specify the time when the report should stop being sent. For example, if you schedule hourly reports repeating every 30 minutes with ''Repeat until'' set to "06:00 PM", the last report will be sent at 6 p.m. with data up until 5:30 p.m.The Report Parameters section includes the parameters relevant to the selected report name. Depending on the selected [[#Recurrence|Recurrence]], you will have the following options:* For '''Hourly''' recurrence:** Repetition interval - Based on the combination of [[#Repeat_every|Repeat every]] and [[#Repeat_until|Repeat until]] settings** Today** This week* For '''Daily''', '''Weekly''', and '''Monthly''' recurrence:** Today** Yesterday** This week** This week (since Monday)** Last week** Last week (Monday - Sunday)** Current month** Last month** Last N days - Allows you to specify the number of daysIn the example shown, the selected report name is "Agent Activity" and therefore, only the Agent Activity report parameters "Time Frame" and "Agents" are shown.[[File:Email-Delivery-Scheduling-53.PNG|650px|thumbnail|center|Email Delivery tab properties]]Select the ''Deliver report via email'' checkbox to enable delivery of the report to specified email addresses.Enter the desired ''Sender display name'' here. This name can be any name (e.g., organization name, your name, team name, service name, etc.).The ''Sender email address'' is the email address that will be used to send the report.The ''Subject'' is the subject line of the email message to be sent.Variables of the $(varname) format may be used in the ''Subject'' field and ''Message'' field.The Insert Variables button allows you to insert one of the following variables into the ''Subject'' or the ''Message'' field:* $(agents) - This variable displays the name of the agent(s) defined in the [[#Report_Parameters|Report Parameters]] section.* $(services) - This variable displays the name of the service(s) defined in the [[#Report_Parameters|Report Parameters]] section.* $(scenarioName) - This variable displays the name of the scenario defined in the [[#Report_Parameters|Report Parameters]] section.* $(endTime) - This variable displays the time of the last entry in the report .* $(startTime) - This variable displays the time of the first entry in the report.* $(timeframe) - This variable displays the timeframe of the report as defined in the [[#Report_Parameters|Report Parameters]] section.* $(timezone) - This variable dislays the time zone as defined in the [[#Report_Schedule|Report Schedule]] section.Please note that the available variables depend on the type of report being scheduled.The ''Message'' is the body text of the email message to be sent.''Format'' is how the report will be provided in the email message to be sent.Choose one of four options:* PDF* Excel* CSV* Text''Recipients'' are the people who will receive the scheduled report. Click '''edit''' to select and add recipients to the list.[[File:FTP-Scheduling-53.PNG|650px|thumbnail|center|FTP Delivery tab properties]]Select the ''Deliver report via FTP/SFTP'' checkbox to enable delivery of the report via FTP/SFTP.''Format'' is how the report will be saved and sent via FTP/SFTP.Choose one of four options:* PDF* Excel* CSV* Text''Transport Protocol'' is the specified transfer protocol (FTP or SFTP).''FTP/SFTP Server hostname'' is the is the specified FTP/SFTP server username.''Destination folder and file name'' is where the scheduled report will be saved.Variables of the $(varname) format may be used in the ''Destination folder and file name'' field.The Insert Variables button allows you to insert one of the following variables into the ''Destination folder and file name'' field:* $(agents) - This variable displays the name of the agent(s) defined in the [[#Report_Parameters|Report Parameters]] section.* $(services) - This variable displays the name of the service(s) defined in the [[#Report_Parameters|Report Parameters]] section.* $(scenarioName) - This variable displays the name of the scenario defined in the [[#Report_Parameters|Report Parameters]] section.* $(endTime) - This variable displays the time of the last entry in the report .* $(startTime) - This variable displays the time of the first entry in the report.* $(timeframe) - This variable displays the timeframe of the report as defined in the [[#Report_Parameters|Report Parameters]] section.* $(timezone) - This variable dislays the time zone as defined in the [[#Report_Schedule|Report Schedule]] section.[[File:Insert-Variable-FTP-53.PNG|450px|thumbnail|center|Click $() to insert a variable in the Destination folder and file name]]''FTP username'' is the specified FTP username.''FTP password'' is the specified FTP password.The ''Test connection'' button is used to test the FTP/SFTP connection with the supplied credentials.
Specify how often the report should be run, or if the report should be run only once. Available repeat options include every 15 minutes, 30 minutes, 1 hour, 2 hours, etc. For example, a report scheduled to run every 15 minutes will include data for the previous 15 minutes.
Repeat until
If you selected how often the report run should be repeated, you should specify the time when the report should stop being sent. For example, if you schedule hourly reports repeating every 30 minutes with Repeat until set to "06:00 PM", the last report will be sent at 6 p.m. with data up until 5:30 p.m.
Report Parameters
The Report Parameters section includes the parameters relevant to the selected report name. Depending on the selected Recurrence, you will have the following options:
Last N days - Allows you to specify the number of days
In the example shown, the selected report name is "Agent Activity" and therefore, only the Agent Activity report parameters "Time Frame" and "Agents" are shown.
