Avid Media | Index Configuration Guide Version 2.
Legal Notices Product specifications are subject to change without notice and do not represent a commitment on the part of Avid Technology, Inc. This product is subject to the terms and conditions of a software license agreement provided with the software. The product may only be used in accordance with the license agreement. This product may be protected by one or more U.S. and non-U.S patents. Details are available at www.avid.com/patents. This document is protected under copyright law.
Permission to use, copy, modify, and distribute this software for any purpose without fee is hereby granted, provided that this entire notice is included in all copies of any software which is or includes a copy or modification of this software and in all copies of the supporting documentation for such software. THIS SOFTWARE IS BEING PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED WARRANTY.
Permission has been granted to copy, distribute and modify gd in any context without fee, including a commercial application, provided that this notice is present in user-accessible supporting documentation. This does not affect your ownership of the derived work itself, and the intent is to assure proper credit for the authors of gd, not to interfere with your productive use of gd. If you have questions, ask. "Derived works" includes all programs that utilize the library.
Contents Using This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Symbols and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 If You Need Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Avid Training Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 7 Installing and Configuring Production Services for MediaCentral Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Understanding Production Services for MediaCentral Delivery . . . . . . . . . . . . . . . . . . . . . . . 44 Check List for Installing and Configuring Automation and Consolidate Services . . . . . . . . . . 45 Prerequisites for Installing and Configuring Automation and Consolidate Services . . . . . . . .
Using This Guide This guide is intended for users of Avid MediaCentral Platform Services (MCS) with the Media | Index feature. This guide describes the configuration procedures for Media Index, such as configuring Media Index for cluster and single-node installations.. For information on installing MCS, see the MediaCentral Platform Services Installation and Configuration Guide. For administrative information for MediaCentral | UX, see the Avid MediaCentral | UX Administration Guide.
If You Need Help If You Need Help If you are having trouble using your Avid product: 1. Retry the action, carefully following the instructions given for that task in this guide. It is especially important to check each step of your workflow. 2. Check the latest information that might have become available after the documentation was published. You should always check online for the most up-to-date release notes or ReadMe because the online version is updated whenever new information becomes available.
1 Media | Index Configuration Overview This document describes the tasks required to configure a Media Index system. Media Index comprises the following components: • Elasticsearch® service, which manages data storage and runs the search engine. • Elasticsearch tribe service, the federated client that enables multi-zone search functionality. • Data Import API, a bus-based service for metadata indexing, search, configuration, status, permissions, and updates for Media Index.
Checklist for Configuring Media | Index All required Media Index components install when you install MCS. However, the services needed to run Media Index by default are not set to start automatically since you must configure them before you can use Media Index. Once you complete the configuration of the services, you can enable them to start automatically. Checklist for Configuring Media | Index The following table provides a checklist of steps for configuring Media Index components.
2 Upgrading Media | Index The procedures for upgrading your Media Index configuration depend on which version of MediaCentral Platform Services (MCS) you want to upgrade. If you upgrade from a version earlier than MCS v2.3 — for example, if you upgrade from v2.0 to v2.1 or from v2.1 to v2.3 — you need to reset your Media Index before the upgrade can start. If you upgrade from v2.2.x to v2.3, you only need to migrate any index that you use in your Media Index configuration.
Upgrading Media Index from v2.0.x or v2.1.x 3. On the server hosting a zone within your configuration, list the information about systems within all configured Elasticsearch clusters by typing the following command: /opt/avid/bin/avid-acs-elastic-index-setup -m info The terminal window displays the system information for your Media Index configuration.
Upgrading Media Index from v2.0.x or v2.1.x 2. Using the Linux text editor, vi, open the elasticsearch.yml configuration file for editing: vi elasticsearch.yml 3. In the configuration file, delete the zone bindings information that expose that node to other nodes in the configuration. For example, if you have a two-zone setup — with Zone1 and Zone2 — and you want to upgrade Zone2 first, delete the sections of the configuration file highlighted below: 4.
Upgrading Media Index from v2.2.x to v2.3 or Later 2. Check to make sure the system_data index and index information are not listed. When Media Index is reset for your upgrade process, you can install the latest version of Media Index. For more information, see one of the following topics: - For installing Media Index in a cluster configuration, see “Configuring Media | Index for a Cluster” on page 17.
Reactivating the Cluster After Upgrading 4. Check the cluster state: - If there is no active migration, all index labels appear in black. - If the index has an active migration, its label appears in red with an indication of the migration progress. 5. If there is active migration is in progress, wait for the process to finish before proceeding with the MCS upgrade procedures.
Media | Index Backup Locations Media | Index Backup Locations When you re-install the MediaCentral Platform Services software, a backup of all data is created before a complete re-installation using the USB key. However, indexes are not backed up by the system backup script. This typically does not cause an issue since users generally do not need to back up their indexes.
3 Configuring Media | Index for a Cluster When you set up the Elasticsearch service, you create a node that runs the service on a cluster. Every node in an MCS cluster runs an Elasticsearch instance as well as an Elasticsearch-tribe instance. The Elasticsearch instance runs the indexing process while the Elasticsearch-tribe instance is used for searching. Tribe instances allow you to perform read operations against the nodes in multiple clusters.
Shard Count and Usage Shard Count and Usage When you configure Media Index, you can set the number of primary shards (see “Configuring Media | Index” on page 19). The number of shards in your configuration affects the amount of data that can be stored in your index, although the type of data and metadata affects the size of the index as well. For single node configurations, Avid recommends that you set the default number of shards as 1 and the default number of replicas as 0.
Configuring Media | Index If you need to take a node offline, you can do any of the following, depending on your needs and your setup: • Increase the replica count before removing a node to allow for more nodes to be taken offline. This causes Elasticsearch to copy data on startup, which can consume processor resources. This can be a good solution if you remove multiple nodes.
Configuring Media | Index c • Elasticsearch HTTP Port — Specify the port of the Elasticsearch data node HTTP API. The default value is 9200. In most cases you, you do not need to modify this property. • Elasticsearch Tribe TCP Port — Specify the TCP port of the Elasticsearch tribe node, used for inter-node communications. The default value is 9305. In most cases you, you do not need to modify this property. • Elasticsearch Tribe HTTP Port — Specify the port of the Elasticsearch tribe node HTTP API.
Configuring Media | Index To configure Media Index: 1. Sign in to MediaCentral UX as an administrator. 2. Select System Settings from the Layout selector. The System Settings layout opens. 3. In the Settings pane select Media Index > Settings. The Media Index Settings display in the Details pane. 4. In the Supported Languages section, select the languages you want to make available for searching.
Validating the Media | Index Configuration on a Cluster - Default Shards - Default Replicas 7. Click Apply. It might take a couple of minutes for configuration to finish. A message displays when your configuration completes. This might take some time as Media Index updates configuration files. 8. Click Close. Validating the Media | Index Configuration on a Cluster You can validate your setup by checking the status of the Media Index services and ensuring that they are running.
Validating the Media | Index Configuration on a Cluster 3. In the Settings pane select Media Index > Cluster State. The Media Index Cluster State displays in the Details pane. Media Index Cluster State pane, with the system_data index and two indexes available The core services for your configuration must display a status of “Running,” and the indexes must display the shard count in green. To monitor the fail count within the cluster: 1.
Next Steps for Media | Index Installation 3. In the Settings pane select Media Index > Indexes. The Media Index Indexes status displays in the Details pane. All indexes for your configuration display with their status and details listed in the pane. Next Steps for Media | Index Installation If you are installing Media Index in a multi-zone configuration, see “Setting Up Multi-Zone Search” on page 25.
4 Setting Up Multi-Zone Search In a multi-zone MCS configuration, each zone runs its own Elasticsearch cluster with its own Elasticsearch cluster name. These different Elasticsearch clusters are then connected to each other using the Elasticsearch tribe service. For example, in a two zone configuration, if you call one cluster “Zone1” and another cluster “Zone2,” you need to set the cluster name to Zone1 on all nodes in one MCS cluster and to Zone2 on all nodes in the second MCS cluster.
Setting the Zone Bindings To set a binding to the zone cluster and to update the Elasticsearch tribe configuration: 1. Navigate to the directory containing the Elasticsearch tribe configuration file: cd /etc/elasticsearch-tribe 2. Using the Linux text editor, vi, open the elasticsearch.yml tribe configuration file for editing: vi elasticsearch.yml 3. Add the following lines in the configuration file to add the binding that allows the tribe to connect to another cluster: tribe..
Validating the Elasticsearch Configuration Validating the Elasticsearch Configuration When you finish updating the Elasticsearch configuration file, you can validate your setup by checking the Elasticsearch information for each server. To validate the Elasticsearch configuration: 1. Open a browser and navigate to http://:9200/_plugin/head, where sever_name is the hostname for the server in one zone in your configuration — for example, the local zone.
Validating the Elasticsearch Configuration 1 The local zone data node is listed. 2 The local zone tribe is bound to the local data node. 3 The remote zone tribe is bound to the local data node. 5. Open a browser and navigate to http://:9201/_plugin/head, where sever_name is the hostname for the server in a zone in your configuration — for example, the local zone — and the port number is configured for the tribe node of the zone.
Validating the Elasticsearch Configuration - "MCS-Master-Node3:9300" - "localhost:9300" http.port: 9201 transport.tcp.port: 9305 node.name: MCS-Master-Node1-tribe tribe.remote.cluster.name: MCSclusterHostname-Slave-Zone tribe.remote.transport.tcp.port: 9313 tribe.remote.discovery.zen.ping.unicast.hosts: - "MCS-Slave-Node1:9300" - "MCS-Slave-Node2:9300" - "MCS-Slave-Node3:9300" n "The elasticsearch.yml on the Slave node in the Master Zone is the same as the Master in the Master zone, except for the node.
Removing Zones from a Multi-Zone Configuration Removing Zones from a Multi-Zone Configuration If you want to remove a zone from your multi-zone configuration, you must first remove the bindings for each zone cluster. To remove the zone information in the Elasticsearch tribe configuration file before removing a zone in your multi-zone setup: 1. On each node that you want to upgrade, navigate to the directory containing the Elasticsearch tribe configuration file: cd /etc/elasticsearch-tribe 2.
5 Configuring Media | Index for a Single Node When you set up the Elasticsearch service, you create a node that runs a single Elasticsearch instance. The Elasticsearch instance runs the indexing process while the Elasticsearch-tribe instance is used for searching. When you create an index, Elasticsearch creates a number of “shards” and “replicas,” each shard containing indexed data and each replica containing a copy of that data. You use replicas to spread the search load and provide redundancy.
Configuring Media | Index for a Single Node 3. Delete the hostname value and type the value you want to use to assign to nodes. n If the node name variable is not set, Elasticsearch automatically generates node names when your node starts. If it is set to hostname, Elasticsearch uses the hostname of the node where the service is running. 4. Press the Escape key to return to command mode, then type :wq and press Return to write and quit the text editor. 5.
Configuring Media | Index for a Single Node Media Index supports multiple languages for your search. However, enabling all languages can slow down searches. You should enable only those languages your users require. If you work with a multi-zone configuration, you can enable different languages for each zone, and these languages are then available for all indexes within the specified zone.
Configuring Media | Index for a Single Node 3. In the Settings pane select Media Index > Settings. The Media Index Settings display in the Details pane. 4. Specify the required settings for the following properties: - n Cluster Name (hostname or IP address of the local Media Central node) Hostnames can include only letters, numbers, dashes, and underscore symbols.
Validating the Media | Index Configuration on a Single Node Validating the Media | Index Configuration on a Single Node You can validate your setup by checking the status of the Media Index services and ensuring that they are running. Using the Cluster State pane in MediaCentral UX, you can view your node with core services running and see that the system data index is available. To check the current status of Media Index: 1. Sign in to MediaCentral UX as an administrator. 2.
6 Production Engine Bus Connector Installation The Production Engine Bus Connector (PEBCo) service requires Interplay Engine v3.1 or later. If you upgrade from v3.1 to a more recent version, the upgrade requires the database to be reloaded, which might take a little time depending on the size of the database. Once reloaded, the new database cannot be used with earlier versions of the Interplay Engine.
n You must enable sync events on each Interplay Production server in your configuration. To enable the sync events (Media Index v2.3 or later): 1. Start Interplay Administrator and log on to the Interplay Production or Interplay Archive database that you want to be indexed. n You must use Interplay Administrator v3.3 or later. 2. In the Server section of the Interplay Administrator, click the Server Settings icon. The Server Settings view opens. 3.
Creating a PEBCo Instance on a Single Node Creating a PEBCo Instance on a Single Node The PEBCo is installed with your MCS installation. You must set up the service on the node before you can use it. To create a PEBCo instance: 1. Type the following command to create a PEBCo instance: pam-agent-ctrl add can be any meaningful name. Avid recommends that you use the MCS host name so the PEBCo instance can be easily identified. 2.
Configuring the ICS Bus Service in Interplay Administrator - To start the PEBCo instance, type the following command: crm resource start Configuring the ICS Bus Service in Interplay Administrator The PEBCo configuration requires a series of bus calls to the ICS server. For the configuration to be successful, the Interplay Production and Interplay Archive engines must have the proper bus URL so that the Interplay Administrator can configure the service correctly.
Configuring and Using the Production Engine Bus Connector Service Configuring and Using the Production Engine Bus Connector Service Every PEBCo instance is bound to no more than one Interplay Production or Interplay Archive database. You configure the PEBCo service in the Production Engine Bus Connector view in the Interplay Administrator.
Configuring and Using the Production Engine Bus Connector Service • n c The Canonical Data tab lets you select the Properties used in the indexing process and that users can select when performing an indexed search in MediaCentral UX. Some properties are part of the standard data model. These properties are already selected in the Canonical Data tab, and you cannot deselect them. Before you can start the first indexing operation, you must specify the Canonical Data set in the Canonical Data tab.
Configuring and Using the Production Engine Bus Connector Service Due to differences in the properties and fields used by Interplay Production and Media Index, some duplication appears in the criteria available for indexed searches with both Interplay Production and Media Index fields appearing. If you add the wrong fields as criteria, your search might not return any usable results.
Configuring and Using the Production Engine Bus Connector Service n Media Index base properties and common properties are selected by default, and you cannot deselect these properties. 3. Click Apply to save your selections and to make them available in MediaCentral UX. To manage an instance of the PEBCo service: t In the Manage section of the Manage/Status tab, click one of the following: - Start to start the service. - Stop to stop the service.
7 Installing and Configuring Production Services for MediaCentral Delivery The Production Automation service and the Interplay Consolidate service are used for the MediaCentral Delivery feature.
Check List for Installing and Configuring Automation and Consolidate Services The following illustration shows the Production Services components and a Delivery workflow. MediaCentral Client (Browser) q Production Services Engine w e e w Media Services Automation r w Interplay Consolidate Interplay Delivery 1. The user initiates a Delivery request. 2. The Production Services Engine forwards the request to the Production Services Automation service, which determines the next step. 3.
Prerequisites for Installing and Configuring Automation and Consolidate Services Production Services Check List(Continued) Task Section Reference b Connect the Avid shared storage client to the Avid shared storage client documentation. System Director and mount the required workspaces. b Create at least one Interplay Consolidate profile. “Creating a Consolidate Profile” on page 53 No profile is needed for Production Services Automation.
Installing the Automation and Consolidate Services c When you create a Delivery profile for MediaCentral, use a network path to an Avid shared storage share for the Temporary Workspace on Sender parameter. For example, use \\avidstorage_server\Delivery_temp. This storage space is used for temporary media files created by the Interplay Consolidate service. If you use a local folder, the large amount of media created can cause system problems for the Delivery server.
Registering the Automation and Consolidate Services 4. Accept the license agreement and click Next. 5. Follow the prompts to install Access. Registering the Automation and Consolidate Services To register the Automation and Consolidate services, you need to open the Production Services and Transfer Status tool and install the service description. You only need to install a service description once, even if you configure multiple providers. n Registration of other Production Services is automatic.
Registering a Provider with the Production Services Engine 6. In the folder, select the service.zip file. 7. Click Save. The path to the file appears in the Install/Upgrade Service dialog box. 8. Click Install/Upgrade. The service and its description appear on the Services page. The following illustration shows both services after they are registered. Registering a Provider with the Production Services Engine A service that is installed and registered is referred to as a provider.
Registering a Provider with the Production Services Engine To register a Production Services Automation provider with the Production Services Engine: 1. Locate the .ini file and open it in a text editor, such as Windows Notepad. The following table lists the services with the folder that holds the .ini file and the log files. Service Name Folder for .ini File and Log Files Interplay | Production Services Automation C:\ProgramData\Avid\Production Services Automation\DMSCMService.ini 2.
Registering a Provider with the Production Services Engine 3. Click the Providers tab. The system displays the status of the Production Services providers. In the following illustration, all services are connected, indicated by a check mark in the Status column. Production Services Automation is circled. You can also view the services in the Services tab of the Computer Management window. Registering and Connecting a Consolidate Provider Interplay Consolidate runs as a Windows application.
Registering a Provider with the Production Services Engine To connect the Consolidate provider to the Production Services Engine: 1. Click Start and select Programs > Avid > Avid Interplay Consolidate. The Consolidate Service dialog box opens. 2. Click Settings. The Provider Settings dialog box opens. 3. Do the following: a. Provider Name — A default name for the provider is automatically supplied. Accept the default name or type a new name. In this example, the name is Consolidate_01. b.
Creating a Consolidate Profile 5. Click Connect in the Service window. The Consolidate Service dialog box now shows that the service is connected and shows the name of the provider you connected. The Provider page in the Production Services and Transfer Status tool now shows that the Consolidate service is connected, indicated by a check mark in the Status column.
Creating a Consolidate Profile The following illustration shows a profile with DV 25 420 as the TargetVideoQuality. The following illustration shows the Deliver To dialog box, with Deliver from Mark In to Mark Out selected, and the Target Video Quality as DV 25 420. The Target Video Quality is taken from the Consolidate profile. This resolution will be used for the new media, because the Target Video Quality specified in the Delivery profile is “highest” rather than a specific resolution.
Creating a Consolidate Profile To create a Consolidate profile: 1. Start the Production Services Engine. 2. Click the Admin Tool button. The Interplay Production Services and Transfer Status tool opens. 3. Click the Profiles tab. 4. In the Service menu, select Avid Interplay Consolidate Service. 5. Click Add in the Profiles area. The Add Profile dialog box opens. 6. Type “default_for_delivery” in the Add Profile dialog box. 7. Click OK.
Creating a Consolidate Profile Consolidate Profile Settings(Continued) Parameter Description TargetVideoQuality Select a video resolution for the consolidate operation. Select None if you do not want the transcoded clip to include a video track. WorkspaceAudio The name of the Avid shared-storage workspace that will hold the new audio media files. Use the following syntax: \\hostname\workspace_name WorkspaceVideo The name of the Avid shared-storage workspace that will hold the new video media files.
8 Setting Up Interplay | MAM Sync Service The following topics provide basic information to help you get started using Avid Interplay | MAM Sync Service Administrator: • About Interplay | MAM Sync Service Administrator • Opening Sync Service Administrator • Understanding the Sync Service Administrator Layout • Quitting Sync Service Administrator For more information on using the Interplay MAM Sync Service Administrator, see the Interplay | MAM Sync Service Administrator User’s Guide.
About Interplay | MAM Sync Service Administrator Note the following limitations: • All Attributes marked as “searchable” in the MAM data model are always sent to Central Index during synchronization; attributes marked as “not searchable” are not sent to Central Index and are not available for searching or in search-result lists. • Multi-value (MV) attributes and multi-value compound (MVC) attributes cannot be used for searching in Central Index and cannot be displayed in search-result lists.
About Interplay | MAM Sync Service Administrator Sync Service Administrator Configuration Options Some Sync Service Administrator features are subject to configuration. The default MAM installation comes with a full set of default configuration settings for Sync Service Administrator.
Opening Sync Service Administrator 7. Select the profile SyncCentralIndex > section Toggles and check if the value of the key EnableNewThesauriIds has the required value: n - True: Enables the new ID format for thesauri and legal lists. Recommended for new installations of Interplay MAM v5.4/MediaCental v2.5, or updating an installation with a small amount of data. Setting the value to “true” requires rebuilding the index for all assets. - False: This is the default value; allows the use of MAM v5.
Understanding the Sync Service Administrator Layout Understanding the Sync Service Administrator Layout Once you have logged in, Sync Service Administrator opens and displays the Monitor view. Sync Service Administrator includes the following areas and views: Area Function Title bar The Show mapping info link provides information on attribute mapping between Interplay MAM and Central Index.
Understanding the Sync Service Administrator Layout The Monitor View In most cases, your first experience with Sync Service Administrator will be in Monitor view, where the basic Sync Service Administrator features are close at hand. The Monitor view is arranged in six sections that provide information and controls to set up basic Sync Service Administrator functions. The following illustration and table describe the layout of the Monitor view.
Understanding the Sync Service Administrator Layout Item Function 3 Details Displays detailed information about the entry selected in the Recent events list. 4 Water mark indicator Indicates the load of the synchronization queue as a traffic light. Sync Index Administrator checks the number of high-priority entries in the DM_Sync table and shows a traffic light depending on water mark settings. You can update the water mark indicator manually by clicking the Refresh button.
Understanding the Sync Service Administrator Layout Item 1 Refresh controls Function Sync Service Administrator updates the display of recently synchronized objects every five seconds if the Auto refresh check box is checked. If you uncheck the Auto refresh check box you can update the display manually by clicking the Refresh button. 2 Synchronized objects list Displays a configurable number of recently synchronized objects (default is 3,000).
Understanding the Sync Service Administrator Layout The MAM / CI Compare View The MAM / CI Compare view provides statistics on the number of objects in MAM and Central Index per object class, and differences between them. Information is provided for object (asset) and EDL (sequence) classes. The information is displayed in an overview table, as shown in the following illustration. It shows the number of objects for each object and EDL class in MAM and Central Index.
Quitting Sync Service Administrator The Errors View The Errors view provides statistics on synchronization errors, and controls to reset or purge erroneous synchronization entries in Central Index.The following illustration and table describe the layout of the Errors view. Function 1 Refreshes the entries in the Object class table. 2 Displays the number of synchronization errors for each affected object class.
9 Setting Up iNEWS for Media | Index Integration When integrating iNEWS with Media Index, the iNEWS system relies on the sync agent in the Mediaindex utility program to push stories to Media Index. It must be configured to control what data gets indexed. To specify which Media Index the iNEWS system should use also requires configuration within iNEWS. This integration first appeared with the release of iNEWS v5.
iNEWS v5.2.x iNEWS v5.
Manually Installing the log4cpp File 5. Start up the Mediaindex program. These steps are a high-level overview of what must be done to properly set up iNEWS and Media Index integration. Each step is explained in more detail in later sections. However, they do not represent all information involved in setting up Fast Text Search on iNEWS, only those steps directly related to Media Index integration.
Editing iNEWS Site Files You need to point the Mediaindex program to the message broker by adding a definition in the /site/ dict/words file: • W_BINDBUS – Identifies the binding address for the Media Central platform’s bus server port, which is necessary for central indexing as part of iNEWS integration with Media Index.
Editing iNEWS Site Files 2. Open and edit the configuration file, by typing (what appears in bold): WAVD-A$ ed /site/config After you press Enter, the editor responds by displaying a numerical value indicating the file size expressed as the number of characters, including spaces and returns.
(Optional) Enabling Logging (Optional) Enabling Logging Should you need to troubleshoot search integration, before restarting Media Index, enable logging. To enable logging: 1. Create the file /site/env/mediaindex. 2. In the file, on separate lines, type: DEBUG=7 DEBUGFILE=/tmp/mediaindex Assigning the Media | Index Attribute Define which queues or folders in the iNEWS directory get indexed to Media Index by applying the Media Index attribute.
Activating the Mediaindex Program The system will display information similar to this example, in which case the device number is 122, located in the NOTIFY column: DEV DEVICE_TYPE S122 mediaindex COMPUTER NOTIFY B OPTIONS DEVNAME 122 To activate Mediaindex: t Use the restart console command in the following format: restart For example: select the appropriate server at the console, and type: restart 122 n (Optional) Use the stop command to stop the program, such as # stop 122
A Using the Media | Index Command Line Tool The Media Index command line tool provides the following functionality: • Create system data index • Reload localization strings for base, common and time-based data fields (see “Updating Localization Strings” on page 74) • Display information about systems in a zone (see “Displaying Information about Initialized Systems” on page 74) • Change the replica count for indexes in a zone (see “Changing Replica Counts” on page 75) • Set the interval used for ref
Changing Replica Counts To display system information, do the following: t Type the following command: avid-acs-elastic-index-setup -m info Changing Replica Counts You can change the number of replicas for all indexes, for indexes at the specified alias, or for a specific index. You can view index names and any index alias names by using the Elasticsearch head plug-in Web page, which you can view by opening a browser and navigating to http://:9200/_plugin/head.
Changing the Index Refresh Interval the index.refresh_interval setting, which you can modify in either the Elasticsearch configuration file or the settings for each index. Because the refresh operation draws on system resources, one way to improve indexing performance is by increasing refresh_interval. The Media Index command line tool provides an option to change the refresh interval per system, and you can use the tool to increase the indexing throughput.
B Media | Index Custom Configuration The default setup described in this document covers most MCS configurations. In some instances, you might need to configure certain property files. n For more information on modifying the application properties file, see “Modifying application.properties” in the MediaCentral Platform Services Installation and Configuration Guide.
Using the Media | Index System Settings Area or Component Description System Name (optional) The system name is set by the indexing agent. For Interplay Production, the system name is set by the Production Engine Bus Connector (PEBCo) and uses the workgroup name by default. Other indexing agents — for example, the iNEWS sync agent — might not assign a system name by default. You can add or modify the system name so that users can easily identify the index used during an indexed search.
Using the Media | Index System Settings 3. In the Settings pane select Media Index > Indexes. The Media Index Indexes display in the Details pane. 4. If you want to add or modify the name that appears in the System search criterion in indexed searches, type the name in the System Name field, and then click Apply. For more information on using search criteria to filter searches, see “Advanced Search Filters” in the Avid MediaCentral | UX User’s Guide. 5.
Using the Media | Index System Settings 3. In the Settings pane select Media Index > Settings. The Media Index Settings display in the Details pane. 4. If you want to modify the name of the cluster, type the name in the Cluster Name field, and then click Apply. c If you change the cluster name, during a restart Elasticsearch creates a new data folder.
Using the Media | Index System Settings 3. In the Settings pane select Media Index > Settings. The Media Index Settings display in the Details pane. 4. In the Reset Media | Index section, click Reset. c c Deleting all systems and resetting Media Index removes the systems and all data from the index. A reset also removes the Elasticsearch tribe configuration. The old configuration is saved in a backup file next to the new one so that the tribe configuration can be copied and restored.
Setting Elasticsearch Memory Usage c. Copy the configuration information, and then press the Escape key to return to command mode. d. Open the elasticsearch.yml configuration file for editing: vi elasticsearch.yml e. Paste the information from the backup file into the configuration file. f. Press the Escape key to return to command mode, then type :wq and press Return to write and quit the text editor. g.
Configuring the PEBCo for Custom Configurations 7. Type the following command to restart the Elasticsearch service: t For single node installations: service elasticsearch-tribe restart t For cluster installations: crm resource restart elasticsearchTribeEverywhere n In cluster configurations, you must restart the Elasticsearch tribe service after you implement your change on every node of the cluster.
Changing the Maximum Number of Markers Returned in a Search To specify the default search and search behavior: 1. Navigate to the directory containing the MediaCentral application properties file: /opt/avid/etc/avid/avid-interplay-central/config 2. Using the Linux text editor, vi, open the application.properties file for editing: vi application.properties n In some cases, this Application Properties file might not exist. Create the file using vi and add the lines indicated in the steps below.
Using the Media | Index Restart Command Line Tool 3. Delete the value at the end of the line and type the value you want to use. 4. Press the Escape key to return to command mode, then type :wq and press Return to write and quit the text editor. Using the Media | Index Restart Command Line Tool You can use the Media Index restart command line tool to start, stop, and restart all or some Media Index services.
Restarting Media Index Services The following table includes examples of using the command line tool: Description Command Restart specific services in a single-node configuration ./avid-acs-media-index-restart.sh elasticsearch elasticsearch-tribe restart Stop all services in a single-node configuration ./avid-acs-media-index-restart.sh stop Start specific services in a cluster configuration ./avid-acs-media-index-restart.sh start Restart all services in a cluster configuration .
Adjusting Relevance for Search Results You can adjust the scalability functionality by modifying environmental variables in the following file: /etc/sysconfig/avid-acs-search. Variable Description SEARCH_CLUSTER_THREADS_MINIMUM = Sets the minimal number of search service instances. If not set, the variable defaults to the number of CPUs. SEARCH_CLUSTER_THREADS_MAXIMUM = Sets the maximum number of instances.
Adjusting Relevance for Search Results To adjust the index boosting settings: 1. Log in to your MediaCentral server as an administrator, and type the following command in a terminal window to start the service providing the Avid Common Services Monitor: service avid-acs-monitor start 2. Open a browser window and enter the following into the address bar: :8000/acs.html The ACS Monitor page opens. 3.
Adjusting Relevance for Search Results indicates the asset field name for which you want to boost relevance, and is an integer that sets the boosting value (“1” is the maximum relevance value). For example: 4. Click Send. You can click the Response tab and then click Query to see that the command successfully was applied to the result set.
Disabling Search Suggestions 5. You can restore the default index boost settings by typing the following command in the Request to: Local text box and then clicking Send: { "serviceType": "avid.acs.media.index.
Disabling Search Suggestions 3. In the avid.acs.media.index.configuration section, click setConfigurationByField. The setConfigurationByField command displays in the Request to: Local pane. 4. Remove the parameter and parameter value for the acs_enable_query_logger.
Configuring Search Criteria Behavior n You also must remove the comma at the end of the preceding line. 5. Click Query. Search suggestion data are disabled and the new configuration is saved. 6. Restart the Media Index services. For information on restarting services, see “Restarting Media Index Services” on page 86.
Restarting the Search and PEBCo Services 3. In the avid.acs.media.index.configuration section, click setConfiguration. The setConfiguration command displays in the Request to: Local pane. 4. Edit the parameter value for the acs_criteria_filter_settings.
Restarting the Search and PEBCo Services 3. In the Settings pane select Media Index > Cluster State. The Media Index Cluster State displays in the Details pane. You can identify the node displaying problems by checking the status of the search services. To restart the search service and to resync the PEBCo service: 1. Log in to the MCS node as the root user. 2. To restart the indexed search service, type the following command: service elasticsearch restart 3.
Restarting the Search and PEBCo Services 8. Click the Manage Status tab. 9. In the Manage section, click Resync to update the whole database content. Resyncing the database might take a long time to complete and invalidates the existing content of your index. During this process, the search only returns assets that are already processed within this run.
C Updating Media | Index Property Schemas Each Media Index index has a schema specific to its source system. You configure the schema in the Production Engine Bus Connector (PEBCo — for more information, see “Configuring and Using the Production Engine Bus Connector Service” on page 40). If the list of fields in the PEBCo Canonical Data tab that you configure for indexing changes, then you must migrate the index to this new schema before the system can index new assets.
Property Changes in Production and Schema Updates Changing Properties Without Immediately Updating All Assets This approach adds properties to the index, but only new or updated assets carry the new properties. It performs a re-index so there is no interruption for the user. Index updates are blocked for all indexes until the re-indexing completes. After pressing Start, you might receive a timeout error after 10 seconds. This is expected, as the re-index operation needs more than 10 seconds to complete.
Property Changes in Production and Schema Updates 7. Click Resync to update the whole database content independent from any existing saved timestamp. Resyncing the database might take a long time to complete and will invalidate the existing content of your index. During this process, the search only returns assets that are already processed within this run.
Monitor the Re-index Process Monitor the Re-index Process You can monitor the re-index process in the Cluster State pane of the Media Index System Settings. During the re-index, the process creates a new, temporary index which gradually fills up with copies of the existing assets. Once the re-index is complete, Media Index deletes the original index and makes the new index active. By monitoring the number of documents in the existing and the new index, you can monitor the progress of the re-index process.
Monitor the Re-index Process Before re-indexing the Head plug-in displays one entry for each index and one system_data entry for the overall metadata store: Original index status When re-index starts, there is one additional column with the same basic name as the original index and a different ID at the end. The new index does not have the color bars that mark it as an active index. While the re-index progresses, the docs count slowly increases until it reaches the same number as the original index.
Monitor the Re-index Process You can also monitor the progress and duration of the re-index process by comparing the number of assets listed in the Interplay Administrator tool (in the Object Statistics tab of the Database Information settings) with the assets listed in the MediaCentral UX System Settings (in the Assets list in the Media | Index > Indexes pane). The duration of the re-indexing process depends on a number of variables, such as the number of markers in the assets.
Avid Technical Support (USA) Product Information 75 Network Drive Burlington, MA 01803-2756 USA Visit the Online Support Center at www.avid.com/support For company and product information, visit us on the web at www.avid.