<img height="1" width="1" style="display:none" src="https://www.facebook.com/tr?id=1825300184363063&amp;ev=PageView&amp;noscript=1">
Volicon 7.2 Client Side Archiving System User Guide | SnapStream


image


Client Side Archiving System User Guide

Release 7.2


Copyright © 2014, Volicon Inc., All rights reserved CSSA-UG-7.2


Copyright © 2014, Volicon Inc., All Rights Reserved


Warranty and Limitations

“The information in this document is subject to change without notice and does not represent a commitment on the part of Volicon Inc.; it’s not a binding contract. Volicon Inc. will not be held responsible for failures or errors in the text of the document. Nor be liable for it to any claim from any third party. Documentation is provided “as is.” All conditions, representations and warranties, expressed or implied, including any implied warranty of merchantability, fitness for a particular purpose or non-infringement, are disclaimed, except to the extent that such disclaimers are held to be legally invalid. This document contains proprietary information belonging to Volicon Inc. Such information is supplied solely for assisting properly authorized users of Volicon Inc. systems. No part of its contents may be used for any other purpose, disclosed to any person or firm. No part or parts of this document shall be copied, used for commercial purposes or passed to any third party for any use, without approval Volicon Inc. The text and graphics are for the purpose of illustration and reference only. The information herein is subject to change without notice”


Document Details


Document Name:

Client Side Archiving System User Guide 7.2

Part Number

CSSA-UG-7.2

Related Software Versions

7.2


