All topics
All topics

Scheduling Historical Reports in RingCX Analytics

Historical Reports let you customize how and where you send data and reports. While Historical Dashboards are always exported as PDF files, Historical Reports can be exported as raw data (CSV files) or as spreadsheets (XLS files).

You can arrange for your reports to be formatted for and delivered by:
  • Email
    : Sends reports through email.
  • File Transfer Protocol (FTP)
    : Uses FTP to send reports to your computer or server.
  • S3 bucket
    : Sends reports to your AWS cloud storage resource.
  • Secure File Transfer Protocol (SFTP)
    : Uses SSH (Secure Shell) protocol to send reports to your computer or server.

Visit Managing Historical Dashboards to learn how to schedule or export dashboards.

Accessing scheduled Historical Reports

  1. Sign in to RingCX, then click the
    Analytics
    icon.
  2. Click
    Historical reports
    , then click
    Schedules
    .
  3. Click on a scheduled Historical Report.

Creating a new schedule

You can create a schedule in any of three locations:

  • In the
    Schedules
    folder
  • In a report folder (
    Standard
    ,
    Shared
    ,
    Private
    , or
    Favorites
    )
  • In the report’s
    viewer
    mode

Note:

  • The data in your scheduled reports will be identical to the data that you see when you look at those reports in
    viewer
    mode. Learn about historical analytics platform limits.
  • If you use a report created by another person in your schedule and the original owner removes your access or deletes the report, a copy of that report is added to your
    Private
    folder, so it will remain in your schedule.
  • Schedule reports follow daylight savings time rules.

Creating a new schedule in the Schedules folder

  1. Sign in to RingCX, then click the
    Analytics
    icon.
  2. Click
    Historical reports > Schedules
    .
  3. Click the
    New schedule
    button in the top right corner.

  4. In the
    General
    section, select the report you want to schedule in the
    Report name
    dropdown.
  5. Enter a custom name for your scheduled report in the
    Schedule name
    field.
  6. Select your preferred file type in the
    File type
    dropdown.
  7. Enter a custom name for your report in the
    File name
    field.
  8. In the
    Schedule
    section, click the
    Frequency
    dropdown to select how often you want the schedule to run, then fill out the rest of the field options.
  9. In the
    Destination
    section, click the
    Destination type
    dropdown to select your preferred destination, then fill out the rest of the field options.
  10. Click
    Save and close
    or
    Save
    .

Note: In the
Schedule
and
Destination
sections, your options may vary according to the frequency and destination type that you select.

Creating a new schedule in report folders

  1. Sign in to RingCX, then click the
    Analytics
    icon.
  2. Click
    Historical reports
    , then select the folder location of the report you want to schedule (
    Standard
    ,
    Shared
    ,
    Private
    , or
    Favorites
    ).
  3. Click the
    Actions
    icon to the far right of the name of the report you want to schedule, then select
    Schedule
    from the dropdown.

  4. In the
    General
    section, select the report you want to schedule in the
    Report name
    dropdown.
  5. Enter a custom name for your scheduled report in the
    Schedule name
    field.
  6. Select your preferred file type in the
    File type
    dropdown.
  7. In the
    Schedule
    section, click the
    Frequency
    dropdown to select how often you want the schedule to run, then fill out the rest of the field options.
  8. In the
    Destination
    section, click the
    Destination type
    dropdown to select your preferred destination, then fill out the rest of the field options.
  9. Click
    Save and close
    or
    Save
    .

Creating a new schedule in a report’s
viewer
mode

  1. Sign in to RingCX, then click the
    Analytics
    icon.
  2. Click
    Historical reports
    and select the folder location of the report you want to schedule (
    Standard
    ,
    Shared
    ,
    Private
    , or
    Favorites
    ).
  3. Open the report you want to schedule. Click the
    Actions
    icon in the top right corner, then select
    Schedule
    from the dropdown.

    Note: You can apply filters while in
    viewer
    mode, but those filters won’t be applied to schedules created while in
    viewer
    mode. You’ll need to add filters in
    edit
    mode to receive filtered reports.

  4. In the
    General
    section, select the report you want to schedule in the
    Report name
    dropdown.
  5. Enter a custom name for your scheduled report in the
    Schedule name
    field.
  6. Select your preferred file type in the
    File type
    dropdown.
  7. In the
    Schedule
    section, click the
    Frequency
    dropdown to select how often you want the schedule to run, then fill out the rest of the field options.
  8. In the
    Destination
    section, click the
    Destination type
    dropdown to select your preferred destination, then fill out the rest of the field options.
  9. Click
    Save and close
    or
    Save
    .

Schedule settings

