<!DOCTYPE html>
<html>
    <head>
        <title>Genesys Quality Management Suite 8.1.520 : Archive Tool</title>
        <link rel="stylesheet" href="styles/site.css" type="text/css" />
        <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
    </head>

    <body class="theme-default aui-theme-default">
        <div id="page">
            <div id="main" class="aui-page-panel">
                <div id="main-header">
                    <div id="breadcrumb-section">
                        <ol id="breadcrumbs">
                            <li class="first">
                                <span><a href="index.html">Genesys Quality Management Suite 8.1.520</a></span>
                            </li>
                                                    <li>
                                <span><a href="Genesys-Quality-Management-Suite-8.1.520_69765502.html">Genesys Quality Management Suite 8.1.520</a></span>
                            </li>
                                                    <li>
                                <span><a href="Call-Recording-and-Screen-Capture-Guide_69765766.html">Call Recording and Screen Capture Guide</a></span>
                            </li>
                                                    <li>
                                <span><a href="Call-and-Screen-Recording-Admin-Guide_69765763.html">Call and Screen Recording Admin Guide</a></span>
                            </li>
                                                    <li>
                                <span><a href="Media-Lifecycle-Management_69765733.html">Media Lifecycle Management</a></span>
                            </li>
                                                </ol>
                    </div>
                    <h1 id="title-heading" class="pagetitle">
                                                <span id="title-text">
                            Genesys Quality Management Suite 8.1.520 : Archive Tool
                        </span>
                    </h1>
                </div>

                <div id="content" class="view">
                    <div class="page-metadata">
                        
        
    
        
    
        
    
            Created and last modified by <span class="author"></span>
                        </div>
                    <div id="main-content" class="wiki-content group">
                    <p>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.</p><div class="figure" style="margin-left: 20.0px;"><img class="confluence-embedded-image confluence-external-resource" width="650" src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/mlm_simple_archiving.png" data-image-src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/mlm_simple_archiving.png"></div><ol><li class="Level1">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.</li><li class="Level1">The Archive tool copies all non-archived MP3s to an archive file. Files that have been archived are marked <img class="confluence-embedded-image decoded confluence-external-resource" src="http://archived.gif" data-image-src="http://archived.gif"> 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.</li><li class="Level1">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.</li><li class="Level1">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.</li><li class="Level1">At the end of the retention period, the archived files are no longer needed and can be deleted from the archive by an administrator.</li></ol><h2 class="Level1" id="ArchiveTool-Configuration">Configuration</h2><p>To configure archiving, navigate to <strong><span class="gui-item">Settings &gt; Configuration &gt; Maintenance &gt; Archive</span></strong>.</p><p><img class="confluence-embedded-image confluence-external-resource" width="500" src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/configure_archive.png" data-image-src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/configure_archive.png"> </p><ol><li class="Level1">Select the <strong><span class="gui-item">Enabled</span></strong> checkbox to enable the tool.</li><li class="Level1">If the tool must run more frequently than once a day to even out performance, then select the <strong><span class="gui-item">Run as Daemon</span> </strong>checkbox. Set a<strong> <span class="gui-item">Daemon sleep period</span> </strong>in seconds. If this field is empty when <span class="gui-item"><strong>Save configuration</strong></span> is selected, the validation fails. If the sleep period is set to zero then the tool will only run once and then stop.<br />If the tool is required to run once a day, deselect the <strong><span class="gui-item">Run as Daemon</span></strong> checkbox and the tool runs as a one-shot task using Cron.</li><li class="Level1">The <span class="gui-item"><strong>Database pool</strong></span> should be set to <strong><span class="gui-item">callrec</span></strong> this is the default. Note that before version <span class="zoom_userdocs_variablesvar_product_qmsuite_version_52">8.1.520.</span> Maintenance had its own pool.</li><li class="Level1">Type a subject for the notification email, for example, <code>Archive Notification</code>, and a valid email address. If these fields are empty, the validation fails.</li><li class="Level1">Select the <strong><span class="gui-item">Send success emails</span> </strong>checkbox to be informed by email of successful archiving.<br />Select the <strong><span class="gui-item">Send failure emails</span></strong> checkbox to be informed by email of failure.</li><li class="Level1">Click <span class="gui-item"><strong>Save configuration</strong></span><strong>.</strong></li></ol><p><span class="gui-item"><strong>Temporary directory</strong></span><strong>:</strong> full system path to temporary storage directory for example<code> /tmp</code>.</p><p>The<code> /tmp</code> 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 <code>/tmp</code> folders must be different for Restore and Archive.</p><h3 id="ArchiveTool-AddinganArchiveTask">Adding an Archive Task</h3><p>Navigate to <strong><span class="gui-item">Settings &gt; Configuration &gt; Maintenance &gt; Archive</span></strong>.<br /><img class="confluence-embedded-image confluence-external-resource" src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/add_archive_task.png" data-image-src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/add_archive_task.png"> </p><ol><li class="Level1">Enter a task name. Each task name must be unique. It is not possible to change a task name once it has been created.</li><li class="Level1">Click <strong><span class="gui-item">New</span>.<br /><img class="confluence-embedded-image confluence-external-resource" width="500" src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/enable_archive_task.png" data-image-src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/enable_archive_task.png"> </strong></li></ol><ol><li class="Level1">Select <strong><span class="gui-item">Enable this task</span></strong>.</li><li class="Level1">The <strong><span class="gui-item">Centera Configuration</span></strong> section is presently only for Genesys Tech Support .</li><li class="Level1">Select an <span class="gui-item"><strong>Interval period</strong></span> from the drop-down list or specify a custom period by selecting <span class="gui-item"><strong>Use custom</strong> <strong>interval</strong> <strong>period</strong></span>.<br />If <strong><span class="gui-item">Use custom interval period</span></strong> is selected, define the interval in the Custom interval period field. Use the standard <span class="zoom_userdocs_variablesvar_product_callrec_name"><a name="kanchor226"></a>Call Recording</span> time specification format, described in the section <span style="color: rgb(255,0,0);"><a href="Time-Specification_69765738.html">Time Specification.</a></span></li><li class="Level1">Enter a unique name for the file. Only the first 6 characters of the prefix form the file name.</li><li class="Level1">Set the archive maximum size in MB.</li><li class="Level1">Optionally select <strong><span class="gui-item">Archive not decoded streams</span></strong> to archive .pcap files, the default is to archive MP3 files.</li><li class="Level1">Optionally select which media type to exclude the choices are <strong><span class="gui-item">Audio</span>,</strong> <strong><span class="gui-item">Video</span></strong> and <strong><span class="gui-item">Nothing</span>.</strong></li><li class="Level1">Optionally select the <span class="gui-item"><strong>Exclude RECD</strong></span> checkbox to exclude RECD files (raw screen captures).</li><li class="Level1">Optionally select the <span class="gui-item"><strong>Delete archived files</strong></span> to delete files as they are archived. Once deleted the original files cannot be recovered, only the zipped archive version exists.</li></ol><p>To test the validity click <span class="gui-item"><strong>Save configuration.</strong></span></p><h3 id="ArchiveTool-SelectinganArchive">Selecting an Archive</h3><p>Navigate to <strong><span class="gui-item">Settings &gt; Configuration &gt; Maintenance &gt; Archive</span></strong>.</p><p class="figure"><img class="confluence-embedded-image confluence-external-resource" width="500" src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/archive_selection.png" data-image-src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/archive_selection.png"></p><p class="figure"><span>To add a new selection filter for the task above:</span></p><ol><li class="Level1">Select a <strong><span class="gui-item">Description</span>, <span class="gui-item">File path</span>, <span class="gui-item">Length</span></strong> in seconds, <span class="gui-item"><strong>Calling number</strong></span><strong>,</strong> or <span class="gui-item"><strong>Called number</strong></span> from the drop-down list.</li><li class="Level1">Select a comparison expression. The alternatives are: <strong><span class="gui-item">Equal</span>, <span class="gui-item">Not equal</span>, <span class="gui-item">Bigger than or equal</span>, <span class="gui-item">Less than or equal</span>, <span class="gui-item">Exist</span>, <span class="gui-item">Not exist</span>, <span class="gui-item">Begin</span>, <span class="gui-item">End</span>, <span class="gui-item">Contain</span>,<span class="gui-item">Regular expr</span></strong>.</li><li class="Level1">Enter an appropriate value, for example, 30 in seconds for the length or 4498 for the calling number.</li><li class="Level1">Select a Boolean operator, for example, <strong><span class="gui-item">AND</span></strong> or <strong><span class="gui-item">OR</span>,</strong> if there is another row to follow with further selection criteria.</li><li class="Level1">If necessary click <span class="gui-item">New</span> to add a new row.To create a new filter use<strong> <span class="gui-item">Add new selection</span></strong>.<br /><img class="confluence-embedded-image confluence-external-resource" width="500" src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/archive_source_paths.png" data-image-src="https://docs.zoomint.com/images2/zm_qms_admin_webhelp/content/resources/images/doc_cra/archive_source_paths.png"></li></ol><p class="Level1"><span><strong>Archive Source Paths:</strong> 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.</span></p><p><strong><span class="gui-item">Archive Target Paths</span>:</strong> designate alternative storage paths for files archived in this task.</p><p><strong><span class="gui-item">Priority</span>:</strong> Sets the priority for the target path.</p><p><strong><span class="gui-item">Balance</span>:</strong> Sets the load balancing for the archive task.</p><p><strong><span class="gui-item">Watermark</span>:</strong> Sets the capacity trigger for file storage.</p><h3 id="ArchiveTool-StartingtheArchiveToolManuallyOne-shot">Starting the Archive Tool Manually One-shot</h3><p><a name="kanchor227"></a>Log in as <code>admin</code>. Enter <code>su -</code> to log in as the root user. Enter the password, the default is <code><span class="zoom_userdocs_login_variablesvar_callrec_root_password">zoomcallrec</span></code>.</p><p>Ensure tools are active in <code>/etc/callrec/callrec.conf</code>.</p><p>To start the tools manually, use the following command:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px;">/opt/callrec/bin/archive</pre>