Contents

  1. Introduction 4

    1. Purpose 4

    2. Definitions and acronyms Error! Bookmark not defined.

  2. Installation 5

    1. Preparing Your Windows Machine for Installation 5

    2. Preparing Your Network for Installation 7

    3. Installing the CSAA 7

    4. Initial Connection 10

  3. Initial Configuration 14

    1. Configuring Archiving 14

  4. Managing the Archive Process 23

    1. The Search Function 23

      1. Searching by Channel 23

      2. Searching by Job Status 24

      3. Searching by Date 25

      4. Searching by Text 25

    2. Editing the Archive Process 26

      1. Creating a New Export 27

      2. Creating a Scheduled Custom Export 32

      3. Editing an Archive Process 38

      4. Aborting an Archive Process 38

      5. Removing an Archive Process 39

    3. Paging Through Your Exports 40

  5. Exporting an Archive 41

  6. Appendix 43

    1. Revision history 43


  1. INTRODUCTION

    The Volicon Client Side Archiving System (CSAA) is a user-facing archiving system that automates your archiving process.

    The Observer stores your recorded video for a specified number of days, depending on the amount of storage you purchase (the minimum is 30 days). As that stored video reaches its expiration data, the CSAA will automatically move it off of the Observer system and into the storage location of your choice.

    The CSAA exports not only the video itself, but also the closed-caption metadata contained in the stream.

    Once you have configured the archiving process, the CSAA allows you to close the client application. The archiving process will continue to run as long as the Observer CSAA service is running.


    1. Purpose

      This document describes the installation and use of the CSAA.


  2. INSTALLATION

    Installing the CSAA is a two-stage process. You must configure your Windows machine by turning on the Microsoft Message Queue and by installing .NET Framework 4. You then are ready to install the CSAA.


    1. Preparing Your Windows Machine for Installation

      To turn on Microsoft Message Queuing, open your Control Panel, click Programs, and then click Turn Windows Features On and Off.



      image


      Figure: Control Panel Access


      image


      Figure: Turn Windows Features On or Off


      The Windows Features window opens. Check to verify that you have the Microsoft

      .NET Framework 4 installed.


      image


      Figure: Windows Features Window


      Click the checkbox beside Microsoft Message Queue (MSMQ) Server to turn on the MSMQ Server Core. The CSAA needs no other MSMQ services.


      image


      Figure: Enabling the MSMQ Server Core

      Click OK to save your changes.


    2. Preparing Your Network for Installation

      The Client Side Archiving System runs over TCP port 8228. Configure the firewalls in your network to allow port 8228 traffic to flow between your machine, which will function as the CSAA server, and the Volicon Observer system with the data you want to archive.


    3. Installing the CSAA

      To begin installing the Client Side Archiving Application, click on the CSAA Service icon you received as part of your purchase.


      image


      Figure: CSAA Service Installation Icon

      Accept the Security Warning by clicking Run.

      The Observer CSAA Setup window opens.


      image


      Figure: Observer CSAA Setup Window

      Click Next.


      The Choose Setup Type window opens. Choose the setup type that best suits your needs and click Next.


      image


      Figure: Setup Type Window

      The Ready to Install window opens. Click Install to begin installation.


      image


      Figure: Ready to Install Window


      Click Finish to exit the installer.


      image


      Figure: Exiting the Installer


    4. Initial Connection

      Click the CSAA shortcut icon on your desktop to launch the CSAA for the first time.


      image


      Figure: CSAA Shortcut

      The CSAA.client <version number> login window opens.


      image


      Figure: CSAA Client Login Window

      The CSAA server field and the Observer field will be set to the name of the computer on which you installed the system.

      Log into the Observer using the following values:

      • CSAA server: Leave this field as the name of the computer on which you just installed the CSAA.

      • Observer: Enter either the IP address or the FQDN of your Volicon Observer system.

      • Username: Enter the username your administrator has assigned you for the CSAA system.

      • Password: Enter the password your administrator has assigned you for the CSAA system.


        image


        Figure: Login Values

        The CSAA will open with an empty CSAA.client window.


        image


        Figure: Initial CSAA Client Window


        The upper panel of the CSAA window allows you to define what content you wish to export. The lower panel displays all of the exports you have already executed. These fields will initially be blank.


  3. INITIAL CONFIGURATION

    The Client Side Archiving System allows you both to configure automated archiving of your information and to execute ad hoc exports of your information. The CSAA also allows you to track what exports have occurred.

    For archiving, the CSAA allows you to schedule your archiving to occur just before your content would be deleted from the Observer system. This automated archiving capability is the heart of the CSAA.


    1. Configuring Archiving

      To configure archiving, click on the Archiving tab in the upper panel of the CSAA.client window, then click Add to open the Create Archive window.


      image


      Figure: Create Archive Window

      From the Channel drop down menu, choose the channel that generated the stream you want to archive.


      image


      Figure: Channel Drop-Down Menu

      Choose the streams you want to include in the archive, whether video, audio, or both, and whether to include Closed Captions as part of the archive.


      image


      Figure: Choose Streams to Archive


      The CSAA allows you to include a small portion of your feed on either side of your target archive as buffers, to ensure that your archive is complete. This buffer is called Overlap. Overlap values range from 0-60 seconds, with 0 as the default.

      To include overlap in your archive, set your pre- and post-overlap values. In the example below, we are including one second of pre- and post-video in the target duration of our archive.


      image


      Figure: Setting Overlap


      Set the Time Zone of the machine upon which you installed this CSAA server using the dropdown Timezone menu.


      image


      Figure: Setting the Time Zone


      Tell the CSAA at what point you want it to begin archiving your content using the

      Archive After box.


      image


      Figure: Archive After Configuration

      Two fields are pertinent in this regard:

      • Number of Days Available: This value specifies how many days of storage are available on the Observer system itself. This value is not configurable, and depends entirely on how much storage you have installed.

      • Archive After: Use this value to tell the CSAA how long to let content age on the Observer before it archives that content. In the configuration displayed in this screen capture, we are configuring the CSAA to archive content two days before it ages out of the Observer system.



        Click the Ellipsis Button beside the Output Path field to open the Browse for Folder window.


        image


        Figure: Browse for Folder Window

        Choose the folder in which you want to store your archives, and click OK.


        image

        Figure: Choosing Your Archive Folder


        Click OK to begin the archive.


        image


        Figure: Beginning the Archive

        The CSAA will begin archiving your content.


        image

        Figure: Beginning the Archive Process


        The CSAA will populate with all the archived files it will create, and will indicated the queues order for each file. The CSAA will process older streams first.


        image


        Figure: Archiving Priority

        You can check your work by looking at the directory in which you are storing your archives. As the archive progresses, files will appear.


        image


        Figure: Archive Directory

        You can also track the progress of the archive using the Progress Bar.


        image


        Figure: Progress Bar


  4. MANAGING THE ARCHIVE PROCESS

    The Client Side Archiving System allows you to manage your archives as they are in process. This chapter describes the tools it provides for you to do so.


    1. The Search Function

      The search function in the center of the CSAA screen allows you to search your archiving tasks by:

      • Channel

      • Status

      • Date

      • Text

When you choose a search function, the CSAA will immediately execute the search and show you the results.



image


