Session Recording Migration Tool

Session Recording Migration Tool

book

Article ID: CTX222787

calendar_today

Updated On:

Description

Description

Use the Session Recording migration tool to facilitate the migration from SmartAuditor to Session Recording. The tool processes the SmartAuditor legacy recording files, and extracts and rebuilds metadata in the Session Recording Database to support the search and playback of the legacy recording files in the Session Recording Player.

 

Where to download ?

Certain legacy Citrix tools are now available on request only. Please submit the request here - https://forms.gle/obA39PEz5qpDiSPq8

Once we verify your request, we will provide access to the download location.


Prerequisites

  • You must install the migration tool on the Session Recording Server.
  • The SmartAuditor legacy recording files must be accessible from the Session Recording Server by way of a shared directory.
  • The user of the Session Recording Server must have read permission to the shared directory and all its subdirectories.
  • Ensure that your .NET version is 4.5 or later.

 

p.p1 { margin: 0.0px 0.0px 0.0px 30.0px; text-indent: -30.0px; font: 16.0px "Trebuchet MS"; color: rgb(192,25,0); } span.s1 { }


Installing the Migration Tool

Download the SRICLImportTool.zip package and extract it on the Session Recording Server. The migration tool is a command-line tool. No installation is required .

The SRICLImportTool.zip package includes the following files:

  • CISHelper.dll
  • Citrix.Diagnostics.dll
  • Citrix.Diagnostics.Recorder.Cdf.dll
  • iclimport.exe
  • iclimport.exe.config
  • Newtonsoft.Json.dll
  • SsRecBase.dll        
  • SsRecCommon.dll
  • SsRecDatabaseProxy.dll
  • SsRecDatabaseProxyCV.dll

Using the Migration Tool

1. On the Session Recoring Server, open a command prompt and change the directory to that of the migration tool.

2. Input the ICLIMPORT (case-insensitive) command to do the corresponding operation.

    Command:

  •  ICLIMPORT /?: View commands and parameters.
  •  ICLIMPORT [IMPORT | VERSION] /?: View more information on each command.
  •  ICLIMPORT IMPORT [/LISTFILES][/RECURSIVE] [/F] [/S] [/c] [/?] [<directory> …]
  •  ICLIMPORT VERSION [/F] [/S] [/c] [/?]

        /LISTFILES       List files before import.

        /RECURSIVE     For specified directories, recursively search for files in all subdirectories.

        <directory>      Name of the directory where files to be imported are searched. Files must have an .ICL extension.

                               Subdirectories will be searched if the /RECURSIVE switch is specified.

        /F                    Force commands to run without prompting.

        /S                    Suppress copyright messages.

        /C                    Disable Customer Experience Improvement Program.

        /?                     Display command help.

Example:

file

Note:

  • This tool rebuilds the metadata of the SmartAuditor legacy recording files in the Session Recording Database and supports the search and playback of the legacy recording files in the Session Recording Player. It does not change the location of the legacy recording files. If you want to migrate the storage hardware of the legacy recording files, do so manually before running this tool.
  •  This tool is provided in English only.

Uninstalling the Migration Tool

Because the migration tool is a command-line tool, you can uninstall it by deleting the tool package.


Data Modified by Migration Tool

This tool creates new database records.


How to Undo the Changes Made by Migration Tool

Citrix recommends that you back up the Session Recording Database before running this tool so that you can undo the changes by restoring the backup database.

 


Known Issues

  • When you play back a SmartAuditor recording file, the recording plays back successfully but the session information is not displayed on the Session Recording Player.

Workaround:

Upgrade the Session Recording Player to 7.14 or later.

  • When you play back a SmartAuditor recording file with the event tag, an error message appears and you cannot continue with the playback.

Workaround:

Upgrade the Session Recording Player to 7.14 or later.


Contact Information

If you have any questions or concerns about this tool, please send your feedback to Migration Tool Feedback.


Disclaimer

This software application is provided to you "as is" with no representations, warranties or conditions of any kind. You may use and distribute it at your own risk. CITRIX DISCLAIMS ALL WARRANTIES WHATSOEVER, EXPRESS, IMPLIED, WRITTEN, ORAL OR STATUTORY, INCLUDING WITHOUT LIMITATION WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NONINFRINGEMENT. Without limiting the generality of the foregoing, you acknowledge and agree that (a) the software application may exhibit errors, design flaws or other problems, possibly resulting in loss of data or damage to property; (b) it may not be possible to make the software application fully functional; and (c) Citrix may, without notice or liability to you, cease to make available the current version and/or any future versions of the software application. In no event should the code be used to support of ultra-hazardous activities, including but not limited to life support or blasting activities. NEITHER CITRIX NOR ITS AFFILIATES OR AGENTS WILL BE LIABLE, UNDER BREACH OF CONTRACT OR ANY OTHER THEORY OF LIABILITY, FOR ANY DAMAGES WHATSOEVER ARISING FROM USE OF THE SOFTWARE APPLICATION, INCLUDING WITHOUT LIMITATION DIRECT, SPECIAL, INCIDENTAL, PUNITIVE, CONSEQUENTIAL OR OTHER DAMAGES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. You agree to indemnify and defend Citrix against any and all claims arising from your use, modification or distribution of the code.


Additional Information

Where to download ?

Certain legacy Citrix tools are now available on request only. Please submit the request here - https://forms.gle/obA39PEz5qpDiSPq8

Once we verify your request, we will provide access to the download location.