# Genesys Quality Management Suite 8.1.520 : Archive Tool

Created and last modified by

Archiving enables the retention of media files in different storage mediums. Archiving regularly ensures that there is always sufficient space locally to store the new calls.

1. The recorder records media files and the recording server stores this information as MP3s in a file system on its hard drives. The recording server also keeps a database of what files it has recorded and where the records are stored.
2. The Archive tool copies all non-archived MP3s to an archive file. Files that have been archived are marked so that they are not archived again. While the files are still on the recorder server, there are two copies of each file providing a backup. One copy on the server and one in archive saved as a zip file.
3. The MP3 files are stored on the recorder server's hard drive for a configurable period, for example, for six months. When that period has lapsed, the system checks that the MP3 files are marked as archived, and deletes them from the recorder file system.
4. The archived media files can still be accessed as they can be restored from the zip files using Restore. How long these restored files are available is configurable.
5. At the end of the retention period, the archived files are no longer needed and can be deleted from the archive by an administrator.

## Configuration

To configure archiving, navigate to Settings > Configuration > Maintenance > Archive.

1. Select the Enabled checkbox to enable the tool.
2. If the tool must run more frequently than once a day to even out performance, then select the Run as Daemon checkbox. Set a Daemon sleep period in seconds. If this field is empty when Save configuration is selected, the validation fails. If the sleep period is set to zero then the tool will only run once and then stop.
   If the tool is required to run once a day, deselect the Run as Daemon checkbox and the tool runs as a one-shot task using Cron.
3. The Database pool should be set to callrec this is the default. Note that before version 8.1.520. Maintenance had its own pool.
4. Type a subject for the notification email, for example, `Archive Notification`, and a valid email address. If these fields are empty, the validation fails.
5. Select the Send success emails checkbox to be informed by email of successful archiving.
   Select the Send failure emails checkbox to be informed by email of failure.
6. Click Save configuration.

Temporary directory: full system path to temporary storage directory for example`/tmp`.

The`/tmp` file must have sufficient free space to accommodate the whole archive uncompressed. By default the temporary directory is 1 GB which is more than sufficient if each individual archive file is no more than 650 MB. If the archive files need to be larger than 650MB then the temp file provided must be larger too. The temp file is where the MP3 are stored while they are being zipped. If using Centera, the `/tmp` folders must be different for Restore and Archive.

### Adding an Archive Task

Navigate to Settings > Configuration > Maintenance > Archive.

1. Enter a task name. Each task name must be unique. It is not possible to change a task name once it has been created.
2. Click New.

1. Select Enable this task.
2. The Centera Configuration section is presently only for Genesys Tech Support .
3. Select an Interval period from the drop-down list or specify a custom period by selecting Use custom interval period.
   If Use custom interval period is selected, define the interval in the Custom interval period field. Use the standard Call Recording time specification format, described in the section Time Specification.
4. Enter a unique name for the file. Only the first 6 characters of the prefix form the file name.
5. Set the archive maximum size in MB.
6. Optionally select Archive not decoded streams to archive .pcap files, the default is to archive MP3 files.
7. Optionally select which media type to exclude the choices are Audio, Video and Nothing.
8. Optionally select the Exclude RECD checkbox to exclude RECD files (raw screen captures).
9. Optionally select the Delete archived files to delete files as they are archived. Once deleted the original files cannot be recovered, only the zipped archive version exists.

To test the validity click Save configuration.

### Selecting an Archive

Navigate to Settings > Configuration > Maintenance > Archive.

To add a new selection filter for the task above:

1. Select a Description, File path, Length in seconds, Calling number, or Called number from the drop-down list.
2. Select a comparison expression. The alternatives are: Equal, Not equal, Bigger than or equal, Less than or equal, Exist, Not exist, Begin, End, Contain,Regular expr.
3. Enter an appropriate value, for example, 30 in seconds for the length or 4498 for the calling number.
4. Select a Boolean operator, for example, AND or OR, if there is another row to follow with further selection criteria.
5. If necessary click New to add a new row.To create a new filter use Add new selection.

Archive Source Paths: identify alternative sources for identifying files to be archived during the task. Unless at least one path is set, the task archives all files in the default database source path.

Archive Target Paths: designate alternative storage paths for files archived in this task.

Priority: Sets the priority for the target path.

Balance: Sets the load balancing for the archive task.

Watermark: Sets the capacity trigger for file storage.

### Starting the Archive Tool Manually One-shot

Log in as `admin`. Enter `su -` to log in as the root user. Enter the password, the default is `zoomcallrec`.

Ensure tools are active in `/etc/callrec/callrec.conf`.

To start the tools manually, use the following command:

    /opt/callrec/bin/archive

### Restarting the Archive to Run Continually

The tool must be in daemon-mode. Use an SSH client. Log in as `admin`. Enter `su` - to log in as the root user. Enter the password, the default is `zoomcallrec`.

Use the following command:

    /opt/callrec/bin/rc.callrec_archive restart

Linux

In `/home/admin` view a file called archive* with a .zip extension, an associated file size and date.

In `/opt/callrec/data/calls`, select the associated date for the calls just archived. Open the file. View the MP3 files and associated details.

GUI

In Recorded Calls view all affected calls with the archived icon.