Figure: Search Function


      1. Searching by Channel

        To search by channel, click on the drop-down arrow in the Channel(s) field. The CSAA will filter to show you the archiving tasks you have configured on that channel.


        image


        Figure: Search by Channel


      2. Searching by Job Status

        To search by job status, click on the drop-down arrow in the Status field.


        image


        Figure: Search by Status

        Search by Status gives you the options below:

        • None: shows all configured tasks

        • Pending: shows the tasks that are pending, and have not yet been attempted

        • PendingRetry: shows tasks that have been attempted at least once, and are pending a retry of the task

        • Aborted: shows tasks that have been aborted by the administrator

        • Failed: shows tasks that the CSAA was incapable of completing

        • Completed: shows tasks that were successful

        • Started: shows tasks that the CSAA has begun



          You may also choose more than one status option to see any given combination of your configured archiving tasks. In the example below, we are viewing the Started and PendingRetry tasks.


          image


          Figure: Choosing Multiple Status Search Options


      3. Searching by Date

        To search by date, click the checkboxes in the Date field. You have two options for entering the dates for your search:

        • Enter the date manually

        • Click the drop-down arrow to open up the calendar search function


          image


          Figure: Search by Date


      4. Searching by Text

        To search for an archiving task by name or other text string, enter the text string in the Text field.


        image


        Figure: Search by Text

        If the text search does not return the results you are looking for, click Clear to empty the field and restore your view of your tasks.


        image


        Figure: Clearing the Text Search Field


    1. Editing the Archive Process

      The tool bar at the bottom of the CSAA screen provides you with tools for editing the archiving process once it begins. Your options are:

      • New: creates a custom export task

      • Edit: allows you to edit an existing export task

      • Abort: allows you to abort an existing export task that has already begun

      • Retry: tells the CSAA to reattempt an export that has failed

      • Remove: cancels and removes an existing export task that has not yet begun


      image


      Figure: Archive Process Editing Tools


      1. Creating a New Export

        To create a new archiving task, click New to open the Create Custom Export window.


        image


        Figure: Creating a New Export

        To configure your export, enter a name in the Name field.


        image

        Figure: Naming Your Custom Export


        Choose the channel you wish to export from the Channel drop-down menu.


        image


        Figure: Choosing a Channel

        Choose the streams you want to export using the Streams check boxes.


        image


        Figure: Choosing Your Streams


        Set the time period you wish to export using the Start and End fields.


        image

        Figure: Configuring the Duration of Your Export

        Create a Filename for your export. Alternatively, click Generate and the CSAA will create a file name for you.


        image

        Figure: Generate a Filename


        Type the destination directory for your export in the Output Path field. Alternatively, click the Ellipsis button to open the Browse for Folder window, and specify the destination directory.


        image


        Figure: Specifying the Output Path


        To execute the export immediately, click OK.


        image


        Figure: Executing the Export


      2. Creating a Scheduled Custom Export

        Optionally, you can set your Transcoding options. To do so, click the Transcode drop-down menu, and select Set Transcode to open the Set Transcoding window.


        image


        Figure: Set Transcoding Window

        Choose the Transcoding you desire from the Preset drop-down menu.


        image


        Figure: Set Transcoding Presets


        Optionally, you can create a recurring schedule for this export. To do so, click the Schedule drop-down arrow and select Set Schedule.


        image


        Figure: Set Schedule

        This opens the Recurring Schedule Editor window.


        image


        Figure: Recurring Schedule Editor Window


        Specify how often you want to run your export. The default schedule is to run the export every hour. You can choose the intervals at which to run the export by leaving the Interval check box chosen, and by specifying that you want the CSAA to export every specific number of hours or days.


        image


        Figure: Specifying an Interval Export

        Alternatively, you can specify a weekly export by choosing the Weekly checkbox, and then specifying on which day(s) of the week you wish the export to run.


        image


        Figure: Specifying a Weekly Export

        Optionally, you can specify that your recurring export will end at a specific date and time. To do so, choose the Schedule End checkbox and either type in the end date and time, or choose the end date from the calendar drop-down function.


        image


        Figure: Schedule End Function


        Set your Overlap time in seconds. The default is five seconds.


        image


        Figure: Set Overlap

        Set the Timezone for your location.


        image


        Figure: Set Timezone

        Click OK to execute your recurring export.


      3. Editing an Archive Process

        To edit an archiving process, choose the process and click the Edit button. The Create Custom Export window opens. For information on your configuration options in this window, see @4.2.1, Creating a New Export.


        image


        Figure: Editing an Archive Process


      4. Aborting an Archive Process

        To abort an archive process that has already begun, choose the process and click the Abort drop-down menu. The CSAA gives you two options:

        • Selected exports only: aborts only the process(es) you have selected

        • All export with current filter: aborts all the pending exports that have the same characteristics as your chosen process


          image


          Figure: Aborting an Archive Process

          Choose your option by highlighting it. The CSAA executes the abort immediately; there is no additional step to confirm your abort.


      5. Removing an Archive Process

        To remove an archive process that has not yet begun, choose the process and click the Remove drop-down menu. The CSAA gives you two options:

        • Selected exports only: aborts only the process(es) you have selected

        • All export with current filter: aborts all the pending exports that have the same characteristics as your chosen process



          image


          Figure: Removing an Archive Process

          Choose your option by highlighting it. The CSAA removes the process(es) immediately; there is no additional step to confirm the removal.


    2. Paging Through Your Exports

      The CSAA allows you to page through your archives in progress using the Page Navigation Bar at the bottom of the screen.


      image


      Figure: Page Navigation Bar

      The Page Control Bar offers you four buttons:

      • First Page

      • Previous Page

      • Next Page

      • Last Page

      You can also enter a page number directly to navigate to that page.


  1. EXPORTING AN ARCHIVE

    You can export the structure of your archive as a CSV file. To do so, click Export.


    image


    Figure: Exporting a Process

    Navigate to your destination directory, give your export a name, and click Save.


    image


    Figure: Saving Your Export

    The CSAA will export your process as a comma separated value file, which you can open in a spreadsheet.


    image


    Figure: CSV Export


  2. APPENDIX


    1. Revision history


Date

Description

5/14/13

7.0 QB3 Initial release, revision history

6/14/13

Updated enhancements

06/25/13

Remove internal references… related section; add lineup display sync issues