General

  • Report name
    : Dropdown that lists all existing reports that are available to you. Learn more about creating Historical reports.
  • Schedule name
    : Name of the schedule you’re creating
  • File type
    : CSV (default) or XLS
  • File name
    : Customize the name of the CSV or XLS file you’ll receive. By default, every file name includes the report name, run time, and time zone (Format:
    File name
    _mm.dd.yyyy_hh-mm_TZ).

    Note: If you don’t customize the file name, it will use the name of the selected report (e.g.,
    Report name_mm
    .dd.yyyy_hh-mm_TZ).

Schedule

Settings in the
Schedule
section vary according to the frequency type you select.

  • Frequency type
    : Select how often you want the report sent to your chosen destination.
    • All working days
    • Custom
    • Every day
    • Every hour
    • Every Monday
    • The first of the month
  • Run time
    : Set the time (hh:mm AM/PM) when you want your report to be sent. (Default: 9AM)
  • Starts
    : Set the date (mm/dd/yyyy) when you want your report to start being sent. (Default: current day)
  • Ends
    : Set the date (mm/dd/yyyy) when you want your report to stop being sent. Leave this field empty to keep sending the report until you deactivate it.
  • Timezone
    : Select the time zone in which you want the schedule to run.
    • Pacific Time (US & Canada)
    • Mountain Time (US & Canada)
    • Central Time (US & Canada)
    • Eastern Time (US & Canada)
    • Hawaii
  • Repeat
    : Select how often you want to run your report. (Default:
    Daily
    )
  • Run every
    : Select, in conjunction with the
    Repeat
    setting, the number of times you want your report to run. (Available only in
    Custom
    frequency.)

    For example, if you want your custom report to run twice a month, select
    Monthly
    in the
    Repeat
    setting, then select 2 in the
    Run every
    setting.)

Destination

Settings in the
Destination
section vary according to the destination type you choose.
Email
is the default destination.

  • Email
    : Sends reports as email attachments.
    • Subject
      : Write the subject line of the email to which your Historical report will be attached (Default:
      Schedule
      ).
    • Destination email(s)
      : Choose one or more destination email addresses. Separate multiple addresses with commas, or by using the Enter/Return key to create a new line.
    • Message
      : Customize the short email message that accompanies your report. (Default:
      Hello. Your scheduled email is ready
      .)

      Your custom message will be appended to the beginning of this default text:
      You can download the report in attachments. To view the interactive version of the report, please visit RingCX Analytics
      .

    • Sender email
      : Enter the email address of the email sender for the scheduled report. (Default:
      ringcx.analytics@ringcentral.com
      )

      Note: Customizing the sender’s email will affect only the report you’re currently configuring.

  • File transfer (FTP)
    : Uses File Transfer Protocol to send reports to your computer or server.
    • FTP server
      : Enter the URL of your FTP server. Formatting options include:
      • [IP ADDRESS]/
      • [IP ADDRESS]:[PORT NUMBER]
      • [IP ADDRESS]:[PORT NUMBER]/
      • [ftp|FTP]://[IP ADDRESS]
      • [ftp|FTP]://[IP ADDRESS]/
      • [ftp|FTP]://[IP ADDRESS]:[PORT NUMBER]
      • [ftp|FTP]://[IP ADDRESS]:[PORT NUMBER]/
      • [ServerName].com
      • [ServerName].com/
      • [ServerName].com:[PORT NUMBER]
      • [ServerName].com:[PORT NUMBER]/
      • [ftp|FTP]://[ServerName].com
      • [ftp|FTP]://[ServerName].com/
      • [ftp|FTP]://[ServerName].com:[PORT NUMBER]
      • [ftp|FTP]://[ServerName].com:[PORT NUMBER]/
      Note:
      ServerName
      can contain the names of one or more domains or subdomains, as long as each name consists of at least two characters. For example,
      domainname.rc.subdomain
      is a valid ServerName, but
      domainname.r.somedomain
      is invalid.
    • FTP username
      : Enter the username of your FTP server’s user.
    • FTP password
      : Enter the password of your FTP server’s user.
    • FTP directory
      : Enter the directory’s full path on the FTP server where you want to store your report.
  • S3 bucket
    : Sends reports to your AWS cloud storage resource.
    • S3 URL
      : Enter the URL of your S3 bucket. Formatting options include:
      • http://s3.[region].amazonaws.com/[bucket-name]/
      • http://[bucket-name].s3.[region].amazonaws.com/
      • https://s3.[region].amazonaws.com/[bucket-name]/[key-name]
      • https://[bucket-name].s3.[region].amazonaws.com/[key-name]
      • https://[bucket-name].s3-[region].amazonaws.com/[key-name]

      Note: You’ll need to specify your preferred region in the AWS settings to use S3 URL with that region.

    • S3 Access Key ID
      : Enter the Access Key ID of your S3 bucket.
    • S3 Secret Access Key
      : Enter the Secret Access Key of your S3 bucket.
  • Secure file transfer (SFTP)
    : Uses SSH (Secure Shell) File Transfer Protocol to send reports to your computer or server.
    • SFTP server
      : Enter the URL of your SFTP server. Formatting options include:
      • [IP ADDRESS]/
      • [IP ADDRESS]:[PORT NUMBER]
      • [IP ADDRESS]:[PORT NUMBER]/
      • [sftp|SFTP]://[IP ADDRESS]
      • [sftp|SFTP]://[IP ADDRESS]/
      • [sftp|SFTP]://[IP ADDRESS]:[PORT NUMBER]
      • [sftp|SFTP]://[IP ADDRESS]:[PORT NUMBER]/
      • [ServerName].com
      • [ServerName].com/
      • [ServerName].com:[PORT NUMBER]
      • [ServerName].com:[PORT NUMBER]/
      • [sftp|SFTP]://[ServerName].com
      • [sftp|SFTP]://[ServerName].com/
      • [sftp|SFTP]://[ServerName].com:[PORT NUMBER]
      • [sftp|SFTP]://[ServerName].com:[PORT NUMBER]/
      Note:
      ServerName
      can contain the names of one or more domains or subdomains, as long as each name consists of at least two characters. For example,
      domainname.rc.subdomain
      is a valid ServerName, but
      domainname.r.somedomain
      is invalid.
    • SFTP Server
      : Enter the URL of your SFTP server.
    • SFTP username
      : Enter the username of your SFTP server’s user.
    • SFTP password
      : Enter the password of your SFTP server’s user.
    • SFTP directory
      : Enter the specific location of the directory’s full path on the SFTP server where you want to store your report.

