Archive Files to FTP Server

Yeastar P-Series Cloud Edition supports archiving the system's call recordings and backup files to FTP server, either on a regular interval or at any time you want. This topic describes how to add FTP server as an archive server and schedule tasks to archive the desired files.

Requirements and restrictions

Requirements
  • PBX Firmware: Version 84.15.0.22 or later
  • PBX Plan: Ultimate Plan
Restrictions
  • Archive server: 10
  • Archive task: 200

Prerequisites

Before you begin, you need to prepare the following resources and collect the required information:
  • Prepare an FTP server, and note down its Domain/IP Address, Port, and File Transfer Protocol.
  • Prepare an FTP account with both read and write permissions, and note down its Username and Password.

Step 1. Add FTP server as archive server

  1. Log in to PBX web portal, go to System > Archive.
  2. Under the Archive Task tab, click Archive Server.

  3. Set up FTP server as the archive server.
    1. Click Add.
    2. In the pop-up window, complete the following settings.

      Setting Description
      Name Enter a name to help you identify the server.
      Server Type Select FTP.
      FTP Server Domain/IP Enter the address of your FTP server.
      Port Enter the port on which your FTP server is running. The default port is 21.
      File Transfer Protocol Select the transfer protocol supported by the FTP server.
      • FTP: Standard File Transfer Protocol.
      • FTPES: FTP over Explicit TLS/SSL.
        Note:
        • The TLS feature on the FTP server must be enabled, and the encryption policy must be well-configured for security reason.
        • The supported TLS protocol version is TLS V1.2.
      Username Enter the username for the FTP account.
      Password Enter the password associated with the username.
    3. Click Save.

      The FTP server is added as an archive server and displayed on the archive server list.

  4. Click to close the window.

Step 2. Create a task to archive files to FTP server

  1. Under Archive Task tab, click Add.
  2. Create a one-time or recurring archive task.

    Setting Description
    Name Enter a name to help you identify the task.
    File Type Select Recording Files or Backup Files as needed.
    Time Specify a time range of the files to be archived.
    Note: You can archive files for up to 31 days at a time.
    Sync Frequency Set how often to archive files to FTP server.
    Note: As large amounts of data will consume PBX's CPU resources, we recommend that you schedule archive tasks during off-peak hours.
    • Once: If you choose the option, the system will archive files immediately after you save the task.
    • Daily: If you choose the option, select a time from the drop-down list. The system will archive files at this time of the day.
    • Weekly: If you choose the option, choose a day of week and select a time from the drop-down list. The system will archive files at this time of the week.

    • Monthly: If you choose the option, choose a day and select a time from the drop-down list. The system will archive files on this day and time of the month.
    Archive Server Select the FTP server that you have added.
    Select Folder/Path Optional. Set the path to the folder in which you want to store archived files. For example, pbx/backup/.
    Note: If you leave this field blank, the files will be stored under the root directory.
  3. Click Save.

Result

The specified files will be archived to the designated folder in your FTP server immediately or at the scheduled time.

Note: The system executes only one task at a time to avoid affecting system performance. If there are multiple tasks, they will be queued up one after another.

You can check the archive result in the following ways.

Check the archive result on PBX
On PBX web portal, go to System > Archive > Archival Logs. If the Result column of the task shows Succeeded, it indicates that the specified files have been successfully archived to the FTP server.

Note: If the task is failed, the Failed to Archive File(s) event will be triggered; You can click to retry the task.

Check the archive result on FTP server
Go to the designated folder in FTP server. If the specified files appear in the list, it indicates that the archive is successful.