Avid | Illuminate Quick Start Guide Release 2018.12 Contents Contents ....................................................................................................... 2 Using this Guide .......................................................................................... 3 Revision History .......................................................................................................... 3 Symbols and Conventions .......................................................................................... 3 1 About Avid | Illuminate ..................................................................... 4 Supported Host Systems ............................................................................................ 4 What’s Provided .......................................................................................................... 4 2 Before You Begin .............................................................................. 5 Networking and Security ........................................................................................ 5 Operating System Notes ........................................................................................ 5 3 Installation and Activation ............................................................... 6 Installing Avid Illuminate on Microsoft Windows ......................................................... 6 Preparing the Software Package ........................................................................... 6 Installing the Language Pack ................................................................................. 6 Installing Microsoft Visual C++ ............................................................................... 7 Activating Avid Illuminate ....................................................................................... 8 Starting Avid Illuminate Processor API ................................................................10 Installing Avid Illuminate on CentOS .........................................................................10 Preparing the Software Package .........................................................................10 Installing Prerequisite Software ...........................................................................11 Installing the Language Pack ...............................................................................12 Activating Avid Illuminate .....................................................................................13 Starting Avid Illuminate Processor API ................................................................14 Installing Avid Illuminate for Docker ..........................................................................15 Verify the Docker installation................................................................................15 Preparing the Software Package .........................................................................16 Loading Avid Illuminate ........................................................................................17 Activating Avid Illuminate .....................................................................................18 Starting Avid Illuminate Processor API ................................................................19 4 Using Avid Illuminate | Operation Utility ....................................... 20 Start the Operation Utility app: .............................................................................20 List operations: .....................................................................................................21 Create Measurement: ..........................................................................................22 Create Alignment .................................................................................................24 5 Working with Sample Templates ................................................... 24 Copyright and Disclaimer .....................................................................................25 Using this Guide Revision History Date Comment December 2018 Illuminate V2018.12 Release November 2018 Illuminate V2018.8.2 Release October 2018 Illuminate V2018.8.1 Release August 2018 Illuminate v2018.8; Added Processor API & Operation Utility May 2018 Illuminate v2018.5; Added section ―Working with Samples‖ January 2018 Illuminate v3.1 Release July 2017 Illuminate v3.0 Release June 2017 Illuminate v3.0 Beta Release Symbols and Conventions Avid documentation uses the following symbols and conventions: Symbol or Convention Meaning or Action A note provides important related information, reminders, Note recommendations, and strong suggestions. A caution means that a specific action you take causes you to lose data. Courier Courier on gray background indicates code examples. Italic font Italic font is used to emphasize certain words. Courier bold font Courier bold font identifies text that you type. > This symbol indicates menu commands (and subcommands) in the order you select them. For example, File > Import means open the File menu and then select the Import command. <placeholder, variable> Angle brackets indicate placeholders or variables. UPPER CASE Indicates names of processes, process classes, data model attributes, legal lists, legal list values, states of tasks, and templates 1 About Avid | Illuminate The Avid Illuminate suite enables users to automatically verify captioning, video description, and languages with unrivalled speed, accuracy, and scalability. Avid Illuminate frees you from the time, expense, and stress of validating content. Whether you‘re authoring captions, preparing them for online or OTT distribution, reporting on broadcast compliance, or working in multilingual playout and distribution environments, Avid Illuminate eases the burden of quality control to ensure the best viewer experience possible. Supported Host Systems Avid Illuminate can be installed in any of the following environments: CentOS 7.x 64-bit Ubuntu 16.04 LTS 64-bit Microsoft Windows Server 2008 R2 SP1 or later. Microsoft Windows 7 SP1 or later. Docker – For any OS What’s Provided Avid Illuminate consists of the following components: Component Function Software The Avid Illuminate main software package. When you unzip this archive, two sub-folders are created: Centos7-x64 — Contains the Linux and Docker versions Win-x64 — Contains the Windows version Language Packs One or more language packages are delivered separately from the main software archive. Activation ID and System ID Required to license the software, these ID codes are provided via e-mail. Documentation Release Notes and User's Guide are included in the software package. Once extracted, the files can be located at: /avid/illuminate/doc. Note: The documentation included in the Avid Illuminate archive is created in the Markdown language format. To view the documentation, you will need a viewer capable of displaying the content correctly such as Notepad++. For download locations and more information on Notepad++, see https://notepad-plus-plus.org/. 4 2 Before You Begin Prior to installing Avid Illuminate, review the following information as it applies to your installation method (Windows, CentOS, or Docker). Networking and Security Avid Illuminate supports both static and dynamic IP addressing of the host machine. Some aspects of the installation, such as licensing, and package installation, require a connection to the Internet. Prior to starting the installation, make sure that the host server has public network access. Avid supports Avid Illuminate with network firewalls enabled. However when licensing the software, you must ensure that port 3443 is allowed to communicate through the firewall. For more information on port usage for Avid software, see: http://avid.force.com/pkb/articles/en_US/readme/Avid-Networking-Port-Usage-Guide Installing antivirus applications on the host machine is supported by Avid. Operating System Notes Microsoft Windows: When activating Avid Illuminate, you should be logged into Windows as a user with local Administrator access. When running Avid Illuminate, only standard user-level access is required. CentOS: When installing Avid Illuminate, you should be logged into CentOS as a user with wheel/sudoer privilege; however, do not activate as root or use the sudo command when activating; you will be prompted for your password when it is required during activation. Avid supports running Illuminate with SE Linux enabled Docker: This document includes information on running Avid Illuminate as a container on an operating system configured with Docker. The process to install Docker is not covered in this document. If you plan to use Docker, make sure that the Docker components are already installed. For more information see the Docker website at: https://www.docker.com/ 5 3 Installation and Activation This section details the process to install and activate Avid Illuminate in one of three host environments. To begin the installation process, refer to one of the following sections: Installing Avid Illuminate on Microsoft Windows Installing Avid Illuminate on CentOS Installing Avid Illuminate for Docker Installing Avid Illuminate on Microsoft Windows Avid Illuminate does not use a traditional installation wizard that is common to many Windows applications. Instead, the application is run within a command line interface that is immediately available after unzipping the software package. However, you must install multiple prerequisite components and activate the Illuminate software