Editing an existing schedule

  1. Sign in to RingCX, then click the Analytics icon.
  2. Click
    Historical reports > Schedules
    .
  3. Locate the schedule using one of these methods:
    • Search for your scheduled Historical report in the search bar.
    • Click the
      Show my schedules
      toggle to the right of the search bar.

  4. Click your scheduled Historical report.
  5. On the settings page, edit the settings you want to change.
  6. Click
    Save and close
    or
    Save
    .

Note: You can’t edit scheduled Historical reports that other users have created. Contact the owner of the schedule to make any changes.

Cloning an existing schedule

  1. Sign in to RingCX, then click the
    Analytics
    icon.
  2. Click
    Historical reports > Schedules
    .
  3. Locate the scheduled Historical report using one of these methods:
    • Perform a manual search for the scheduled Historical report that you want to clone.
    • Use the search bar to search for the scheduled Historical report.
  4. Click the
    Actions
    button at the far right of the report’s row.
  5. Select
    Clone
    .

  6. Select the historical report you want to clone, then choose a name for the cloned report in the
    Clone schedule
    window. (Default:
    Clone of: report name
    .)
  7. Click
    Save
    .
  8. On the configuration page of the cloned report, change any settings that you want to change.
  9. Click
    Save
    .

Click
Go
to report to open a new tab that displays the report’s page. If a report is set to private, the
Go to report
option won't appear in the menu.

Deleting a schedule you’ve created

  1. Sign in to RingCX, then click the
    Analytics
    icon.
  2. Click
    Historical reports > Schedules
    .
  3. Locate the schedule using one of these methods:
    • Use the search bar to search for the scheduled Historical report.
    • Click the
      Show my schedules
      toggle to the right of the search bar.
  4. Click the
    Actions
    button at the far right of the report’s row.
  5. Select
    Delete
    .

  6. Click
    Delete
    to confirm.

Note: You can’t delete scheduled Historical reports that other users have created. Contact the owner of the schedule to make any changes. If you can’t reach the owner of the schedule, contact your account manager.

Testing a schedule

Testing a schedule helps make sure your report’s fields and credentials are correct. 

  1. Sign in to RingCX, then click the
    Analytics
    icon.
  2. Click
    Historical reports > Schedules
    .
  3. Locate the schedule using one of these methods:
    • Use the search bar to search for the scheduled Historical report.
    • Click the
      Show my schedules
      toggle to the right of the search bar.
  4. Click the
    Test run
    button at the far right of the
    Destination
    section.

Testing a schedule will yield either a green success message (
Report [Report Name] test run successfully delivered
), or a red error message (
Please fix the error(s) on this page before continuing
).

Troubleshooting schedule errors

If your schedule receives an error message, check the following destination-specific settings:

  • Email
    • Confirm that the email address is correct.
    • Confirm that there are no issues with the email server.
  • S3/FTP/SFTP
    • Confirm that the server credentials are correct.
    • Confirm that there are no issues with your server.
    • Confirm that the user has rights to upload files to your server.

Note: You’ll need to fill out all mandatory fields and correct any errors before running the test again or saving the schedule.

In this article

Accessing scheduled Historical Reports
Creating a new schedule
Schedule settings
Editing an existing schedule
Cloning an existing schedule
Show all
Thanks!
We've sent you a link, please check your phone!
Please allow a full minute between phone number submissions.
There was an issue with SMS sending. Please try again. If the issue persists, please contact support.