HELP FILE

How to Set Up Script Files for Storing Recordings in a Cloud

    Administrators can set up script files to store session recordings in the cloud.

    Requirements:
    • Check in the Do not allow the technician to set the location box.
    • Enter script reference into the Screen recording location box:
      "custom:MyUploadScript.cmd"
      "custom:c:\MyScripts\MyUploadScript.cmd"
    Note: We recommend customizing the ready-to-use Rescue script titled CustomSRUploader.cmd, however, customers are allowed to set up their own scripts as well.
    Important: For security reasons, if the edit box contains only the name of the script, the TC is looking for the script only around the TC's executable in the installation folder, to protect the integrity of the script. If the administrator provides the absolute path of the script on the technician machine, the TC will accept it.

    Why does Rescue provide the "CustomSRUploader.cmd" script

    Rescue provides a ready-to-use script template suitable for the majority of use cases. For security reason we recommend saving the custom script into a dedicated folder where restricted users cannot modify it, granting editing permissions to administrators only. Consequently, malicious intruders, or hackers cannot change the intended upload flow.

    The CustomSRUploader.cmd is placed near the TC binary file in the installation folder for this reason.

    The script can be used as a safe starting point for calling customer's own scripts. While it seems to be easy to find the install folder of the Technician Console, it is quite the contrary with the browser TC. Windows may change folders of plugin files depending on the preliminary install history. Using "CustomSRUploader.cmd" will make integration with the TC easier. As safety is paramount, we recommend using absolute paths, and using quotation marks for any path containing space characters in the scripts.

    What command line tool is recommended for uploading the script

    We recommend using the “rclone” command line, available at https://rclone.org, to execute upload tasks.

    "Rclone is a command line program to manage files on cloud storage, first released in 2014. It is a feature rich alternative to cloud vendors' web storage interfaces. Over 40 cloud storage products support rclone including S3 object stores, business & consumer file storage services, as well as standard transfer protocols. "rclone" hides the differences of the various targets by a simple configuration process.

    TC expects a so called "remote" element preconfigured by the customer, to be able to upload the screen recordings to the remote location. Authentication is done during the configuration process.

    Rclone executes checks on:

    • duplicated uploads
    • size and content of the target file
    • resend in case of broken uploads

    Rclone and its configuration parameters may be either deployed by IT, or through the customer's upload script. Rclone is able to manage proxy based on preconfigured environment parameters:

    HTTP_PROXY=http://mm:password@192.168.1.2:3128

    HTTPS_PROXY=http://mm:password@192.168.1.2:3128