Avid® Interplay™ Engine and Avid Interplay Archive Engine Administration Guide m a k e m a n a g e m ove | m e d i a ™ Avid ®
Copyright and Disclaimer Product specifications are subject to change without notice and do not represent a commitment on the part of Avid Technology, Inc. The software described in this document is furnished under a license agreement. You can obtain a copy of that license by visiting Avid's Web site at www.avid.com. The terms of that license are also available in the product in the same directory as the software.
Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation. This software is provided "as is" without express or implied warranty. Copyright 1996 Daniel Dardailler.
Avid Interplay contains components licensed from LavanTech. These components may only be used as part of and in connection with Avid Interplay. Attn. Government User(s). Restricted Rights Legend U.S. GOVERNMENT RESTRICTED RIGHTS. This Software and its documentation are “commercial computer software” or “commercial computer software documentation.” In the event that such Software or documentation is acquired by or on behalf of a unit or agency of the U.S.
Contents Using This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Symbols and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 If You Need Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Viewing Documentation on the Avid Interplay Portal . . . . . . . . . . . . . . . . . . . . . . . . 13 Avid Interplay Documentation . . . . . . . . . . . . .
Locking and Unlocking Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Managing Databases: Deactivating, Activating, and Migrating . . . . . . . . . . . . . . . . 44 Deactivating a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Activating a Deactivated Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Migrating a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Viewing and Setting Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Understanding Standard Roles and Default Rights . . . . . . . . . . . . . . . . . . . . . . 80 Viewing and Changing Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Viewing and Setting Authentication Providers for Individual Users . . . . . . . . . . 83 Deleting Users and User Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Pro Tools Plug-Ins Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Installing the Pro Tools Plug-Ins for Interplay . . . . . . . . . . . . . . . . . . . . . . . . . 120 Configuring the Pro Tools Import Plug-In . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Configuring the Pro Tools Export Plug-In . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Configuring the Pro Tools User Settings Plug-In. . . . . . . . . . . . . . . . . . . . . . .
Avid Interplay Engine Servers and Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Avid Interplay Engine Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Avid Workgroup HTTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Avid Workgroup Server Browser Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Avid Workgroup Preview Server Service . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using This Guide Congratulations on your purchase of Avid® Interplay™, a powerful system for managing media in a shared storage environment. This guide is intended for all Avid Interplay administrators who are responsible for installing, configuring and maintaining an Avid Interplay Engine or Avid Interplay Archive Engine (database, server, and all related client connections and user rights) in an Interplay workgroup.
Symbol or Convention Meaning or Action (Windows), (Windows only), (Macintosh), or (Macintosh only) This text indicates that the information applies only to the specified operating system, either Windows XP or Macintosh OS X. Bold font Bold font is primarily used in task instructions to identify user interface items and keyboard sequences. Italic font Italic font is used to emphasize certain words and to indicate variables. Courier Bold font Courier Bold font identifies text that you type.
Viewing Documentation on the Avid Interplay Portal Viewing Documentation on the Avid Interplay Portal You can quickly access PDF versions of the Avid Interplay user guides from any system in the Avid Interplay environment. To open the Avid Interplay Portal web page: 1. Type the following line in your web browser: http://Interplay_Engine_name For Interplay_Engine_name substitute the name of the computer running the Interplay Engine software.
• Avid CaptureManager User’s Guide — describes how to use CaptureManager™ in a newsroom environment to coordinate video feeds, schedule feed captures at both high and low resolutions, and record late breaking events instantly. • Avid Low Res Encode Setup and Configuration — describes how to set up and configure an Avid Low Res Encode system. Includes information on updating the bootset, root disk image, and configuring a Low Res Encode system to work with CaptureManager.
Avid Training Services Avid Training Services Avid makes lifelong learning, career advancement, and personal development easy and convenient. Avid understands that the knowledge you need to differentiate yourself is always changing, and Avid continually updates course content and offers new training delivery methods that accommodate your pressured and competitive work environment. To learn about Avid's new online learning environment, Avid Learning Excellerator (ALEX), visit http://learn.avid.com.
AVID CONFIDENTIAL DRAFT VERSION 9/18/07
1 Getting Started with the Avid Interplay Administrator The Avid Interplay Administrator provides database administrators and maintenance engineers with the tools required to configure the Avid Interplay Engine and to manage the database on the server.
1 Getting Started with the Avid Interplay Administrator An Interplay database consists of two parts: • A metadata database, which holds information about the assets, or metadata. The metadata database is always stored on the Interplay Engine server. • Source files for the assets, for example, graphics files or Avid media files. The source files for the assets are usually stored on an Avid Unity shared storage system.
Understanding the Interplay Engine and Interplay Workgroups Media files for Avid assets are always stored on an Avid Unity shared storage system. Source files for file assets can be stored on the Interplay Engine or on an Avid Unity shared storage workspace. Avid recommends that you store the source files for file assets on an Avid Unity shared storage workspace. This location is sometimes called the file repository.
1 Getting Started with the Avid Interplay Administrator Interplay online database Interplay Archive Engine database For more information about the Interplay Archive Engine, see Avid Interplay Best Practices. n In this guide, references to the Interplay Engine also refer to the Archive Engine, unless otherwise noted. Central Configuration Server If a production facility includes more than one Interplay workgroup, you can specify one Interplay Engine as the Central Configuration Server (CCS).
Using the Avid Interplay Administrator For more information, see “Troubleshooting the Server Execution User Account” on page 130. Avid Interplay as a Client-Server Application Avid Interplay is designed as a client-server application. The Interplay Engine is configured to run on a central machine that is accessible to all users through a network. An Avid Interplay application that runs on a client machine is a client of the Avid Interplay Engine server.
1 Getting Started with the Avid Interplay Administrator • Configuring the Interplay Archive Engine. See “Specifying Archive Settings” on page 107. For more information on archiving, see Avid Interplay Best Practices and the Avid Interplay Media Services Setup and User’s Guide. • Configuring Editor Settings and Avid Interplay Services. See “Editor Settings” on page 111 and “Avid Interplay Services” on page 125. Starting the Avid Interplay Administrator To start the Avid Interplay Administrator: 1.
Using the Avid Interplay Administrator Window t Click the arrow for the Server list and select the server name from the list. The first part of the list shows recent servers, the second part of the list shows servers that were added manually (not on a local area network), and the third part shows servers available on your local area network. t Click the arrow for the server list and select Add Server. Type a new server name. 3. Type a user name with administration rights.
1 Getting Started with the Avid Interplay Administrator Each group contains views for managing components of the Avid Interplay Engine.
Opening an Interplay Administrator View Opening an Interplay Administrator View To open an Interplay Administrator view: t In the Interplay Administrator window, click an icon. The view you select replaces the Interplay Administrator window. Each view includes a path that shows the relative location of that view. The following illustration shows part of the Create Database view.
1 Getting Started with the Avid Interplay Administrator Exiting the Avid Interplay Administrator When you are finished using the Avid Interplay Administrator, you should log out or close the application. To log out: t Click the Log out button in the upper right of the Interplay Administrator window. The window remains open. To close the Interplay Administrator, do one of the following: t Select File > Exit. t Click the close button in the upper right of the window.
2 Database Settings The Database Settings allow you to create, configure, and manage the Interplay database.
2 Database Settings Avid recommends that you divide an Interplay database so that the metadata database remains on the Interplay Engine server (the only supported setup) and the file repository resides on an Avid Unity shared storage workspace. The most efficient approach is to specify how to divide the database before you create it. You specify the locations in the Server Settings view (see “Changing the Database and Data Locations” on page 55) and then create the database in the Create Database view.
Avid Interplay Database Directories and Files 2. In the New Database Information section, leave the default “AvidWG” in the Database Name text box. For an archive database, leave the default “AvidAM.” These are the only two supported database names. 3. Type a description for the database in the Description text box, such as “Main Production Server.” 4. Select “Create default Avid Interplay structure.
2 Database Settings Database Directories and Files Directory or File Directory or File Description _Database The main database directory, which contains database files and the database journal. These files contain the database structure and all metadata. All files within this folder contain binary information and cannot be viewed or edited with a text editor.
Scheduling and Restoring Database Backups Database Directories and Files (Continued) Directory or File Directory or File Description Folderlocations.xml A file that informs the server about the location of the _Database directory. If you set a new location for the file assets, you might need to edit this file. See “Splitting a Database for Existing Interplay Installations” on page 138. _Buckets Not currently used.
2 Database Settings For recommendations on developing a backup strategy, see “Recommendations for Automatic Backup Configuration” on page 34. To schedule database backups: 1. In the Database section of the Interplay Administrator window, click the Schedule Backups icon. The Schedule Backups view opens.
Scheduling and Restoring Database Backups 2. In the list on the left side of the view, select the database for which you want to view or specify automatic backup settings. The current settings are displayed. 3. (Option) In the Backup Information section, change your preferences if necessary. “Backup only if modified” is selected by default to save space and avoid duplicate identical copies. The default number of versions to keep is 10.
2 Database Settings 10. (Option) Change the Backup time by selecting one of the following: t Select Once at and change the hour and minutes (within 10 minute intervals) on which it occurs using the up and down arrows. t Select Every and set the backup to occur at regular intervals starting at midnight. Use the down arrow to select the interval. t Select Custom and specify custom backup times. Use the up and down arrows to select the time, and then select Add.
Scheduling and Restoring Database Backups Recommended Backup Configuration Avid recommends the following backup configuration: • Enable a daily Avid Interplay database backup, as described in “Scheduling Database Backups” on page 31. The backup should be set to run once daily at night, when the server is not being used or usage is lowest. • Decide whether to schedule the daily backup as a Complete backup or Fast backup.
2 Database Settings To restore a backup, you need to run the InterplayRestore tool in a Command Prompt window. The InterplayRestore tool is installed in the C:\Program Files\Avid\Avid Interplay Engine\Server directory and includes in-line help for using the tool. For an example of how the tool works, see “Database Restore Session Example” on page 38. You can restore either a Complete backup or a Fast backup. The InterplayRestore tool identifies the type of backup for you to select.
Scheduling and Restoring Database Backups 3. Type: InterplayRestore and press Enter. 4. InterplayRestore prompts you for the database root directory. Type the path and press Enter. You can use a local path or a UNC path. For example: D:\Workgroup_Databases\AvidWG \\IEServer\WG_Database$\AvidWG You can use the administrative share name WG_Database$ only in a UNC path. 5. At the next prompt, type the backup home directory and press Enter. For example: D:\Workgroup_Databases\AvidWG\_Backup If you are worki
2 Database Settings InterplayRestore prompts you to choose from a numbered list of available backups and then performs the restore. t Navigate to the folder that holds InterplayRestore, type the following, and press Enter: InterplayRestore For example: InterplayRestore d:\Workgroup_Databases\AvidWG\ d:\Workgroup_Databases\AvidWG\_Backup d:\Workgroup_Databases\AvidWG\_Backup\AvidWG_2007-08-20_01-00 InterplayRestore performs the restore
Scheduling and Restoring Database Backups Assume you choose 1. The tool locks the project so that no one can access the database and then copies the files: Beginning restore from d:\Workgroup_Databases\avidwg\_Backup\AvidWG_2006-09-12_03-05\ This is a Full backup Restoring to d:\Workgroup_Databases\avidwg\ Locked project AvidWG Copying files into d:\Workgroup_Databases\avidwg\_Database Copying file AvidWG.dor ...
2 Database Settings - C:\WINDOWS\system32\nxn_workgroup_eem.dll - C:\WINDOWS\system32\nxn_workgroup_library_129.dll Alternatively, you can keep all three files in the same folder. To remotely restore an earlier version of a database from a backup: 1. Open Interplay Administrator, log in to the Interplay Engine whose database you want to restore, and lock the database. For more information, see “Locking and Unlocking Databases” on page 42.
Performing a Consistency Check To back up the Interplay users database 1. Lock the server in the Lock Server view. For more information, see “Locking and Unlocking the Server” on page 58. 2. Copy the _InternalData folder to a backup location, such as a shared storage workspace. 3. Unlock the server. To restore the Interplay users database: 1. Lock the server. 2. Copy the _InternalData folder from the backup location to the installed location \\IEServer\WG_Database$ (usually D:\Workgroup_Databases).
2 Database Settings 2. Select the database name from the list. A summary of information about the database appears: - Name and description: Either AvidWG (Interplay Engine) or AvidAM (Interplay Archive Engine) with a description supplied when the database was first created. - Root folder for database (Meta Data): see “Creating an Interplay Database” on page 27. - Root folder for data (Assets): see “Creating an Interplay Database” on page 27.
Locking and Unlocking Databases To lock a database: 1. In the Database section of the Interplay Administrator window, click the Lock/Unlock Database icon. The Lock/Unlock database view opens. 2. Select the database in the Unlocked Databases list. 3. (Option) Type a Lock comment explaining why you are locking the database. This information appears in the Locked Database Information section for the database. 4. Click Lock Database.
2 Database Settings Managing Databases: Deactivating, Activating, and Migrating Use the Managing Databases view to remove a database from the list of active databases (deactivate) or to restore it to the list (activate). This view also lets you migrate a database to a new Central Configuration Server (CCS) when necessary.
Managing Databases: Deactivating, Activating, and Migrating 2. Select the database name in the Databases list. 3. Click Deactivate. The database name is removed from the Databases list. Activating a Deactivated Database If a specific database is not listed in the Databases view, it means that it is unknown to the Interplay Engine and users cannot connect to it. To add an existing but inactive database to the list of active databases: 1.
2 Database Settings t Click the Browse button, log in if prompted, navigate to the .pro file, select the file, and click Open. The following illustration shows the path to AvidWG.pro, using the Microsoft Windows smb network and the administrative share. n Avid recommends keeping the default share name WG_Database$. If you decide on a different share name, consider that if the name is longer than 12 characters, you cannot browse to it graphically.
Managing Databases: Deactivating, Activating, and Migrating The .pro file is displayed in the Activate Database dialog box.
2 Database Settings 3. Make sure the option “Load Database on Activation” is selected. Deselect this option only if directed by Avid support. 4. Click Activate. The database is activated and loaded. The database name is displayed in the Databases list and users can connect to the database. Migrating a Database You usually need to perform a database migration under the following circumstances: • When you want to remove all users and group-related data from a database.
Managing Databases: Deactivating, Activating, and Migrating To migrate a database to a new CCS: 1. In the Database section of the Interplay Administrator window, click the Manage Databases icon. The Manage Databases view opens. 2. In the Manage Databases view, click the name of the database that needs migration. The State reads “Database Requires Migration.” A warning explains the consequences of a database migration. 3. Click Migrate Database. After the migration, the State reads “OK.
2 Database Settings Moving a Database to Another Server Under special circumstances, you might need to move a database to a different server. n c Avid recommends that you have telephone support from Avid during the process in case complications arise.
Moving a Database and Users to Another Server 9. On the target server, make sure no clients attempt to connect to the server. 10. Copy the zipped file to the target server and unzip the file to the database folder. Make sure the path on the target server matches the path on the source server. 11. Activate the database by using the Manage Databases view (see “Activating a Deactivated Database” on page 45). 12. On a client system, connect to the database, load AvidWG, and verify that all data is available.
2 Database Settings Make sure the number of connected clients is 0 in the Server Information view. 5. Make sure the database is unloaded from the server by opening the Interplay Administrator, opening the Restart Server view, and clicking Restart. 6. Locate the database folder on the source server. The default path is D:\WG_Database$\AvidWG (or AvidAM for an Archive Manager). By default, the administrative share WG_Database$ refers to D:\Workgroup_Databases.
Moving a Database Under Low Disk Space Conditions 19. (Option) On the source server, rename the original database folder to avoid unwanted future access. Moving a Database Under Low Disk Space Conditions If disk space on the server is critically low, the Interplay Engine refuses client connections and displays an error message.
2 Database Settings Renaming a Database Under some circumstances you might need to rename a database For example, if you need to create a new database with the same name, you can rename the original database. You can keep the original database as an archive for searching. c Before beginning this procedure, be sure to make a backup of the database. See “Scheduling and Restoring Database Backups” on page 31 for information on running a backup.
3 Server Settings The Server Settings enable you to configure and change server settings and shutdown and restart the server. The following topics describe how to use these settings: • Changing the Database and Data Locations • Viewing Server Information • Locking and Unlocking the Server • Restarting the Server • Managing Licenses Changing the Database and Data Locations The Server Settings view lets you change the default locations for a new database.
3 Server Settings To change the root folders for a new database: 1. In the Server section of the Interplay Administrator window, click the Server Settings icon. The Server Settings view opens. 2. For the root folder of the database (metadata), keep the folder that was set during the installation of the server (the default is \\IEServer\WG_Database$\). 3.
Viewing Server Information Viewing Server Information The Server Information view has two sections: • • • The Server Information section displays information about the following: - The version of the Avid Interplay Engine software - The number of connected clients (through Interplay Access and other client applications) - The number of databases on the server The Connected User Information section displays information about the following: - Which database users are connected to - Which user is
3 Server Settings Locking and Unlocking the Server The Lock Server view allows the administrator to lock the Interplay Engine server for a specific period of time by shutting down the server process. Locking the server is useful when carrying out tasks such as: • Server maintenance or upgrading the server software. • Maintaining or rebooting the Avid Unity server (File Manager or System Director). Whenever a database or data location is unavailable, you should lock the database or the server.
Restarting the Server 2. Select one of the following for the locking duration: - Indefinitely: An indefinite shutdown. This is a good choice when shutting down the server to carry out any vital maintenance, for example replacing hard drives, or making the first backup of a new database. The server needs to be manually unlocked after maintenance work. - Minutes: Allows you to stipulate when to restart the server (short time frame).
3 Server Settings To restart the server process: 1. In the Server section of the Interplay Administrator window, click the Restart Server icon. The Restart Server view opens. 2. Click Restart. Managing Licenses Avid Interplay needs a valid license in order to function. A license consists of a hardware ID and a license key. The hardware ID is associated with the physical application key, or dongle.
Managing Licenses - Hardware ID, obtained from the physical application key (dongle). The Hardware ID is required to obtain technical support. - License mode: All Interplay licenses are nodelocked. - Lock timeout: The lock timeout is the time the server freezes a license on the server before it is freed for use by another user or machine. All Interplay licenses use a setting of 0 hours, 0 minutes, and 0 seconds.
3 Server Settings License Key Info Tool You can use the LicenseKeyInfo.exe tool to display and print out the license information for an Interplay Engine or Interplay Archive Engine. To examine the license key information for an Interplay Engine: 1. Navigate to the following folder: C:\Program Files\Avid\Avid Interplay Engine\Server 2. Double-click LicenseKeyInfo.exe The Interplay License Info dialog box opens. 3. Click Get License Info. 4. Select the License file and click OK.
Managing Licenses License Types and Usage The following table describes the license types displayed in the Licenses view. Each license type is associated with a particular license key.
3 Server Settings To export your license to a file: 1. Click the Export license button in the Licenses view. 2. Type or browse to a .nxn file name. 3. Select Save. Troubleshooting Licensing Problems If you previously attached one application key (dongle) and loaded the registration file for that dongle, and then attach a different dongle and try to load a new registration file, the registration file will not load. You need to delete the Windows registry key for the dongle.
4 User Management An administrator controls access to Avid Interplay through user accounts and user roles.
4 User Management • Several Interplay Engines: Normally, configure only one Interplay Engine as the CCS. The use of more than one CCS in a company might be useful if there are several independent domains, departments, or sites where there is no need to share users or other settings in Avid Interplay. In the case where several sites are located in different locations, having one CCS for each site could be practical.
Understanding the Central Configuration Server To move a CCS to another server: 1. Back up the database. See “Scheduling and Restoring Database Backups” on page 31. 2. Make sure that the Interplay Engine on both servers is the same version. See “Viewing Server Information” on page 57. 3. Start Interplay Administrator and log in to server A (which is the current CCS). 4. Lock server A. See “Locking and Unlocking the Server” on page 58. 5. In Interplay Administrator, log out of server A. 6.
4 User Management To change the CCS for a server: 1. Back up the database. See “Scheduling and Restoring Database Backups” on page 31. 2. Make sure that server A and server B are the same version, otherwise the CCS will not be reset. See “Viewing Server Information” on page 57. 3. Start the Interplay Administrator on server A, and log in to Server A. 4. In the User Management section, click the Central Configuration Server icon. The Central Configuration Server view opens. 5.
Adding Users to a Central Configuration Server 6. Do one of the following: t To keep the original CCS, click Cancel. t To change to a new CCS, click Change CCS. 7. If you have not moved the original CCS server (see “Moving the CCS to Another Server” on page 66) you need to migrate the database to the new CCS and all of your CCS-related data (such as users and local administration) will be lost. Unmigrated databases should not be used; databases should always be migrated to a CCS.
4 User Management • Individually creating users. You need to use the User Management view to create individual users. They log in using the username and password that you set. For more information, see “Adding Users and User Groups Manually” on page 78. Setting User Authentication Providers and Importing Users The User Authentication Providers view lets you set the type of authentication users need to provide when logging in to Avid Interplay.
Setting User Authentication Providers and Importing Users n All special characters are allowed in user names except for “\”, “/”, “|” and quotes (" and '). When LDAP and Windows Domain users are imported, these characters are replaced with “_”. If two users have different user names that are mapped to the same converted name (for example, dann/o and dann\o become dann_o), only one converted user name will be imported.
4 User Management These types of user authentication and how users are imported are described in the following topics. Setting Avid Unity Authentication If you select the Unity Authentication option, a user can log in to the Avid Interplay database using a valid Avid Unity password. The authentication mechanism always checks this User Authentication Provider first. This method of authorization is implicit.
Setting User Authentication Providers and Importing Users To enable Avid Unity authentication: 1. In the User Management section of the Avid Interplay Administrator, click the User Authentication Providers icon. The User Authentication Providers view opens. 2. Click Avid Unity Authentication. 3. Type the Avid Unity server name with which the CCS should cross-check for authentication. In an Avid Unity MediaNetwork environment, type the File Manager name.
4 User Management To enable Windows domain authentication: 1. In the User Management section of the Avid Interplay Administrator, click the User Authentication Providers icon. The User Authentication Providers view opens. 2. Select the Windows Domain Authentication option. 3. Click Import Windows Domain Users. 4. The Import User Groups dialog box opens. Do one of the following: t Select the user groups you want to import into the Avid Interplay system.
Setting User Authentication Providers and Importing Users Setting LDAP Authentication and Importing Users If you select the LDAP Authentication option, a user can log in to Avid Interplay databases with an LDAP user name and password. n If you want to run the Avid Interplay Engine within your domain and also want to automatically make use of domain user management, such as Windows Domain or LDAP, you need to specify a domain user as the Server Execution User. To enable LDAP authentication: 1.
4 User Management LDAP Server Configuration Settings The following table describes the LDAP server settings. Depending on your local LDAP, some of the settings might be necessary and some might not. Setting Description LDAP Server IP address of the LDAP Server. LDAP Port Port of LDAP Service (leave empty for Standard Port). User DN for Searches User DN for User to use for searches. Password for Searches User Password for User to use for searches.
Managing Users, User Groups, and User Rights Understanding Default User Groups, Users, and Roles The User Management view displays all user groups and users. The user groups created during the server installation are as follows: • Administrators, with the user Administrator: Users with administrator rights. When you first log in after the first installation, if you have not yet imported Windows Domain or LDAP server users, the only user displayed is the user “Administrator” with administrator rights.
4 User Management • Everyone: All users. This group contains the master user for every user in all the other groups. The master user in the Everyone group is the original user object. Instances of a user in other groups are linked to the master user. By default, the group role is set to No Access. The following illustration shows the master user for Administrator in the Everyone group and a link to the master user in the Administrators group. The icon for the linked user includes a link symbol.
Managing Users, User Groups, and User Rights 4. Add attributes for the new user or group. - For a user, add a name, description (inherited from the user group by default), password, password confirmation, and email. - For a user group, add a name and a description. All special characters are allowed in user and group names except “\”, “/”, “|” and quotes (" and '). For more information, see “Viewing and Setting Attributes” on page 79. 5. (Option) Select a role for the new user or group.
4 User Management n The password should only include characters from the ASCII the character set. Multibyte passwords might cause login problems, and the administrator then has to reset the password. To set the internal password: 1. In the Users list, select a user. 2. Type the password and the confirmation in the text box. 3. Click Apply. The user can change his or her password anytime in the login dialog box.
Managing Users, User Groups, and User Rights You can assign rights for specific users on specific folders in the Manage Database Roles view (see “Managing Database Roles” on page 85). Viewing and Changing Roles By default, all users in a group inherit the role assigned to the group. You cannot assign rights to specific users in the User Management view. If you want to change a user’s rights, you can move the user to a different group.
4 User Management To navigate to the Users tree from the Part of Group(s) pane: 1. Select the user group in the Part of Group(s) pane. 2. For any user group other than the Users group, right-click and select one of the following: t Select “Go To” to switch the focus of the Users tree to the group you selected. t Select “Go to user in this group” to switch the focus of the Users tree to the selected user in the selected user group. The Part of Group(s) dialog box focus does not update.
Managing Users, User Groups, and User Rights To change the role for a user, do one of the following: t Right-click the user and select Cut, select the group, right-click the group and select Paste. This action moves the user from one group to another. You can also drag the user from one group to another. t Right-click the user and select Copy, select the group, right-click the group and select Paste. This action removes the user from one group and adds it to another.
4 User Management To change or add an authentication provider: 1. In the Users list of the User Management view, select the user. 2. In the Authentication Providers pane of the User Management view, select the appropriate options. 3. Click Apply to make the change, or Revert to discard your changes. Deleting Users and User Groups You can delete any user except Administrator and you can delete any user group except Administrators, Migrated Users, and Everyone.
Managing Database Roles To remove a user from a user group: 1. Select the user in the group from which you want it removed. 2. Do one of the following: t Press the Delete key. t Click the Remove User button. Managing Database Roles You set and manage global roles for users in the User Management view (see “Managing Users, User Groups, and User Rights” on page 76). You have the option of limiting or granting rights for specific users on specific folders.
4 User Management 2. Select the General Role Assignment option.
Managing Database Roles 3. In the Database pane, select the database or a folder for which you want to view roles. If the database icon has a red X, you are not connected. Click the database icon to connect. The database icon shows a green check mark when you are connected. The following table describes three different states of the database icon. Icon Meaning (Green circle with check mark) Database you are connected to. (Red box with X) Database you are not connected to.
4 User Management Setting or Changing a General Role Assignment Use the Manage Database Roles view to set or change rights to a particular folder. Note the following: 88 • To delete items, the user must have deletion rights for the folder, even if the user is the owner of the item to be deleted. • To move items, the user must have write rights on the object, the folder the object is being moved out of, and the target folder.
Managing Database Roles Access role for Orphan Clips. Administrators have full access to all folders. For more information about the Unchecked-in Avid Assets folder and the Orphan Clips folder, see the Avid Interplay Access User’s Guide. To set or change a role for users of the database or a folder: 1. In the User Management section of the Avid Interplay Administrator window, click the Manage Database Roles icon. The Manage Database Roles view opens. 2. Select the General Role Assignment option. 3.
4 User Management 6. Click Set Role. The role appears in the lower panel. To change a role: t Select the entry in the lower pane, right-click, and select Set Role > role name. To remove a role for users of the database or a folder: 1. Select the database or a folder in the Database column. 2. Select an entry in the list in the lower pane.
Managing Database Roles 3. Do one of the following: t Click the Remove Role button. t Right-click and select Remove Role. The role for the users on that item is inherited from the parent user group again. Blocking Access by a Group or User When you are trying to block access by a whole group, it is not sufficient to change the user rights for the user group to NoAccess; individual users who have rights assigned to them specifically or through memberships in other user groups could still log in.
4 User Management 3. Click the Apply button for the option “Mark as Special Access Folder: Grant path access and allow to view path.” This option allows users to log in to the database and navigate to the specified location. The tree structure above the folder will be visible, but not the contents of the other folders in the structure. The first option makes the contents of the tree structure accessible as well (not recommended).
Managing Database Roles 4. The bottom panel displays the users who have special access according to your selections. The following illustration shows that the user jeditor has special access to the folder /Outside Productions/Graphics. To view what specific role jeditor has, select the folder in the Database pane. Special Access Folder User who can access Special Access Folders To remove a role assigned for Special Access folders: 1. Click the Special Access Folders option. 2.
4 User Management Guidelines for User Management This section provides information and suggestions that can help you manage users and access. For more information about managing user roles, with specific examples, see “Setting Up a User Database” in Avid Interplay Best Practices. • The fundamental rule of user management is that explicit rights override inherited rights, and database rights (set in the Database Management view) override CCS rights (set in the User Management view and stored in the CCS).
Guidelines for User Management 3. If there are no inherited permissions, the server checks the global user rights. In this case, the server determines what role the user has from the CCS settings. 4. In case of a conflict where the evaluation sees a user with multiple roles, for example: - the user has the read role through one group - the user has the read/write role through another group then the highest ranking role wins. In this case, the user gets the read/write role.
4 User Management 96
5 Site Settings Site settings include configuration options for various Interplay components.
5 Site Settings 2. Select the database for which you want to set properties. 3. From the Active Layout options, select one of the following layouts: - Broadcast - Post - Film This setting determines which set of properties is displayed in the client applications. 4. Select and deselect properties as follows: 98 t (Option) To include the property in the Content tab, select properties in the Content Default Column.
Creating Custom Properties t n (Option) To make the property available for users to add into Interplay Access displays on their own, and use these fields in an Extended Search, select properties in the Available column. If a property is not selected in the Available column, the property is not displayed in the Object Inspector or the Content tab, even if it is selected to be displayed in them. 5. (Option) Click Revert to reset properties to the defaults. 6. Click Apply to save the changes.
5 Site Settings 4. Click Custom Meta Data to open the custom options area. 5. In the Add Custom Meta Data text box, type a name for the custom property. 6. Click the green plus sign (+). 7. Select whether to include the property in the Content tab or the Object Inspector’s Properties tab, as needed. 8. (Option) To make a custom property available for users to add into Interplay Access displays on their own, and to use in an Extended Search, select the Available column.
Configuring Remote Workgroups For complete information on transferring Avid assets, see the Avid Interplay Transfer Setup and User’s Guide. n You can configure a maximum of 10 hostnames. For example, you can configure for searching five remote workgroups and five Nearchive servers for a total of 10. To set up access to a remote workgroup: 1. Make sure the Transfer Engines for both workgroups are correctly configured. See the Avid Interplay Transfer Setup and User’s Guide or the Help. 2.
5 Site Settings 5. In the New server pane, add information about the remote workgroup you want to access. a. Select the Host Type: Interplay Server/Remote Search—to add access to a remote Interplay workgroup TransferManager—to add access to a Workgroup 4 TransferManager MediaManager—to add access to a Workgroup 4 workgroup or Nearchive system Interplay Server / 3d Party Search—to add access for a third-party plug-in. The plug-in needs to be properly installed before you can configure it.
Configuring Categories By default, no categories are configured in the Interplay Administrator. c There is no option to rename a category. The database items identify the categories they belong to by the category name, so this name cannot be changed once it is used. Adding Categories To make categories available in Interplay Access: 1. In the Site Settings section of the Interplay Administrator window, click the Configure Categories icon. The Configure Categories view opens. 2.
5 Site Settings When performing a search, you can use a Category name to locate items that belong to that category. Removing Categories Removing a category only removes it from the Configured Categories list in the Interplay Administrator. Objects in the database that have this category keep it, even if it is not listed anymore.
Setting the Server Hostname and Workgroup Name Setting the Server Hostname and Workgroup Name The Server Hostname Settings view lets you register the Interplay Media Services Engine. You must register the Interplay Media Services Engine before you can run the Interplay Media Services view (see “Interplay Media Services View” on page 106) or use any Interplay Media Services. For more information, see the Avid Interplay Media Services Setup and User’s Guide.
5 Site Settings Interplay Media Services View The Interplay Media Services view is a tool for administering the Interplay Media Services Engine and monitoring job status. This view provides settings for the following tasks: n • Filtering jobs to monitor • Registering providers • Installing services • Setting up users • Setting up profiles These options are also available from the Admin Tool in the Avid Interplay Media Services application dialog box.
Interplay Transfer Settings View Interplay Transfer Settings View The Interplay Transfer Settings view lets an administrator configure the names and locations of the Interplay Transfer Engines in the workgroup. The settings determine which cache server monitors which Transfer Engines and Transfer Engine enabled devices. The Interplay Transfer Status view uses these settings to access the Transfer Engines in the workgroup.
5 Site Settings archive a duplicate version of the associated media. The Archive Provider archives all of the metadata associated with the new subclip or sequence but it does not archive duplicate versions of the media. Setting “Allow duplicate media file(s)” to “Yes” tells the Archive Provider to create multiple versions of the media files, if required To change whether archive operations create duplicate media: 1. Open the Interplay Administrator and log into the system running the Archive Engine. 2.
Specifying Archive Settings Specifying the Archive Server and Segment Size Before you use the Archive Engine, you need to specify settings on the Interplay Engine. The following illustration shows the Archive options for an online database. To specify the Archive Server and archive segment size: 1. Open the Interplay Administrator on the system running the Interplay Engine. 2. In the Site Settings section of the Interplay Administrator window, click the Archive Settings icon.
5 Site Settings 110
6 Editor Settings In the Editor Settings, you can configure editor-specific permissions and options, as described in the following topics: • Setting Editor Database Options • Setting Instinct/Assist User Options • Pro Tools Plug-Ins Settings Setting Editor Database Options The Editor Database Settings view lets you specify on a database or folder level the settings that are relevant when using an editing system. Most of the settings apply to Avid iNEWS Instinct or Avid Interplay Assist.
6 Editor Settings To change the editor database settings: 1. In the Editor Settings section of the Interplay Administrator window, click the Editor Database Settings icon. 2. Select a folder in the database. If the database icon has a red X, you are not connected. Click the database icon to connect. The database icon shows a green check mark when you are connected. For more information, see “Viewing General Role Assignments” on page 85.
Setting Editor Database Options 3. Do one of the following: t Select an option from the drop-down list. t Type a setting in the text box. If a setting is grayed out, click the Edit button to enable editing. Edit button For information about the options, see “Editor Database Settings” on page 113. 4. Click Apply. To undo a setting: t Click the red X button. This button appears only if you have explicitly set the value of the setting.
6 Editor Settings Editor Database Settings (Continued) Option Audio – Source audio patching Audio – Storyline audio patching Audio – general settings Setting Description Voice Over label (Avid Instinct only) Allows you to specify a name for the voice-over track in source clips. The default is Voice. Natural Sound track Maps the audio track for NAT sound in the source input. The default is A1. Sound on Tape track Maps the audio track for SOT sound in the source input. The default is A2.
Setting Editor Database Options Editor Database Settings (Continued) Option Setting Description Ducking [-dB] (Avid Instinct only) Allows you to specify the amount of audio ducking (automatic lowering of audio gain in background audio). The default is 12 dB. Audio file format Sets the audio file format to PCM. Not changeable. Dynamic Relink Enables or disables the Dynamic Relink feature (for MultiRez editing).
6 Editor Settings Editor Database Settings (Continued) Option Setting Description Audio Mixdown Mode Sets the mixdown mode used for send-to-playback operations: Audio Target Resolution • Mono — mixes all audio tracks to two channels of mono output, each channel containing the source audio tracks • Stereo — mixes all audio tracks to two channels of stereo output • Direct Out — maintains the audio tracks used in the source story or shotlist for audio output channels • The default mixdown mode is
Setting Instinct/Assist User Options Setting Instinct/Assist User Options In the Instinct/Assist User Settings view, you can set permissions for various editing functions on the user level. These settings apply to all folders in the database. Inherited settings are grayed out. The settings in the following illustration are for an Avid Interplay Assist user who has permission to use only the low res MPEG2 media created by the Avid Interplay Low Res Encoder.
6 Editor Settings The settings for the selected user or user group area are displayed in the pane on the right. 3. Do one of the following: t Select an option from the drop-down list. t Type a setting in the text box. If a setting is grayed out, click the Edit button to enable editing Edit button For information about the options, see “Instinct/Assist User Settings” on page 119. 4.
Pro Tools Plug-Ins Settings Instinct/Assist User Settings You can set options for the Instinct/Assist User Settings as described in the following table. Instinct/Assist User Settings Option Description Can send to playback Allows the user to send material to a playback device. Can modify column properties Allows the user to modify asset properties. Can create new column properties Allows the user to add new properties to assets.
6 Editor Settings Installing the Pro Tools Plug-Ins for Interplay Before you use the Avid editing application to check files into Interplay for Pro Tools, you must install Interplay Access and the Pro Tools Interplay Option on the Pro Tools system. The installation software adds the following plug-ins to the Interplay Administrator on the Pro Tools system.
Pro Tools Plug-Ins Settings To configure the Pro Tools Import settings: 1. In the Editor Settings section of the Interplay Administrator window, click the Pro Tools Import Settings icon. The Pro Tools Import Settings view opens. 2. Select the database or folder for which you want to configure import settings. If the database icon has a red X, you are not connected. Click the database icon to connect. The database icon shows a green check mark when you are connected.
6 Editor Settings 3. Select the values that Pro Tools should use to import the files and create a new session. For more information about these settings, see the Pro Tools documentation. 4. Click Apply. Configuring the Pro Tools Export Plug-In The settings that you configure in the Pro Tools Export plug-in are used by an Avid editing application when an editor performs an audio export. You can select export settings for the entire database or for particular folders.
Pro Tools Plug-Ins Settings 3. Select options as described in the following table. Category Option Description Video Details Transcode Video Resolution The Avid editing application uses this value to perform a video mixdown when you select the Video Mixdown option for a “Check In to Interplay for Pro Tools” operation. The application might also use the value when you perform a “link to existing media” export. For more information, see the Avid Interplay Best Practices.
6 Editor Settings Configuring the Pro Tools User Settings Plug-In This option is for future use.
7 Avid Interplay Services Avid Interplay Services contains the Workgroup Properties and Service Configuration views, which are identical to parts of the Avid Interplay Framework. For example, the following illustration shows the Service Configuration view examining the Avid Interplay Media Indexer settings for a computer in the Interplay workgroup. You can use the Service Configuration view to configure services such as the Interplay Media Indexers for all the clients in your workgroup from one computer.
7 Avid Interplay Services 126
8 Troubleshooting The following topics provide information for troubleshooting problems with the Avid Interplay Engine server: • Troubleshooting Log-In Problems • Troubleshooting Client Connection Problems • Optimizing Avid Interplay Performance • Troubleshooting Firewalls and Avid Interplay • Troubleshooting the Server Execution User Account • Shutting Down or Locking the Server Process Troubleshooting Log-In Problems If you are not able to log in to the Interplay Administrator even when you ar
8 Troubleshooting Troubleshooting Client Connection Problems This topic provides suggestions for settings to check if a client system is not connecting properly. Network Configuration • Check the TCP/IP connection by typing ping in the Command Prompt on the client. Server Settings • Check if there is a user account for the user. See “Managing Users, User Groups, and User Rights” on page 76. • Check if the password is expired. See “Viewing and Setting Attributes” on page 79.
Troubleshooting Firewalls and Avid Interplay • Check the speed of the LAN between the Avid Interplay Engine and the shared storage server. Make sure that the Avid Interplay Engine and the Avid Unity shared storage server are connected appropriately; for example, the Avid Interplay Engine needs to read the files to create thumbnails. If the connection is slow, performance can drop. • Check the speed of file operations of the Avid Interplay Engine on the shared storage server.
8 Troubleshooting For information about ports used by Avid Interplay, see “Required TCP/IP Ports” on page 149. Troubleshooting the Server Execution User Account The Server Execution User is a Windows operating system user account that is used only to run the Interplay Engine processes. You specify the user name and password for the Server Execution User when you install the Interplay Engine on the server.
Troubleshooting the Server Execution User Account If you want to run the Avid Interplay Engine within your domain and also want to automatically make use of domain user management, such as Windows Domain or LDAP, you must specify a domain user as the Server Execution User. c When you install the Interplay Engine or the Interplay Archive Engine, do not select the default Server Execution User. Create a custom user instead. The default user account is AVID_WORKGROUP_USER. Do not use this account.
8 Troubleshooting - Avid Interplay TCP/COM Bridge: The Avid Interplay TCP/COM Bridge Service runs under the specified account. You can verify that the new user has been set in the service control panel tool as described in “Required TCP/IP Ports” on page 149.
9 Recommendation for Database Storage An Interplay database includes a metadata database and a file repository (for file assets). Avid recommends that you split Interplay databases so that the metadata database remains on the Interplay Engine server and the file repository resides on an Avid Unity shared storage workspace.
9 Recommendation for Database Storage Relationship Between the File Repository and the Metadata Database The file repository contains folders that hold the file versions created through importing and checking in files, as well as other files such as preview images and head frames of clips. The metadata database contains the information needed to run the Interplay Engine and to access the files in the database, and stores metadata about the files.
Supported Configurations Supported Configurations The following table summarizes the recommended configuration setups for an Interplay Engine. Metadata Location File Repository Location Supported Comments Interplay Engine server Dedicated file server Yes (Avid Unity MediaNetwork or Avid Unity ISIS) Recommended. High reliability, high speed performance, maximum storage space. Interplay Engine server Interplay Engine server Yes High reliability, high speed performance, limited storage space.
9 Recommendation for Database Storage For example, you can create a workspace named \\UnityServer\File_Assets. For UnityServer, substitute the network name of your Avid Unity ISIS System Director or Avid Unity MediaNetwork File Manager. Make sure there is adequate space to hold the files that will be created. 2. Make sure that the Server Execution User has full access to the Avid Unity workspace. The Server Execution User is usually a domain user, such as \\MYDOMAIN\IPEngine.
Splitting a Database for New Interplay Installations 7. Click Apply Changes. 8. Click the Menu button. 9. In the Database section of the Interplay Administrator window, click the Create Database icon. The Create Database view opens. The root folders displayed should match those in the Server Settings view. 10. Accept the Database Name, type a description, and click Create. The new database is created.
9 Recommendation for Database Storage - You should find the database folder on the Interplay Engine, for example D:\Workgroup_Databases\AvidWG\_Database. - You should find the file repository on the Avid Unity workspace, for example \\AAC-ISIS\File_Assets\AvidWG. The AvidWG folder should contain _Master and other database folders and files. Splitting a Database for Existing Interplay Installations In some situations, you might need to split the database after you have created it.
Splitting a Database for Existing Interplay Installations c This folder name (AvidWG) must exactly match the name of the corresponding folder on the Interplay Engine server. 9. Copy everything except the _Database folder from \\IEServer\WG_Database$\AvidWG to the new location \\UnityServer\WorkspaceName\AvidWG. After copying the files, delete them from the original location, so that this location contains only the _Database folder.
9 Recommendation for Database Storage 11. Make sure the file includes the correct path for the _Database directory. It should include the line \\IEServer\WG_Database$\AvidWG\_Database For IEServer, substitute the network name for the Interplay Engine server. This path points to the metadata database on the Avid Interplay Engine. If the FolderLocations.xml file does not exist on the workspace, or it is empty, use a text editor or an XML editor to create the file in the folder AvidWG.
Splitting a Database for Existing Interplay Installations Configuring the workgroup.xml File When you move the file repository to a shared storage workspace, you must edit the workgroup.xml file to include a path for the file repository share. This file is located in the Interplay Engine installation directory, for example, C:\Program Files\Avid\Avid Interplay Engine\Data\Apache\Conf (non-cluster systems) S:\WorkgroupData\Apache\conf\workgroup.xml (cluster systems).
9 Recommendation for Database Storage For UnityServer, substitute the network name for the Avid Unity ISIS System Director or the Avid Unity MediaNetwork File Manager. For WorkspaceName, substitute the workspace you designated for the file repository. For example, \\AAC-ISIS\File_Assets. Identifying the Root Folder of the Interplay Server Database WG_Database$ is a hidden share name and not an actual folder. It represents the root folder of the database.
Restoring a Split Database 7. Activate the database \\IEServer\WG_Database$\AvidWG\AvidWG.pro (see “Activating a Deactivated Database” on page 45). 8. Unlock the database (see “Locking and Unlocking Databases” on page 42).
9 Recommendation for Database Storage 144
A Installed Components and Services The following topics provide information about components and services that are installed as part of the Interplay Administrator: • Avid Interplay Engine Directory: Folders and Files • Required TCP/IP Ports • Avid Interplay Engine Servers and Services Avid Interplay Engine Directory: Folders and Files The following components are installed in the Avid Interplay Engine directory. By default, this directory is created during installation as C:\Program Files\Avid\Avid
Apache Folder The Apache web server handles every incoming request and forwards them to the database server. The Apache folder includes important logs from the Apache process. File Path (C:\Program Files\Avid\Avid Interplay Engine) Description Apache\logs\error.log The central Apache web server log file that contains important messages from the Apache process, especially warnings and errors. Apache\logs\access.log The central Apache web server access log file.
Avid Interplay Engine Directory: Folders and Files The items in such a log entry are: • The IP address of the machine where the request was coming from; • The date and time when the request was received; • The request method (GET or POST), the request URI and any request parameters; • The HTTP status codes returned to the client. The returned status codes are the standard HTTP codes as described in RFC 2616 available under http://www.ietf.org/rfc/rfc2616.txt.
File Path (C:\Program Files\Avid\Avid Interplay Engine) Description Data\Apache\conf\httpd.conf The configuration file for the Apache web server. Data\Apache\conf\workgroup.xml This file contains settings for the Avid Interplay Apache modules. The settings in this file are used, for example, by the filetransfer and the preview server modules. The file transfer section contains items such as a list of UNC paths to which the Avid Interplay HTTP server can browse.
Required TCP/IP Ports Server Folder The Server folder contains the Avid Interplay Engine Server installation. File Path (C:\Program Files\Avid\Avid Interplay Engine) Description Server\Machines\[COMPUTER NAME]\MachineConfig.ini This file is generated by the Avid Interplay Engine Server. It contains information about the versions of the dll's loaded by the server. Server\Config\Config.
Two servers are installed on the Interplay Engine: • The Avid Interplay Engine Server is the central process where all assets and asset meta-information are managed. See “Avid Interplay Engine Server” on page 150. • The Avid Workgroup HTTP Server is a module for the Apache server that allows clients to connect to the Avid Interplay Engine Server using a HTTP protocol. See “Avid Workgroup HTTP Server” on page 151 Three services are installed on the Interplay Engine.
Avid Interplay Engine Servers and Services The Interplay Engine always runs under the user specified in the DCOMConfig Settings. DCOMCNFG is a Windows utility that allows you to configure various DCOM-specific settings in the registry. To access it, type dccomcnfg at the Command Prompt. c Do not change the settings using the DCOM configuration tool. Instead, use NxNServerUser.exe to change the user under which the Avid Interplay Engine Server and other servers and services run.
Requirements See “Avid Workgroup Preview Server Service” on page 152. Avid Workgroup Server Browser Service The Avid Workgroup Server Browser service is responsible for providing information about the Interplay Engine server to Avid Interplay clients and searching for the available servers and databases. The Avid Workgroup Server Browser listens to port 8313. Processes The process running is usually listed as NxNworkgroupServerBrowser.exe or NxNworkgroupSe.
Avid Interplay Engine Servers and Services The server is implemented as a module for Apache. Connectivity The Preview Server is accessed only from clients via HTTP. It uses the default port 80. n Make sure that no other application allocates port 80. For example, IIS might be installed as the default HTTP server. In this case, deactivate the corresponding application. Processes There are two processes of Apache.exe running.
Configuring the Preview Service The Preview Service is responsible for the generation of thumbnails and preview images on the server, as well as delivering them to the Interplay application. All settings can be edited in the workgroup.xml file (found in the Avid Interplay Engine installation directory, by default C:\Program Files\Avid\Avid Interplay Engine\Data\Apache\Conf) in the section. The settings should look similar to the following.
Avid Interplay Engine Servers and Services • IconRoot: Path to a directory where a set of icons is stored, usually pointing into the Avid Interplay Engine installation directory. The icons stored here are used by the Preview Server if, for example, a thumbnail generation failed or if an asset has an unknown format or is not an image/video file. • ServerEnableDiskGuard: If “yes”, the free space on disk is constantly checked and cache files are purged if necessary. If “no”, cache files are never deleted.
Avid Workgroup TCP/COM Bridge Service The Avid Workgroup TCP/COM Bridge service acts as bridge to the Avid Interplay Engine Server. The Avid Workgroup HTTP Server needs the Avid Interplay TCP/COM Bridge to connect to the Avid Interplay Engine Server. Connectivity The Avid Workgroup TCP/COM Bridge listens to port 8318. Processes The process running is usually NXNTCP~1.exe from NXNTCPCOMBridge.exe.
B Interplay Engine Configuration Files The following topics provide information for configuration that you might need to do only under certain circumstances, such as troubleshooting: • Configuring the Server Event Manager • Configuring Client Access • Setting the Filetransfer Server If you are moving the file repository to a shared-storage workspace, you need to edit the workgroup.xml file. See “Configuring the workgroup.xml File” on page 141.
The configuration file is an XML file that has the following format: Value of Parameter ... Value of Parameter ... Value of Parameter ... The block specifies to which events the Avid Interplay Engine should react.
Configuring the Server Event Manager The blocks are used to specify the behavior of an action. It is also possible to identify a parameter by its “Name” attribute. Parameters are identified by their “Name” attributes. Whenever the server performs an action, it searches the parameters from the inside out, which means it searches the parameter block inside the block first and then inside the block. This allows you to specify a parameter for all events.
The “RCPTList” parameter contains a comma separated list of valid email addresses. These addresses should receive an email whenever the server performs an action. The “SenderAddress” parameter contains the email address of the sender. The sender should act as the originator of the sent email. The “SMTPServer” parameter contains a valid IP address of the mail server to which the mail is to be sent. Supported Events in Config.
Configuring the Server Event Manager LogEvent Event The “LogEvent” event is triggered according to the settings in the LogWatch.xml, in which an administrator can specify what actions should happen if a severe problem inside of the Interplay Engine occurs (for example, send an email or shut down the server). The file allows a rough definition by severity of the problem or a very detailed configuration via the message ID of the problem.
Server Event Configuration Example The following is an example of the configuration of a server to send emails whenever the backup fails, or the free space on a server disk reaches one of the limits set, in this case 30, 100, or 500 MB: 30 100 500 SERVERMACHINE
Configuring the Server Event Manager 123.123.123.123 Here is an example of an email sent by the Event Manager: 11/23/1999 12:09:14 [WGServer] INFO: This is a message sent by the Event Manager. LogWatch.xml Log event notifications are configured in LogWatch.xml, located in the Avid Interplay Engine installation directory C:\Program Files\Avid\Avid Interplay Engine\Data\Server\Config. Edit this file to assign actions for different log events.
ID Severity 0 [ERROR] (normal errors, like “file couldn't be imported because it exists already”) 100 [FATAL] (Recoverable critical Errors, like “couldn't save database - disk full”) 200 Critical (non-recoverable errors, such as crashes) Sending Email Notifications To send email notification on any error with a specific severity level: t Add a mapping entry to LogWatch.xml within the scope.
Configuring Client Access The message ID is the last number in brackets before the actual message string in the log file. The message ID of the entry below is 0x00004678. Note that the log file displays hexadecimal ids. Note: You need to convert the numbers to decimal format before adding to the message mapping. [Thu Sep 16 17:27:43 2004] [FATAL] [.\NxNDbServer.
The “name” attribute specifies the name of the database. This name must be the same as the name of the database configured in the Active Database List through the Avid Interplay Administrator. If a database is not in the Active Database List, it cannot be made visible by specifying its name in token either. You can also use the “*” as a wildcard character representing all databases in the Active Database List. The “access” attribute specifies the type of access for the database.
Configuring Client Access Example 2: PAGE 168Example 4: PAGE 169Setting the Filetransfer Server Setting the Filetransfer Server Additional configuration may be required when the Interplay Server is running inside of a network configured using NAT. In this case, the IP returned by the Avid Interplay Engine is the internal address and not the external address needed by the client. The following change in the workgroup.xml configuration file tells the client to connect to the file transfer server via its name instead of address.
C Valid and Invalid Characters in Avid Interplay The following table lists the valid and invalid characters for Avid Interplay. Allowed Avid assets Not Allowed characters: \ / | Video ID metadata field: spaces or characters \ / : * ? " < > File assets All characters allowed characters: \ / : * ? " < > | for files in Windows names ending with a dot names used as DOS devices (LPT1, com1, .., .,, for example) Property names (metadata field names) characters: \ / | Users and user groups characters: \ /
D System Metadata Properties Metadata is textual data you can use to identify and describe the creation, contents, and disposition of the clip or shotlist you are logging. Avid Interplay comes with an extensive list of system metadata. Most of these properties match those available in Avid editing bins. The administrator determines some of the metadata properties that can be viewed in Interplay Access as headings in the Content View and Object Inspector, and also used in Interplay searches.
The following table lists all system metadata properties. System Metadata Properties Search Values and Hints on Searching in Interplay Heading Description All Custom All custom properties defined in the Property Layout of the Interplay Administrator. AudioBitDepth Audio bit depth used when you work with Type a value or use the arrows to select a audio files: 16 bit or 24 bit. value. AudioFormat Audio format of master clips (AIFF-C, SDII, or WAVE). AudioSR Audio resolution (sample rate).
System Metadata Properties (Continued) Search Values and Hints on Searching in Interplay Heading Description Camera Camera used to film this clip. This feature is used in multicamera shoots. Camroll Camera roll containing this clip. Used for 24p projects, 25p projects, and matchback projects only. Category Assigned category.
System Metadata Properties (Continued) Search Values and Hints on Searching in Interplay Heading Description DPX Frame-counting field for Digital Picture Exchange, a SMPTE standard describing frames scanned from film. The format is the following: a descriptor of up to 32 alphanumeric characters, followed by a hyphen (-), followed by a six-digit frame count, for example, DPXChildDocu-023657. DRM Digital Rights Management property.
System Metadata Properties (Continued) Search Values and Hints on Searching in Interplay Heading Description In Use If Is in use, asset is referenced by a sequence also in the database. Select Is in use or Is not in use. IN-OUT The length of the marked segment of a clip, if any. Select an operator and then type numbers only in the four colon-separated entry fields displayed. Initial Checkin Date Date that the asset was first checked in.
System Metadata Properties (Continued) Search Values and Hints on Searching in Interplay Heading Description KNMarkIN Key number for the IN point, if you set one for the clip. Used for 24p projects, 25p projects, and matchback projects only. KNMarkOUT Key number for the OUT point, if you set Select an operator and then type numbers one for the clip. Used for 24p projects, only in the four colon-separated entry 25p projects, and matchback projects fields displayed. only.
System Metadata Properties (Continued) Heading Description Search Values and Hints on Searching in Interplay Master Start Starting key number of the final master sequence. Used for 24p projects, 25p projects, and matchback projects only. Select an operator and then type numbers only in the four colon-separated entry fields displayed. Media File Format Clip media format. MXF or OMF. Media Size Media file size. Specify KB, MB, GB and type a number.
System Metadata Properties (Continued) Heading Description Path Path to assets in the Interplay database. Search Values and Hints on Searching in Interplay Meant to be used in conjuction with other search conditions to narrow the area where the results are coming from: for example, combine a search for all masterclips that have been updated in the last 10 minutes and that are in path "/Projects/MyName/MyBin2.” Select is or is not, then click the Select button and choose a path from the tree.
System Metadata Properties (Continued) Heading Description Search Values and Hints on Searching in Interplay Scene Scene number of the clip. Type text. ShootDate Date the footage was shot. Slip Number and direction of perfs for subclips (audio clips only). SoundTC Timecode for audio. Soundroll Sound roll this clip came from. Used for 24p projects, 25p projects, and matchback projects only. Start Timecode of the clip’s head frame.
System Metadata Properties (Continued) Heading Description TC60 60-fps timecode. Used for HD projects. Text Search Values and Hints on Searching in Interplay Select an operator and then type numbers only in the four colon-separated entry fields displayed. Combination of Name, Tape, User Attributes, Comments, and Annotations attributes. Allows you to search for text in all attributes at once. Type text (not case sensitive; spaces permitted).
System Metadata Properties (Continued) Heading Description Video ID Resolution under which the media for that clip was captured. VITC Vertical interval timecode. Workspace Name of an Avid Unity workspace Search Values and Hints on Searching in Interplay Type the name of the workspace.
AVID CONFIDENTIAL DRAFT VERSION 9/18/07
E Server Error Codes The following table lists the error codes and the textual expressions that the Interplay Engine can return.
89990035 invalid parameter 89990036 invalid filename 89990037 invalid object 89990038 invalid hostname 89990039 invalid macro string or tool installation file 89990040 object not found 89990041 parent not found 89990042 the template for the object could not be found 89990043 titerator is invalid for this iteration-capable command 89990050 property not found 89990051 property not set 89990052 cannot set property 89990053 cannot modify the property 89990054 the property is read
89990082 cannot read from file 89990083 the file does not exist 89990084 file system operation failed 89990085 access to file denied 89990086 sharing violation 89990087 corrupt file 89990090 cannot set mount point 89990091 object not mounted into file system 89990092 cannot create directory 89990093 cannot move directory or file 89990094 cannot copy file 89990095 cannot delete directory or file 89990096 cannot create a link to a link 89990097 folder does not exist 8999009b canno
89990123 cannot disconnect from server 89990124 The database share on the server is not accessible. Please contact your administrator.
89990165 the server could not be instantiated (is the server installed on this machine?) 89990166 the server is locked by the Administrator 89990167 the server is low on virtual memory 89990168 the server is low on disk space 89990169 the server is out of disk space 89990170 the specified search expression is invalid 89990171 the database is locked by the Administrator 89990172 a temporary key cannot be installed if a permanent key is already active 89990173 the server with the CCS is locke
89990224 cookie file does not exist 89990225 can not create cookie file 89990226 can not read cookie file 89990227 cookie file is corrupt 89990228 found cookie does not match wanted cookie 89990230 object must support INxNPersistDatabase 89990231 object must support INxNPersistDatabaseObj 89990232 object must support INxNVersionControlProperty 89990233 object must support INxNHandleStore 89990234 object must support INxNHandleStoreObj 89990235 unknown command passed to RunCommand
89990292 Disabling version creation for abstract assets is not supported 89990300 the user 'UserManagement' is not allowed 89990301 user rights do not allow this operation 89990302 user/user group exists already 89990303 command exists already 89990304 user does not exist 89990305 user is invalid 89990306 user rights do not allow this operation in system folder 89990307 user rights do not allow this operation in level 89990308 user rights do not allow this operation (no ownership) 899903
89990326 The operation is not permitted on the user administrator 89990327 The initialization of the authorization subsystem failed - read message for more information 89990340 The initialization of the user management subsystem failed - read message for more information 89990341 A generic command was called which is not supported for user or group objects 89990342 Internal requirements for user or groups objects are not fulfilled (for example, link broken,.
8999036e The CCS does not have the same version as the server of the database 89990370 An LDAP search enum failed 89990371 Structural changes are not allowed on that object 89990372 No Children can be added to this folder or moved out of this folder 89990401 no handler was found 89990450 There is no open session for this client.
89990624 not found 89990625 method not allowed 89990626 not acceptable 89990627 proxy authentication required 89990628 request timeout 89990629 conflict 8999062a gone 8999062b length required 8999062c precondition failed 8999062d request entity too large 8999062e request URI too long 8999062f unsupported media type 89990630 internal server error 89990631 not implemented 89990632 bad gateway 89990633 service unavailable 89990634 gateway timeout 89990635 HTTP version no
89990709 database journal file error 89990800 SQL error 89990801 SQL error, more info available 89990802 invalid SQL configuration 89990900 the sender of the message does not exist 89990901 the recipient of the message does not exist 89990902 The sender must be a user.
89990b01 The LDAP server received an invalid request from the server, LDAP error: LDAP_PROTOCOL_ERROR(0x2) 89990b02 A specified time limit was exceeded in a request to the LDAP server, LDAP error: LDAP_TIMELIMIT_EXCEEDED(0x3) 89990b03 A specified size limit was exceeded in a request to the LDAP server, LDAP error: LDAP_SIZELIMIT_EXCEEDED(0x4) 89990b04 The LDAP server does not support the authentication method specified by the server, LDAP error: LDAP_AUTH_METHOD_NOT_SUPPORTED(0x7) 89990b05 The
89990b10 The credentials sent to the LDAP server are invalid, LDAP error: LDAP_INVALID_CREDENTIALS(0x31) 89990b11 The request sent to the LDAP server was not completed because of missing access rights, LDAP error: LDAP_INSUFFICIENT_ACCESS(0x32) 89990b12 The LDAP server is too busy at the moment to fulfill the request, LDAP v: LDAP_BUSY(0x33) 89990b13 The LDAP server is currently unavailable, LDAP v: LDAP_UNAVAILABLE(0x34) 89990b14 The LDAP server cannot process the request due to server-defined res
89990b22 The LDAP server could not be contacted, LDAP error: LDAP_SERVER_DOWN(0x51) 89990b23 The LDAP client detected an error, LDAP error: LDAP_LOCAL_ERROR(0x52) 89990b24 The LDAP protocol detected an encoding error, LDAP error: LDAP_ENCODING_ERROR(0x53) 89990b25 The LDAP protocol detected an decoding error, LDAP error: LDAP_DECODING_ERROR(0x54) 89990b26 An LDAP search was aborted because of a timeout, LDAP error: LDAP_TIMEOUT(0x55) 89990b27 The LDAP server encountered an unknown authentica
89990b52 The CCS was unable to retrieve the users from a user authentication provider 89990b53 The specified user authentication provider was not found 89990b54 The required setting for the LDAP server is not set 89990b55 The required setting for the LDAP user object class is not set 89990b56 The required setting for the LDAP user name attribute is not set 89990b57 The specified search root DN was not found 89990b70 The Unity API could not be found 199
F Consistency Check Codes The following tables explain the codes reported when you run a Consistency Check: c • Consistency Check Critical Errors • Consistency Check Errors • Consistency Check Warnings The Consistency Check is for support purposes. You should perform this check only if requested by Avid Technical Support.
Code Meaning 7142 repository data corruption 7143 repository data corruption 7144 repository data corruption 11064 user management failed to initialize Consistency Check Errors n 202 If any of the following errors are reported, some problems were found related to the particular object. It is still possible to use your database, but you should contact Avid using the protocol outlined in the “If You Need Help” section in the front of this manual to resolve the problem.
Consistency Check Errors Code Meaning 7070 object history is not accurate 7071 object history is not accurate 7111 unknown property handle 7112 streamed property flag is not set 7113 unknown streamed property name 7114 invalid streamed property 7171 link is invalid 7172 link is invalid 7173 link is invalid 7174 link is invalid 7175 link is invalid 7176 link is invalid 11058 master user is not valid 11059 master user is not valid 11060 master user does not exist 11061 master
Consistency Check Warnings If any of the following warnings are reported, some problems were found, but no action is urgently needed. 204 Code Meaning 7062 file size mismatch 7072 invalid dependency source 7073 invalid dependency source 7074 invalid dependency target 7075 invalid dependency target 7076 incorrect dependency type 7091 pending change problem fixed 23022 invalid entry in the authorization role table.
ABCDEFGHIJKLMNOPQRSTUVWXYZ Index Symbols _Backup directory described 29 _Buckets directory described 29 _Database directory backing up and restoring 31 described 29 _Master directory described 29 _PropertyStore directory backing up and restoring 31 described 29 A Accumulated inherited role described 80 Activating database 45 Administrator role described 80 Administrators group 77 Apache web server activating creation of access.
Index ABCDEFGHIJKLMNOPQRSTUVWXYZ Avid Unity account for Server Execution User 130 file repository on workspace 133 Avid Unity authentication 72 Avid Unity ISIS workspace for file repository 135 Avid Unity MediaManager migrating users from 77 Avid Unity MediaNetwork workspace for file repository 135 Avid Workgroup HTTP Server process 151 Avid Workgroup Preview Server service 152 Avid Workgroup Server Browser service 152 Avid Workgroup TCP/COM Bridge service 156 AvidAM.pro file described 29 AvidWG.
ABCDEFGHIJKLMNOPQRSTUVWXYZ locking 42 migrating 48 moving 50 moving database and users 51 moving when disk space low 53 renaming 54 restoring 31 restoring example 38 splitting 133 storage configurations 135 unlocking 42 viewing information about 41 Database Information View 41 DCOMConfig Settings 150 Deactivating database 44 Deleting users and user groups 84 DiskLimit event 160 Dongle 60 Dynamic relink Editor Database option 113 E Editor Database Settings view 111 options 113 Email notifications errors and
Index ABCDEFGHIJKLMNOPQRSTUVWXYZ Interplay Administrator views opening 25 Interplay Administrator window using 23 Interplay Archive Engine described 19 Interplay database described 17 See also Database Interplay Engine Avid Interplay Engine Server process 150 Avid Workgroup HTTP Server process 151 Avid Workgroup Preview Server service 152 Avid Workgroup Server Browser service 152 Avid Workgroup TCP/COM Bridge service 156 configuration files 157 described 17 folders and files 145 optimizing performance 128
ABCDEFGHIJKLMNOPQRSTUVWXYZ NxNServerLock.exe locking server process 132 moving database with 53 NxNServerShutdown.exe moving database with 53 shutting down server process 132 NxNServerUnlock.exe moving database with 53 NXNServerUser.
Index ABCDEFGHIJKLMNOPQRSTUVWXYZ Server Settings view 55 ServerXML.xml 165 Service Configuration view (Interplay Framework) 125 Shutting down server process 132 Split database configuring workgroup.
ABCDEFGHIJKLMNOPQRSTUVWXYZ Index Workgroups remote 100 211
Index 212 ABCDEFGHIJKLMNOPQRSTUVWXYZ
