Skip to content

Export/Import Recordings

The "Export/Import recordings" jobs can be used to retrieve and import audio/video files and their metadata from/to the web portal.

Create job

Navigate to Administration > Storage > Export Recordings/Import Recordings and click Add to create the export/import job.

Export Recordings

Fill out the required configuration parameters:

  • Name - give the job a distinctive name.
  • Access scope - specifiy what tenants are exported/imported from/to the target server. This setting is visible only for a multi-tenant environment.
  • Storage Target - specify the previosuly configured destination storage target.
  • Filename format - define a format for filenames and, optionally, directories. The export/import process can inject various call metadata attributes into file/directory names. For example, it can create directory for each day in format YYYYMMDD and then include caller-number and called-number into file name.
  • Parallel upload. A number of parallel upload workers sending data simultaneously. Depending on network latency, an increase of the parallel workers may improve an export/import speed due to better bandwidth utilization. This setting can be helpful when using a remote storage target.
  • Mode. Full or incremental export/import mode.
    • Full - will back up/restore call recordings to the target server everytime the job is started. It will gracefully skip the export/import process if the target server contains such recordings already.
    • Incremental - remembers which records have been uploaded to the target server and do not process them on the next start. Such mode is useful when job is scheduled for periodic replication (every hour/day etc). It will work a lot faster than the full replication mode because it will skip automatically the previously uploaded recordings.
  • Export data - specify the type of data to be exported/imported. You can export/import audio files, call metadata or both.
  • Skip existing files - select the check box to check if the file exists at the destination location. This option can be disabled for some storage targets, like Amazon S3, for optimization purposes. If so, use incremental mode.
  • Group call segments - select this check box to group together hold/resume call segments into one interaction. When enabled, a single JSON metadata file may refer to multiple audio files.
  • Remove after export - if selected, the recordings will be deleted automatically after successful export/import.
  • Decrypt files - if selected, the recordings will be decrypted on-flight before their export/import.

Export Recordings Settings

Filtering criteria

Each export job supports filtering criteria to limit what call recordings are exported from the web portal. For example, you may configure exporting for specific group of users only.

Filtering criteria

Action after successful processing

Optionallly, you can clear/assign a tag once the recording is exported/imported. With this capability, you can create a chain of post-processing, and mark is with relevant flags. For example, you can transcribe the recordings and mark them with a relevant tag. Then, you can apply filtering criteria to export the recordings with this tag. And once the recordings are exported, you tell the system to clear the tag from the recordings.

Action after successful processing

Job advanced settings

Please also check the following advanced settings for the job:

  • Log file - select this check box to write a detailed log for diagnostic purposes.
  • Keep job history - specify the number of days to keep the the successful job history. Default value: 60.
  • Timezone - allows you to change the timezone of a scheduled job. Timezone affects the scheduler, date/time attribute in Filtering Criteria, and Filename Format. Leave this attribute empty to use a system default timezone.
  • Execution time limit - a job will be aborted if it executes longer than the specified time limit (in minutes). Leave this attribute empty to use a default value. Default value: <not defined>.
  • Keep alive timeout - specify a timeout (in minutes) to terminate the job. Leave this attribute empty to use a default value. Default value: 15.
  • Email notification on completion - activates the notification by email about successful job execution. You can trigger the email notification either every time the job completes successfully or for the first of any consecutive completion message.
  • Email notification on failure - activates the notification by email about failed job execution. You can trigger the email notification either every time the job failes or for the first of any consecutive failure message.
  • Email notification address - specify the email address for notifications. Use a comma to separate multiple email addresses.

Info

Note, it is necessary to configure "Web portal URL" under Administration -> System -> Advanced Settings, otherwise the URL links to job details in the email will be invalid. Also, make sure the email integration is enabled under Administration > System > Email Integration.

Job Advanced Settings

Schedule

The job may be started manually or automatically by schedule. The schedule may be configured to run the job every hour/day/week/month. Also, you can set up a custom interval by selecting the Custom (crontab) option.

Please check some examples, on configuring a custom interval:

  • Run the job every 5 minutes.

Run the job every 5 minutes

  • Run the job on 5-th minute of every hour (i.e. 00:05; 01:05; 02:05 and so on).

Run the job on 5-th minute of every hour

  • Run the job on 15-th and 45-th minute of every hour (i.e. 00:15; 00:45; 01:15, 01:45 and so on).

Run the job on 15-th minute of every hour

  • Run the job every hour, on the hour, from 8 AM through 5 PM.

Run the job every hour