</div></div><h3 id="ArchiveTool-RestartingtheArchivetoRunContinually">Restarting the Archive to Run Continually</h3><p><a name="kanchor228"></a>The tool must be in daemon-mode. Use an SSH client. <a name="kanchor229"></a>Log in as <code>admin</code>. Enter <code>su</code> - to log in as the root user. Enter the password, the default is <code><span class="zoom_userdocs_login_variablesvar_callrec_root_password">zoomcallrec</span></code>.</p><p>Use the following command:</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<pre class="theme: Confluence; brush: java; gutter: false" style="font-size:12px;">/opt/callrec/bin/rc.callrec_archive restart</pre>
</div></div><p><strong>Linux</strong></p><p>In <code>/home/admin</code> view a file called archive* with a .zip extension, an associated file size and date.</p><p>In <code>/opt/callrec/data/calls</code>, select the associated date for the calls just archived. Open the file. View the MP3 files and associated details.</p><p class="heading-example"><strong>GUI</strong></p><p>In <span class="gui-item"><strong>Recorded Calls</strong></span> view all affected calls with the archived icon.</p>
                    </div>

                    
                 
                </div>             </div> 
            <div id="footer">
                <section class="footer-body">
                    <p>Document generated by Confluence on May 06, 2014 17:10</p>
                </section>
            </div>
        </div>     </body>
</html>
