Avid Interplay Framework User's Guideresources.avid.com/SupportFiles/attach/InterplayFramework_UG.pdfThe “Interplay” name is used with the permission of Interplay Entertainment

m a k e m a n a g e m ove | m e d i a ™ Avid ®

Avid® Interplay Framework™

User’s Guide

2

Copyright and DisclaimerProduct 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. The software may not be reverse assembled and may be used or copied only in accordance with the terms of the license agreement. It is against the law to copy the software on any medium except as specifically allowed in the license agreement.

Avid products or portions thereof are protected by one or more of the following United States Patents: 4,746,994; 4,970,663; 5,045,940; 5,267,351; 5,309,528; 5,355,450; 5,396,594; 5,440,348; 5,452,378; 5,467,288; 5,513,375; 5,528,310; 5,557,423; 5,577,190; 5,583,496; 5,584,006; 5,627,765; 5,640,601; 5,644,364; 5,654,737; 5,715,018; 5,719,570; 5,724,605; 5,726,717; 5,729,673; 5,745,637; 5,752,029; 5,754,851; 5,799,150; 5,812,216; 5,828,678; 5,842,014; 5,852,435; 5,999,406; 6,038,573; 6,061,758; 6,141,007; 6,211,869; 6,532,043; 6,546,190; 6,596,031; 6,636,869; 6,747,705; 6,763,523; 6,766,357; 6,813,622; 6,847,373; D352,278; D372,478; D373,778; D392,267; D392,268; D392,269; D395,291; D396,853; D398,912. Other patents are pending.

This document is protected under copyright law. An authorized licensee of Interplay Framework may reproduce this publication for the licensee’s own use in learning how to use the software. This document may not be reproduced or distributed, in whole or in part, for commercial purposes, such as selling copies of this document or providing support or educational services to others. This document is supplied as a guide for Interplay Framework. Reasonable care has been taken in preparing the information it contains. However, this document may contain omissions, technical inaccuracies, or typographical errors. Avid Technology, Inc. does not accept responsibility of any kind for customers’ losses due to the use of this document. Product specifications are subject to change without notice.

Copyright © 2007 Avid Technology, Inc. and its licensors. All rights reserved.

The following disclaimer is required by Sam Leffler and Silicon Graphics, Inc. for the use of their TIFF library:Copyright © 1988–1997 Sam Leffler Copyright © 1991–1997 Silicon Graphics, Inc.

Permission to use, copy, modify, distribute, and sell this software [i.e., the TIFF library] and its documentation for any purpose is hereby granted without fee, provided that (i) the above copyright notices and this permission notice appear in all copies of the software and related documentation, and (ii) the names of Sam Leffler and Silicon Graphics may not be used in any advertising or publicity relating to the software without the specific, prior written permission of Sam Leffler and Silicon Graphics.

THE SOFTWARE IS PROVIDED “AS-IS” AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

The following disclaimer is required by the Independent JPEG Group:

Portions of this software are based on the work of the Independent JPEG Group.

This Software may contain components licensed under the following conditions:

Copyright © 1989 The Regents of the University of California. All rights reserved.

Redistribution and use in source and binary forms are permitted provided that the above copyright notice and this paragraph are duplicated in all such forms and that any documentation, advertising materials, and other materials related to such distribution and use acknowledge that the software was developed by the University of California, Berkeley. The name of the University may not be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

Copyright © 1989, 1991 by Jef Poskanzer.

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.

http://www.avid.com

3

Copyright 1995, Trinity College Computing Center. Written by David Chappell.

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.

Permission to use, copy, modify, distribute, and sell this software for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Daniel Dardailler not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. Daniel Dardailler makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.

Modifications Copyright 1999 Matt Koss, under the same license as above.

Copyright © 1991 by AT&T.

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. IN PARTICULAR, NEITHER THE AUTHOR NOR AT&T MAKES ANY REPRESENTATION OR WARRANTY OF ANY KIND CONCERNING THE MERCHANTABILITY OF THIS SOFTWARE OR ITS FITNESS FOR ANY PARTICULAR PURPOSE.

This product includes software developed by the University of California, Berkeley and its contributors.

The following disclaimer is required by Paradigm Matrix:Portions of this software licensed from Paradigm Matrix.

The following disclaimer is required by Ray Sauers Associates, Inc.:“Install-It” is licensed from Ray Sauers Associates, Inc. End-User is prohibited from taking any action to derive a source code equivalent of “Install-It,” including by reverse assembly or reverse compilation, Ray Sauers Associates, Inc. shall in no event be liable for any damages resulting from reseller’s failure to perform reseller’s obligation; or any damages arising from use or operation of reseller’s products or the software; or any other damages, including but not limited to, incidental, direct, indirect, special or consequential Damages including lost profits, or damages resulting from loss of use or inability to use reseller’s products or the software for any reason including copyright or patent infringement, or lost data, even if Ray Sauers Associates has been advised, knew or should have known of the possibility of such damages.

The following disclaimer is required by Videomedia, Inc.:“Videomedia, Inc. makes no warranties whatsoever, either express or implied, regarding this product, including warranties with respect to its merchantability or its fitness for any particular purpose.”

“This software contains V-LAN ver. 3.0 Command Protocols which communicate with V-LAN ver. 3.0 products developed by Videomedia, Inc. and V-LAN ver. 3.0 compatible products developed by third parties under license from Videomedia, Inc. Use of this software will allow “frame accurate” editing control of applicable videotape recorder decks, videodisc recorders/players and the like.”

The following disclaimer is required by Altura Software, Inc. for the use of its Mac2Win software and Sample Source Code:©1993–1998 Altura Software, Inc.

The following disclaimer is required by 3Prong.com Inc.:Certain waveform and vector monitoring capabilities are provided under a license from 3Prong.com Inc.

The following disclaimer is required by Interplay Entertainment Corp.:

The “Interplay” name is used with the permission of Interplay Entertainment Corp., which bears no responsibility for Avid products.

This product includes portions of the Alloy Look & Feel software from Incors GmbH.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

© DevelopMentor

http://www.apache.org/

4

This product may include the JCifs library, for which the following notice applies:JCifs © Copyright 2004, The JCIFS Project, is licensed under LGPL (http://jcifs.samba.org/). See the LGPL.txt file in the Third Party Software directory on the installation CD.

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. Government, all rights with respect to this Software and documentation are subject to the terms of the License Agreement, pursuant to FAR §12.212(a) and/or DFARS §227.7202-1(a), as applicable.

Trademarks888 I/O, Adrenaline, AirPlay, AirSPACE, AirSPACE HD, AirSpeed, AniMatte, AudioSuite, AudioVision, AutoSync, Avid, Avid DNA, Avid DNxcel, Avid DNxHD, AVIDdrive, AVIDdrive Towers, Avid DS Assist Station, Avid ISIS, Avid Learning Excellerator, Avid Liquid, Avid Mojo, AvidNet, AvidNetwork, Avid Remote Response, AVIDstripe, Avid Unity, Avid Unity ISIS, Avid Xpress, AVoption, AVX, CamCutter, ChromaCurve, ChromaWheel, DAE, Dazzle, Deko, DekoCast, D-Fi, D-fx, DigiDelivery, Digidesign, Digidesign Audio Engine, Digidesign Intelligent Noise Reduction, DigiDrive, Digital Nonlinear Accelerator, DigiTranslator, DINR, DNxchange, do more, D-Verb, Equinox, ExpertRender, Face Robot, FieldPak, Film Composer, FilmScribe, FluidMotion, HIIP, HyperSPACE, HyperSPACE HDCAM, IllusionFX, Image Independence, iNEWS, iNEWS ControlAir, Instinct, Interplay, Intraframe, iS9, iS18, iS23, iS36, LaunchPad, Lightning, Lo-Fi, Magic Mask, make manage move | media, Marquee, Matador, Maxim, MCXpress, Media Browse, Media Composer, MediaDock, MediaDock Shuttle, Media Fusion, Media Illusion, MediaLog, Media Reader, Media Recorder, MEDIArray, MediaShare, MediaStream, Meridien, MetaSync, MissionControl, NaturalMatch, Nearchive, NetReview, NewsCutter, Nitris, OMF, OMF Interchange, OMM, Open Media Framework, Open Media Management, PCTV, Pinnacle MediaSuite, Pinnacle Studio, Pinnacle Systems, ProEncode, Pro Tools, QuietDrive, Recti-Fi, RetroLoop, rS9, rS18, Sci-Fi, ScriptSync, SecureProductionEnvironment, Show Center, Softimage, Sound Designer II, SPACE, SPACEShift, SpectraGraph, SpectraMatte, SteadyGlide, Symphony, TARGA, Thunder, Trilligent, UnityRAID, Vari-Fi, Video RAID, Video Slave Driver, VideoSPACE, and Xdeck are either registered trademarks or trademarks of Avid Technology, Inc. in the United States and/or other countries.

Adobe and Photoshop are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Windows is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries. All other trademarks contained herein are the property of their respective owners.

FootageWindhorse — Courtesy of Paul Wagner Productions.Arizona Images — KNTV Production — Courtesy of Granite Broadcasting, Inc., Editor/Producer Bryan Foote.Canyonlands — Courtesy of the National Park Service/Department of the Interior.News material provided by WFTV Television Inc.Tornados + Belle Isle footage — Courtesy of KWTV News 9.WCAU Fire Story — Courtesy of NBC-10, Philadelphia, PA.Women in Sports – Paragliding — Courtesy of Legendary Entertainment, Inc.

GOT FOOTAGE?

Editors — Filmmakers — Special Effects Artists — Game Developers — Animators — Educators — Broadcasters — Content creators of every genre — Just finished an incredible project and want to share it with the world?

Send us your reels and we may use your footage in our show reel or demo!*

For a copy of our release and Avid’s mailing address, go to www.avid.com/footage.

*Note: Avid cannot guarantee the use of materials submitted.

Avid Interplay Framework User’s Guide • 0130-07636-02 • March 2007

http://jcifs.samba.org/

http://www.avid.com/footage

5

Contents

Using This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Symbols and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

If You Need Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Viewing User Documentation on the Interplay Portal . . . . . . . . . . . . . . . . . . 11

How to Order Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Avid Training Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Chapter 1 Avid Interplay Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Interplay Framework Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Avid Interplay Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Avid Interplay Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Avid Interplay Health Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Avid Interplay Workgroup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Support Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Avid Lookup Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Machine Monitor Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Avid Multicast Repeater Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Determining the Need for a Multicast Repeater Service . . . . . . . . . 20

Avid Email Alerter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Avid SNMP Gateway Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Avid Time Synchronization Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Using the Time Synchronization Service in an Avid Interplay Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Avid System Configuration Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Avid Service Starter Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Avid Media Indexer Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

6

Chapter 2 Avid Interplay Service Configuration . . . . . . . . . . . . . . . . . . . . . . 23

Starting the Interplay Service Configuration Application . . . . . . . . . . . . . . . 24

Avid Interplay Service Configuration Window . . . . . . . . . . . . . . . . . . . . . . . 25

Directory Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Discovery Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Configuration Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Configuring Services and Application Parameters . . . . . . . . . . . . . . . . . . . . 32

Chapter 3 Avid Interplay Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Starting Avid Interplay Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

The Interplay Diagnostics Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Tool Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Directory Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Selecting Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Display Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Setting Log Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

The Date and Time Filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Setting the Severity Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

The Logger Name Filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

The Message Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

The Exception Filter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Log View Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Details Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Basic Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Advanced Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Viewing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Selecting Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Viewing Local Log Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Viewing Remote Log File Information . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Overriding Logging Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Copying and Saving Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

7

Packaging Remote Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

Chapter 4 Avid Interplay Health Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Starting the Interplay Health Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

The Health Monitor Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Status Bar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Audio Alert Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Directory and Health View Panes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Directory Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Health View Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Setting Audio Alert Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

Chapter 5 Avid Interplay Workgroup Properties . . . . . . . . . . . . . . . . . . . . . . 71

Starting Interplay Workgroup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Configuring and Managing Workgroup Services. . . . . . . . . . . . . . . . . . . . . . 73

Editing and Creating a Workgroup Name. . . . . . . . . . . . . . . . . . . . . . . . 73

Viewing the Status of Avid Interplay Services . . . . . . . . . . . . . . . . . . . . 74

Stopping and Starting Avid Interplay Services . . . . . . . . . . . . . . . . . . . . 76

Understanding the Status Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Cancelling the Start or Stop Service Action . . . . . . . . . . . . . . . . . . . . . . 81

Support Information Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Setting the Preferred Workgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Managing the Lookup Services in a Workgroup . . . . . . . . . . . . . . . . . . . . . . 87

Adding and Removing Workgroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Adding and Removing Lookup Services . . . . . . . . . . . . . . . . . . . . . . . . 89

Defining the Host Computer Location . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Conducting System Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Chapter 6 Using the Avid Interplay Media Indexer . . . . . . . . . . . . . . . . . . . . 95

About Media Indexer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Tracking Media Files on a Standalone System . . . . . . . . . . . . . . . . . . . 96

Tracking and Indexing Media Files on an Avid Editing System in an Avid Interplay Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

8

Configuring an Avid Interplay Media Indexer . . . . . . . . . . . . . . . . . . . . . . . . 97

Configuring a Media Indexer to Monitor Shared Storage . . . . . . . . . . . 97

Verifying the UNC Path Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Configuring the Media Indexer on an Avid Editing System to Recognize Shared Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105

Configuring the Local Media Indexer to Index Local Drives . . . . . . . . 111

Adding Additional Media Indexer Services to Monitor Shared Storage . . . 116

Grouping Media Indexer Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Using Groups to Provide Load Balancing . . . . . . . . . . . . . . . . . . . . . . 117

Defining a Media Indexer Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Monitoring Memory Usage in the Health Monitor . . . . . . . . . . . . . . . . . . . . 120

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125

Using This Guide

Congratulations on the purchase of your Avid® Interplay™ Framework system.

You can use your Avid Interplay Framework applications to further expand the administrative monitoring capabilities of your Avid systems.

This guide contains all the task-oriented instructions, conceptual information, and reference material you need to use the logging, monitoring, and management features of your Interplay Framework applications.

This guide is intended for all Interplay Framework users, from beginning to advanced. Users should have experience in computer system maintenance and troubleshooting.

Unless noted otherwise, the material in this document applies to Windows™ operating systems. The screen shots in this document were captured on a Windows XP system.

n The documentation describes the features and hardware of all models. Therefore, your system may not contain certain features and hardware that are covered in the documentation.

Symbols and Conventions

Avid documentation uses the following symbols and conventions:

Symbol or Convention Meaning or Action

n A note provides important related information, reminders, recommendations, and strong suggestions.

c A caution means that a specific action you take could cause harm to your computer or cause you to lose data.

w A warning describes an action that could cause you physical harm. Follow the guidelines in this document or on the unit itself when handling electrical equipment.

Using This Guide

10

If You Need HelpIf you are having trouble using the Avid Interplay Framework applications:

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 for the latest information that might have become available after the documentation was published: The latest information for your Avid Interplay products are provided as a set of ReadMe files. The ReadMe files are supplied at the top level of your Avid Interplay Installer DVD as PDF documents and are also available online.

- You should always check online for the most up-to-date ReadMe because the online version is updated whenever new information becomes available. To view these online versions, visit the Knowledge Base at www.avid.com/readme.

3. Check any printed documentation that came with your Avid application or your hardware for maintenance or hardware-related issues.

4. Visit the online Knowledge Base at www.avid.com/onlinesupport. Online services are available 24 hours per day, 7 days per week. Search this online Knowledge Base to find answers, to view error messages, to access troubleshooting tips, to download updates, and to read/join online message-board discussions.

5. For Technical Support, call 800-800-AVID (800-800-2843).

For Broadcast On-Air Sites and Call Letter Stations, call800-NEWSDNG (800-639-7364).

> This symbol indicates menu commands (and subcommands) in the order you select them. For example, File > Import means to open the File menu and then select the Import command.

t This symbol indicates a single-step procedure. Multiple arrows in a list indicate that you perform one of the actions listed.

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.

Ctrl + key or mouse action Press and hold the first key while you press the last key or perform the mouse action. For example, Ctrl + drag or Ctrl + S. This also applies to Alt and Shift keys.

Symbol or Convention Meaning or Action

http://www.avid.com/readme

http://www.avid.com/onlinesupport

Viewing User Documentation on the Interplay Portal

11

Viewing User Documentation on the Interplay Portal

You can quickly access the Interplay user documentation from any system in the Interplay environment. Type the following line in your Web browser:

http://Interplay_Engine_name

where Interplay_Engine_name is the name of the computer running the Interplay Engine software. For example, the following line opens the portal Web page on a system named DocWG:

http://DocWG

Click the “Avid Interplay User Documentation” link to access the User Information Center page. On this page, select the Avid Interplay Framework User’s Guide from the list of user’s guides.

How to Order Documentation

To order additional copies of any Avid documentation from within the United States, call Avid Sales at 800-949-AVID (800-949-2843). If you are placing an order from outside the United States, contact your local Avid representative.

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.

For information on courses and schedules, training centers, certifications, courseware, and books, please visit www.avid.com/training or call Avid Sales at 800-949-AVID (800-949-2843).

http://www.avid.com/training

Using This Guide

12

Chapter 1

Avid Interplay Framework

Avid Interplay Framework is a common service distribution framework, which enables the configuration and monitoring of Avid services and applications in a small, medium, or large Avid workgroup. A workgroup is a way of grouping a set of people who are all working together.

Avid Interplay Framework consists of applications and services which provide dynamic discovery and lookup mechanisms, a scalable notification system, a centralized configuration tool, diagnostic logging for workgroup-enabled applications and services, system health monitoring, and so on. Some of the services are known collectively as Support services. The Support services are viewed, monitored, and configured using the Interplay Framework applications.

n Depending on your system, you might need to disable some of the Interplay Framework services to conserve memory usage. This is done using the Interplay Workgroup Properties application.

For more information see “Avid Interplay Workgroup Properties” on page 71.

This chapter contains the following main sections:

• Interplay Framework Applications

• Support Services

1 Avid Interplay Framework

14

Interplay Framework Applications

The Interplay Framework applications are the tools that provide for viewing, monitoring, and configuring all of the Support services within an Avid workgroup. They help expand the administrative monitoring capabilities of your Avid systems. These applications include:

• Avid Interplay Service Configuration

• Avid Interplay Diagnostics

• Avid Interplay Health Monitor

• Avid Interplay Workgroup Properties

Avid Interplay Service Configuration

The Avid Interplay Service Configuration application is a tool used for managing services and applications in an Avid workgroup. Each of the Avid components that make up your workgroup have different sets of parameters, which must be established when first implemented and managed from time to time. Interplay Service Configuration streamlines the process of managing a diverse set of parameters for multiple services. Its graphical user interface (GUI) simplifies setting and changing parameters for each of the different Avid services and applications in your workgroup environment.

The Interplay Service Configuration window is divided into several sections including Directory and Configuration panes.

Menu bar

Directory pane

Configuration pane

Tabs


15

The Directory pane lists available hosts and processes in a directory tree-style navigation list. Two tabs determine how information is displayed in the Directory pane. The Hosts tab lists all available hosts in the selected workgroup. The Processes tab lists all processes currently running on the computers in the selected Avid workgroup.

The Configuration pane displays system information that varies depending on the tab selected, Host or Processes.

For more information on using the Interplay Service Configuration application, see “Avid Interplay Service Configuration” on page 23.

Avid Interplay Diagnostics

Avid Interplay Diagnostics is an application that allows you to view log information stored on either a local or remote computer. You can view log information streaming in real time, open logs stored on a remote computer, package remote logs and specify a storage location for them, filter logs by severity, and override the logging levels of remote services.

The Avid Interplay Diagnostics window is divided into several sections including a Directory pane, a Display Filter, Log View and Details panes.

Log View pane

Directory pane

Menu bar

Tabs

Display filter Details View pane


16

The Directory pane lists available hosts and processes in a tree-style navigation list. The Log View pane displays log entries, which vary depending on the workgroup, selected host or process. The Details pane displays details about the selected log entry.

For more information on using the Interplay Diagnostics application, see “Avid Interplay Diagnostics” on page 37.

Avid Interplay Health Monitor

Avid Interplay Health Monitor is an application that enables you to view the health of your Avid system at a glance. The Interplay Health Monitor displays a variety of information provided by each of the registered Avid components on your network, and notifies you with a warning or critical indication if a component goes beyond its normal operating range. Avid services can supply custom health information to a viewer tailored to their specific functionality.

Information reported in the Interplay Health Monitor can include:

• Hardware details - operating system, RAM, processors and speed

• Available disk space and partitions

• Memory usage

• CPU usage

• Custom system status, depending on the service

The Interplay Health Monitor window is divided into a tabbed Directory pane and a Preview Pane. It also provides a Status bar that provides an at-a-glance view of the overall status of the system.

Directory pane

Tabs

Menu bar

Status bar

Preview pane


17

The Directory pane has two tabs to display available hosts and processes. The Hosts tab shows all available hosts in the workgroup. The Processes tab shows all processes currently running on the computers in the workgroup.

For more information on using the Interplay Health Monitor application, see “Avid Interplay Health Monitor” on page 61.

Avid Interplay Workgroup Properties

Avid Interplay Workgroup Properties is an application that supports high-level configuration and control of services on a particular computer. The Interplay Workgroup Properties application allows you to set the workgroup for services, and lets you start and stop or view workgroup services. You can also configure the physical location of the computer, which is reported to remote software.

Users who are members of a specific workgroup run all of their workgroup components—all Avid services and applications—under that specific workgroup name. For instance, a manager is starting a new project and wants to create a new workgroup and have all of his project members run their workgroup components under one workgroup name.

The Interplay Workgroup Properties window contains different tabs that allow you to display information, start, and stop the various Avid services.


18

The Services tab allows you to view the status of the Avid services running on the local computer. You can start, stop, restart, enable, or disable the local Avid workgroup services. It also allows you to move the local computer to a different workgroup.

The Login tab is where you can define your preferred workgroup.

The Lookup tab allows you to manually add or remove a Lookup Service to the local computer’s cache of Lookup services and it provides the option to make a Lookup Service an “Expected” service.

The Location tab allows you to define the physical location information for a particular computer in an Avid workgroup. This defined physical location is then detected by other viewers, making the computer easy to find.

The System Check tab does basic domain name service (DNS) resolution tests to confirm that core networking prerequisites are met.

The About tab contains information about the version of Interplay Workgroup Properties.

For more information on using the Interplay Workgroup Properties application, see “Avid Interplay Workgroup Properties” on page 71.

Support Services

Some of the Interplay Framework services are known collectively as Support services. These services are installed with Interplay Framework and viewed, monitored, and configured using the Interplay Framework applications. This section contains an overview of the following services:

• Avid Lookup Service

• Machine Monitor Service

• Avid Multicast Repeater Service

• Avid Email Alerter

• Avid SNMP Gateway Service

• Avid Time Synchronization Service

• Avid System Configuration Service

• Avid Service Starter Service

• Avid Media Indexer Service

n Not all workgroups are configured using the same services. Therefore, your system might not contain certain services that are covered in this documentation.

Support Services

19

Avid Lookup Service

The Avid Lookup service supports other important Avid services used throughout your Avid Interplay environment. It acts as a broker or locator between services and clients and it is an important communication link between the Avid Interplay Framework applications and the other support services.

For systems on remote subnets, sometimes it might be necessary to connect directly to the Lookup service using a technique known as unicast discovery. For instance, if you have problems configuring a Multicast Repeater service and need to connect your systems to Interplay Framework.

For more information about configuring an Avid Lookup service, see the Avid Interplay Software Installation and Configuration Guide.

Machine Monitor Service

The Machine Monitor service is a service that runs on a server in a workgroup. The Machine Monitor service is part of the Interplay Framework and monitors the system health of the host it is running on. The settings for the Machine Monitor service are stored in a Registry key on the local machine.

Avid Multicast Repeater Service

The Multicast Repeater service supports Interplay environments that must span multiple multicast domains. A multicast domain is a group of computers and devices on a network that are administered as a unit with common rules. In an Interplay environment, each domain must have at least one Multicast Repeater service running. Each of the computers running this service must identify other hosts running Multicast Repeater services on other multicast domains. You use the Avid Interplay Workgroup Properties application to identify the Lookup services on the different multicast domains.

A single Multicast Repeater is not useful by itself. It needs to have a counterpart in the another multicast domain so they can tunnel to each other. The two Multicast Repeater services use the Unicast Lookup Locators, configured on the Lookup tab of the Interplay Workgroup Properties window to determine what hosts other Multicast Repeater services run on in other multicast domains.You can install more than one Multicast Repeater service for redundancy. When this is done, they defer responsibility to one another so that only one is active at a time. When a Multicast Repeater service receives a message from another Multicast Repeater, it re-broadcasts the message within its own multicast domain.


20

Determining the Need for a Multicast Repeater Service

A multicast domain boundary can occur when you have computers running in different subnets. However, routers can be configured to pass multicasts on to other subnets, so a subnet is not always the boundary of a multicast domain.

If a system is not recognized by the Interplay Framework, the reason might be that the system is on a different subnet and the router is not configured to allow communication between the two different subnets. In this case, you need the Multicast Repeater service.

For more information about configuring a Multicast Repeater service, see the Avid Interplay Software Installation and Configuration Guide.

Avid Email Alerter

The Email Alerter is an e-mail daemon, which sends e-mail notifications to a configurable list of recipients when any of the health parameters—on systems in the workgroup—are at warning or critical health level. The Avid Lookup service gathers the health level information from systems within the workgroup.

The Avid Email Alerter is configured using the Avid Interplay Service Configuration application.

Avid SNMP Gateway Service

The Avid SNMP Gateway service can capture a snapshot of a workgroup by mirroring all of the health information in a simple network management protocol (SNMP) management information base (MIB). It uses an SNMP daemon to send traps to an SNMP trap receiver whenever a warning or critical system condition occurs. It captures a snapshot of the workgroup, reflects it in an SNMP MIB, and makes that information available to SNMP manager applications, such as HP® OpenView, by acting as an SNMP agent that responds to requests.

Avid Time Synchronization Service

The Avid Time Synchronization service enables time synchronization between different machines in a workgroup. The Time Synchronization service can operate in either Master mode or Slave mode. In Master mode, the service retrieves a reference time from a configured time source and redistributes it to the Slave services within the workgroup. The time source can be the local PC clock, an NTP server, or an Adrienne™ Timecode card installed in the server.

Support Services

21

If multiple Time Synchronization services are configured as Master, they coordinate among themselves and identify one Primary service to distribute the time notifications (the others are in Backup mode and silent until a Primary fails. If a Primary fails, one of the Backups takes over).

In Slave mode, the Time Synchronization service listens for time notifications from the workgroup and (optionally) sets the local PC clock to match. Slave Time Synchronization services are only useful to set the local PC clock.

n If you are not using your slave Time Synchronization service to set the local PC clock, you can disable the Time Synchronization service on that computer.

Using the Time Synchronization Service in an Avid Interplay Environment

The following are the three typical ways of implementing Time Synchronization in an Interplay environment:

• In Interplay environments that use CaptureManager to capture material, a CaptureManager system is usually designated as the Time Sync master. The CaptureManager system has an Adrienne card. Install the Interplay Framework Time Synchronization service on the CaptureManager system and configure it as a Time Synchronization master.

• If you don’t use a CaptureManager system, do one of the following:

- Designate another system with an Adrienne card as the Time Synchronization master. Install the Interplay Framework Time Synchronization service on this system and configure it as a Time Synchronization master.

- Use an NTP server for Time Synchronization reference. Install the Interplay Framework Time Synchronization service on a system on the network that does not need to be shut down frequently and configure the service as a master. When you configure the master, point to the NTP service for time synchronization.

- Designate any system that rarely has to be shut down as the Time Synchronization master and set the time synchronization reference to the internal PC clock on that system.

It is important to use only one time synchronization mechanism to set the local PC clocks in the Interplay environment. If a Time Synchronization slave service is configured to set the local PC clock and it detects that some other mechanism (such as Windows 32 Time Services) changes the local clock, then the Time Synchronization slave service will disable itself to keep the local clock from jumping back and forth. The Time Synchronization slave service will also post a warning in the Health Monitor.

When you install the Time Synchronization service on a system, it runs as a Time Synchronization slave by default.


22

For more information about choosing the system to use as a master or slave, see the Avid Interplay Software Installation and Configuration Guide.

Avid System Configuration Service

The Avid System Configuration service is a shared repository for data that is used across services within a workgroup. You can configure a list of machines for Interplay Health Monitor and change the administration password using the System Configuration service's configuration settings. Service settings are available for configuring services, such as AutoArchive, AutoTranscode, and AutoTransfer.

Avid Service Starter Service

The Avid Service Starter service is responsible for starting all the other Interplay Framework services on the machine when the machine is started. It can also be configured to restart any services that are stopped unexpectedly.

Avid Media Indexer Service

The Avid Media Indexer is a background service that keeps track of media files in predetermined storage locations. Avid editing systems associate each video or audio media file with a unique metadata object called a MOB file. The Media Indexer service maintains a database that maps MOB file IDs to actual storage locations.

In an Avid workgroup environment, each Avid editing system has its own local Media Indexer service that manages the local storage areas on that system. Each workgroup environment also has at least one Media Indexer service that manages media on shared storage. When the Avid editing system must access media on shared storage, it communicates with its local Media Indexer service, which then communicates with the shared storage Media Indexer service. The Interplay Framework services provide the communication link between the Media Indexer services and the Avid editing applications.

After the Interplay Framework is installed, the Interplay Workgroup Properties is used to install the Media Indexer service. The Media Indexer service doesn’t have its own user interface so the Interplay Service Configuration application is used to configure, chain, or define groups of Media Indexer services. The Interplay Health Monitor is used to view the status of a Media Indexer service. For more information, see “Using the Avid Interplay Media Indexer” on page 95.

Chapter 2

Avid Interplay Service Configuration

The Avid Interplay Service Configuration application manages the services and applications in an Avid workgroup. It has a straightforward graphical user interface (GUI) to simplify the configuration of each of the different Avid services and applications in a workgroup environment.

n For certain services, such as the Avid Machine Monitor service, the audio alert preferences for warning and critical monitoring levels are set using the Avid Interplay Health Monitor. However, you can add or remove monitored processes to or from the Machine Monitor service using the Interplay Service Configuration tool.

Each of the Avid components that make up a workgroup have different sets of parameters. Some of these parameters must be configured when first implemented and managed from time to time. This tool makes managing a diverse set of parameters for multiple services a streamlined process.


• Starting the Interplay Service Configuration Application

• Avid Interplay Service Configuration Window

• Configuring Services and Application Parameters

2 Avid Interplay Service Configuration

24

Starting the Interplay Service Configuration Application

To start the Interplay Service Configuration application:

1. Click the Start button and select All Programs > Avid > Interplay Framework > Avid Interplay Service Configuration.

The Select Workgroup dialog box opens.

2. Select a workgroup.

3. (Option) Select “Always select and use this workgroup.”

From now on, the Select Workgroup dialog box no longer opens when the application starts.

4. Click the Select button.

The Avid Interplay Service Configuration window opens and displays the Hosts tab by default.

Avid Interplay Service Configuration Window

25


The Avid Interplay Service Configuration window is used to configure the parameters for each of the Avid services and applications in your workgroup environment.

The window is divided into the following sections:

• Directory Pane

• Configuration Pane

Directory Pane

Directory Pane

The Directory pane has two tabs that list available hosts or processes in a tree-style navigation list. Right-clicking on either tab anywhere in the Directory pane displays a menu allowing you to expand or collapse the entire tree view. The Hosts and Processes tabs alter the way information is displayed in this area.

Directory pane

Configuration pane

Tabs


26

The Hosts tab lists all available hosts in the selected workgroup.

n Computers that do not have configurable services are not displayed in the list.

The Processes tab lists all configurable processes currently running on the computers in the selected Avid workgroup.

Workgroup name

Host computers that are members of this workgroup

Workgroup name

Processes running on one or more host computers in this workgroup


27

The following table describes the icons that appear in the Directory pane.

The following example shows the various icons as they appear in the Directory pane. The Hosts tab is selected and one host is expanded to display the Avid processes running on that system.

The previous illustration shows process information about the selected service in the Configuration pane.

Icon Description

Workgroup - The selected workgroup. Clicking the blue Workgroup icon opens the Discovery Manager window. For more information, see “Discovery Manager” on page 28.

Host - The hosts in the selected workgroup.

Expand list - Expands the list view.

Collapse list - Collapses the list view.

Configuration pane


28

n Avid Machine Monitor is a service that runs on a server in a workgroup. It is part of the Interplay Framework and monitors the system health of the host it is running on. For more information see “Machine Monitor Service” on page 19.

Discovery Manager

The Discovery Manager allows you to see the Lookup services detected by the Interplay Framework application you are running, such as Interplay Service Configuration, Interplay Health Monitor, and Interplay Diagnostics. The Lookup service is the core of the discovery mechanism used by a workgroup’s services and applications. Each workgroup has at least one Lookup service that all the workgroup’s services and applications can find.

To open the Discovery Manager:

t Click the blue Workgroup icon on the Hosts tab of the Directory pane.

The Discovery Manager window opens.

Blue Workgroup icon

Lookup services list Services button Refresh button


29

The Discovery Manager lists the lookup services that are detected by the Interplay Health Monitor. The name of the workgroup is displayed in the Discovery groups text field. When a Lookup service is discovered, a green dot is displayed to the left of the Lookup service check box. When a check mark appears in the box, it signifies that this Lookup service is an expected service.

T

To view more detailed information about a Lookup service:

1. Click a service from the Lookup service list of the Discovery Manager window.

2. Click the Services button. An information window opens.

This window displays a list of all of the services associated with the selected Lookup service. It also lists Service IDs, Hosts, and Interfaces associated with the Lookup service.

Expected Lookup service columnLookup Service status column

Lookup service list


30

To view information about a particular service associated with the selected Lookup service:

t Double click the service name in the list. The Attributes and Interfaces areas of the information window are populated with additional information.

Configuration Pane

The Configuration pane displays system configuration information, which varies depending on the workgroup and selected host or process. Changes can be made to the selected host or process from this pane. In the following example, the Avid EMail Alert Service running on the qawgsvr2 host is selected from the list on the Process tab.


31

When the host under a particular service is selected, the configuration information about that host is shown in the Configuration pane, and the Apply, Apply To, and Reset buttons are enabled.

Hosts on which this service is running


32

The following buttons are available located above the Configuration pane:

These buttons are enabled only after you select a service and host in the Directory pane when the configuration information is displayed in the Configuration pane. If you make configuration changes and you do not click one of these buttons prior to changing a selection or closing the window, a dialog box opens reminding you to apply or reset the configuration.

n The Service Configuration application is used to configure the Media Indexer. However, the Apply To button does not apply the configuration settings to multiple Media Indexer services. The action only applies to the selected Media Indexer. Each Media Indexer must be configured individually.

Configuring Services and Application Parameters

The Avid Interplay Service Configuration window is used to configure parameters for each of the different Avid services and applications in your workgroup environment. However, you must set the warning or critical health monitoring levels for some services, such as the Machine Monitor Service, using the Avid Interplay Health Monitor. For more information see “Avid Interplay Health Monitor” on page 61.

The following procedure is an example of how to use Avid Interplay Service Configuration to configure a service. The Avid Automatic Archive service is configured in the example.

n Archiving allows you to create an offline copy of clips, sequences, and other file assets. The Archive server database keeps track of the files that you store on the external storage device and allows you to restore the files to your online system when they are needed. Before the archiving can work, you must configure the AutoArchive service on the workgroup administrator client and in the Interplay Framework system.

Button Description

Click this button after making setting changes to apply the new settings.

Click this button after making setting changes to apply the new settings to all of the services. This button does not apply the settings to multiple Media Indexer services. Each Media Indexer must be configured individually.

Click this button after making changes to restore previous settings. This only restores previous settings if the Apply button was not pressed.


33

To configure the Avid Automatic Archive service using Interplay Framework:

1. On any system with the Interplay Service Configuration application installed, open the application as follows:

t Click the Start button, and select All Programs > Avid > Interplay Framework > Avid Interplay Service Configuration.


2. Select the workgroup to which you want to connect.


n The Select Workgroup dialog box does not open if you previously selected the check box to “Always select and use this workgroup”. When you select this option, the Select Workgroup dialog box no longer opens when you start the application. Instead, the default workgroup is selected, and the Avid Interplay Service Configuration window opens.

4. When the Avid Interplay Service Configuration window opens, click the Process tab and verify that the Avid Automatic Archive, Transcode, and Transfer processes are running.

n If the Avid Automatic Archive, Transcode, and Transfer service does not appear in the Avid Interplay Service Configuration window, it means it is not running or the system it runs on is not properly connected to the workgroup. Click the Hosts tab and ensure that the Interplay Service Configuration displays the name of the system that the Avid Automatic Archive, Transcode, and Transfer service is running on.

5. Expand the Avid Automatic Archive, Transcode, and Transfer service entry in the Directory pane.

The system displays the name of the computer running the Avid Automatic Archive, Transcode, and Transfer service.

6. Click the computer name.

The Administrator Password Needed dialog box opens.


34

n By default, Interplay Framework does not require a password. When a password is used, it is set through the System Configuration Service. Check with your system administrator for the correct password.

7. Type the Interplay Framework Administrator password and click the OK button.

The system displays the Workgroup Server Setting tab for the Avid Automatic Archive, Transcode, and Transfer service.

8. Type the Interplay Engine hostname, username, and password.

9. Click the Service Settings tab.


35

The system displays the Service Settings for the Avid services.

10. In the Configure AutoArchive area, do the following:

- Enable AutoArchive—select Yes.

- AutoArchive scanning interval—type the number of minutes between scans.

- Number of times to retry when encountering an error—type the number of times you want the system to retry after an error occurs.

- Number of clips to submit to Interplay Archive at once—type the number of clips you want sent for archive at one time.

System running the Avid Automatic Archive, Transcode, and Transfer service

Apply buttonService Settings tabApply To button

Reset button


36

11. Do one of the following

t Click the Apply button to apply the changes to an individual service

t Click the Apply To button to apply the changes to all services within the workgroup.

n The Apply To button does not apply the configuration settings to multiple Media Indexer services. The action only applies to the selected Media Indexer. Each Media Indexer must be configured individually.

12. Close the Avid Interplay Service Configuration window.

n When configuration changes are made and the Apply or Reset button is not clicked prior to changing a selection or closing the window, a dialog box appears reminding you to Apply or Reset the configuration.

Chapter 3

Avid Interplay Diagnostics

Avid Interplay Diagnostics is an application that allows you to view log information stored on either a local or remote computer. You can view log information streaming in real time, open logs stored on a remote computer, package remote logs and specify a storage location for them, filter logs by severity, and override the logging levels of remote services.

You can view logs from multiple systems at the same time, and you can merge logs from multiple hosts or services chronologically using a synchronized workgroup time. The user interface allows you to choose the specific host and process logs you would like to view.

Logs can be displayed at different levels of detail ranging from low level events that do not compromise the system to those of higher importance, such as fatal errors. You can choose which level of detail you would like to view.


• Starting Avid Interplay Diagnostics

• The Interplay Diagnostics Window

• Setting Log Filters

• Viewing Logs

• Overriding Logging Levels

• Copying and Saving Log Files

3 Avid Interplay Diagnostics

38

Starting Avid Interplay DiagnosticsTo start Avid Interplay Diagnostics:

1. Click the Start button, and select All Programs > Avid Interplay Framework > Avid Interplay Diagnostics. The Select Workgroup dialog box opens.





The Avid Interplay Diagnostics window opens.

The Interplay Diagnostics Window

39

5. (Option) Click the Display Filter arrow to display or change the filter options.

6. (Optional) Click the resize arrows or bar to expand or collapse the Log View and Details View panes, as shown in the proceeding illustration. Double-clicking a log entry in the Log View pane also expands the Details pane view.


After starting the Interplay Diagnostics, the Avid Interplay Diagnostics window opens. This window allows you to select the hosts or services from which you would like to view logs.

The Log Viewer window is divided into several sections:

• Tool Bar

• Directory Pane

• Display Filter

• Log View Pane

• Details Pane

Display Filter arrow Resize arrows

Log View pane

Details View pane

Resize bar

Queue pane


40

Tool Bar

The Tool bar contains icons which perform the following functions:

Tool Bar Icon Tool Tip Function Description

Open... Opens a local log file or files on the computer you are using. A

File Open dialog box opens allowing you to select the log file for viewing.

Open Remote Same function as Open, but allows you to select log files that are stored on a Remote computer. A dialog box opens containing a tree of the services in the workgroup. Select a particular service to display the available log files for that service. Multiple log files can be selected to open and view. The log files are transferred over the network and displayed in your viewer.

n This is different than just using the Open file dialog to open the remote file because it retrieves the file without having to have access to the remote computer’s file system.

Save All A Save dialog box opens allowing you to save all records, currently in the viewer, to a specified location. This allows you to combine logs from multiple services in to a single file. This option saves all records regardless of filter settings.

Save Visible A Save dialog box opens allowing you to save all visible Records to a specified location. Using this tool, you can filter the log records and save the filtered entries to a file.

Save Selected A Save dialog box opens allowing you to save all selected records to a specified location. Using this tool, you can select specific records to save to the file while excluding the ones of less importance.

Package Remote

Opens a dialog box, with which you can select services, set a date and time range, and specify a file storage location. All of the available log files for the selected services within the specified date and time range are packaged (zipped) and saved in the specified location.

Copy Copies (selected lines or text) data from the list to the clipboard.

Copy All Copies all log records from the list to the clipboard. The data can then be pasted to a text editor in the Avid Log File (ALF) XML format.


41

Directory Pane

The Directory pane has two tabs that list available hosts or processes in a tree-style navigation list. Right-clicking either tab, anywhere in the Directory pane, opens a menu allowing you to expand or collapse the entire tree view. The names of the systems are displayed in alphabetical order, by host name. Systems are grouped together by service or host.

Various icons are used in the Directory pane, as described in the following table.

Copy Visible Copies visible records from the list to the clipboard. The data can then be pasted to a text editor in the Avid Log File (ALF) XML format.

Copy Selected Copies selected lines (data) from the list to the clipboard.The data can then be pasted to a text editor in the Avid Log File (ALF) XML format.

Clear Clears all the log records in the list (empties the list).

Tool Bar Icon (Continued)

Tool Tip (Continued) Function Description (Continued)

Icon Description

Workgroup - The selected workgroup. Clicking this icon opens the Discovery Manager window. For more information see “Discovery Manager” on page 28.

Host - A host PC in a workgroup.

Process - A process or service running on a host in a workgroup.

Expand list - Expands the entire directory tree view.

Collapse list - Collapses the entire directory tree view.


42

Selecting Processes

The Directory pane also contains check boxes located to the left of each process displayed. When these are selected, a logging listener is added to that process and the details about that particular process are logged to the Log Viewer pane in real-time. You can select multiple processes about which to obtain logs. For more information, see “Log View Pane” on page 47.

There are two tabs, which determine how information is displayed in the Directory pane:

• Hosts

• Processes

The following illustration shows a workgroup with its hosts and processes expanded in the Directory pane.

When one or more check boxes in the Directory pane are selected, information for those processes shows up in the Log View pane.

Process

Check boxes Hosts in the selected

workgroup that run this particular process

Setting Log Filters

43

To display log entries for a process:

t For each process about which you want logs displayed, select the check box located to the left of the host name in the Directory pane.

Logs are displayed in the Log View pane.

To change information in the Log View pane:

t Select different column headings from the View > Columns menu. For more information see “Log View Pane” on page 47.

n Right-clicking column headers in the Log View pane displays a menu allowing you to select or add different column headings to the Log View pane.

The Hosts tab lists all available hosts alphabetically, that are running services with workgroup logging enabled.

The Process tab lists all available processes alphabetically, that are running services with workgroup logging enabled.

Display Filter

The Display Filter button opens and closes the Display Filter section in the Queue pane. This section allows you to select the filter criteria and logging levels for the Log Viewer. You can display logs at different levels of detail. They can range from low level events that do not compromise the system, to those of higher importance, such as fatal errors.

Setting Log Filters

Logs can contain large amounts of data but sometimes not as much information is needed or desired. Setting log filters helps logs collect only the information you need.

To set filters:

1. In the Directory pane, select services that correspond to the real-time logs and the details that you want to view. For more information, see “Viewing Logs” on page 53.

2. Click the Display Filter button.

Display Filter button


44

The Display Filter section opens in the Queue pane as shown in the following illustration.

3. Set the logging filters, which can include:

- From and To dates and times

- Severity logging levels including SEVERE, WARNING, INFO, CONFIG, FINE, FINER, and FINEST

- Logger Name

- Message of the log entry

- Exception type to filter by

The Date and Time Filter

When you select the From check box, the filter is based on a From and To date and time.

To set Date and Time criteria:

1. Select the From option.

2. Click the From arrow. The Date and Time tool opens, as shown in the following illustration.

From arrow To arrow

Setting Log Filters

45

3. Set the appropriate Date and Time for the From criteria.

4. Click the OK button.

The tools save the criteria and close.

5. Click the To arrow.

6. Repeat steps 3-4 to set the appropriate Date and Time for the To criteria.

Setting the Severity Filter

When you select the Severity option, it filters based on the logging level selected in the drop-down list box. If you want to view all severity logs do not select the Severity check box.

The following table lists the Severity filter options and their descriptions.

From arrow To arrow Date and Time tool


46

The Logger Name Filter

When you select the Logger Name check box, the filter is based on the contents displayed in the Logger Name text box. If there is no text, it is the same as no filter or leaving the check box unchecked. You cannot specify multiple names but the name can specify a hierarchy. If the name entered into the text box shows up anywhere in the logger name, it will be

Filter Option Selections Filter Option Descriptions

SEVERE Show only log records that are of a SEVERE level. SEVERE generally indicates that something happened to prevent the application from running. For instance, if no workgroup was supplied.

WARNING Show only log records at a severity level of WARNING or higher, such as WARNING AND SEVERE. WARNING usually indicates that something is wrong but does not affect operation of the application. For instance, if some parameter is out of range, it might log it as a WARNING and then use a safe default.

INFO Show only log records that are of a severity level of INFO, WARNING or SEVERE. INFO stands for informational logs. These logs show progress and provide information about what is happening in the program.

CONFIG Show CONFIG log records or above (INFO, WARNING or SEVERE). CONFIG log records provide a variety of static configuration information, which assist in debugging problems associated with particular configurations. For instance, a CONFIG record might include the CPU type, the graphics depth, the GUI look-and-feel, and so on.

FINE Show log records that are of FINE level or above (INFO, WARNING, SEVERE or CONFIG. FINE is usually used for debug-level logging. These logs provide tracing information and are not of interest to most users.

FINER Show only log records that are of FINER level or above (FINE, CONFIG, INFO, WARNING or SEVERE). FINER is usually used for debug-level logging. These logs provide a less-detailed tracing message and are not of interest to most users.

FINEST Shows only log records that are of FINEST level or above. FINEST is usually used for debug-level logging. These logs are more verbose and detailed—not of particular interest to most users.

Setting Log Filters

47

displayed. For instance, if the text box contains the name avid, both of the logger names com.avid.workgroup and com.somecompany.david match the filter. To see only Avid generated log items, type com.avid for the Logger Name.

The Message Filter

When you select the Message check box, the filter is based on the contents of the Message text box. If there is no text, it is the same as no filter or leaving the box deselected.

The Exception Filter

When you select the Exception check box, the log viewer displays only log records that include an exception. An exception is an event that happens during the execution of a program that interrupts the normal flow of the program’s instructions.

When no text is typed in the Exception text box, all log records containing exceptions are displayed. Any text that is entered in the text box is compared against the exception name. If the field being filtered contains any part of the text entered in the text box, it's considered a match. If you want to see only the exceptions that Avid has created, enter com.avid in the text box. If you know the name of the exception for which you are looking, such as SetupException, you could enter that in the text box.

Depending on the settings, an example of what can appear in the Log View pane is shown in the following illustration.

Log View Pane

The Log View pane remains unpopulated until a host or process is selected from the Directory pane. After selections are made, details about the selected processes are displayed in the Log View pane. The information displayed varies depending on the workgroup, selected host or process, display filter, and the Log View pane column headings which are visible.


48

In the previous example, the Avid Machine Monitor service and Avid MediaIndexer processes are selected in the Directory pane. Information about them is shown in the Log View pane. You can expand or collapse the Log View pane view using the Resize arrows or Resize bar. The Log View pane displays the diagnostic details.

Setting Log Filters

49

To resize the Log View pane:

1. Start the Interplay Diagnostics.


t Click and drag the Resize bar.

t Click the Resize arrows located to the left of the Resize bar.

To set visible column headings:

1. Start Interplay Diagnostics.

2. Do one of the following:

t From the Menu bar select View > Column.

t In the Log View pane, right-click any column heading. For this method, there must be at least one heading already visible in the Log View pane.

A list of column heading options appear, as shown in the following illustration.

Log View pane Column heading

Resize arrows Resize

bar

Details pane


50

3. Select the column headings that you want to display in the Log View pane.To display more headings, repeat step 2-3. The options are described in the following table:

List of column heading options

Column Heading Description

Sync Time The synchronized workgroup time stored in the log file as universal time code (UTC). Each workgroup service receives timestamps from a Master Time Sync Service (if one exists) and uses the synchronized workgroup time in this field. This creates a field with synchronized workgroup time across all the log files.

Time The time stamp from the local PC’s clock at the time the log entry is made. This time is stored in the log file as universal time code (UTC).

Seq # Each log entry gets stamped with a number (starting at the number 0). The number increments after every entry until the service is restarted, and then it starts again at the number 0.

Host Name The name of the computer that logged the entry.

PID The process ID of the process that created the log entry.

Proc Name The name of the process that created the log entry.

Level The logging severity level that the message represents. Choices are: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST.For more information see “Display Filter” on page 43.

Setting Log Filters

51

Details Pane

The Details pane displays information about the record displayed in the Log View pane. It contains a Basic and an Advanced tab for viewing information about the log record.

Icons on these tabs are used for quick, easy identification.

.

Message The message of the log entry. Either the message or the alternative message is used but not both.

Message This is the alternative localized message. Interplay Framework provides support for logging both a localized and an English message. Either the message or the alternative message is used but not both.

Thd ID The ID of the thread logging the message.

Thread Name The name of the thread logging the message.

Logger The name of the Logger.

Source Class The name of the Java class logging the message.

Source Method The name of the Java method (function) logging the message.

Column Heading Description (Continued)

Basic tab

Advanced tab

Tab Icon Tab Type

Basic

Advanced


52

Basic Tab

A basic log message is displayed (in the text box area of the Basic tab) and can include the options described in the following table:

.

Advanced Tab

An Advanced log message is displayed (in the text box area of the Advanced tab) and can include the options described in the following table.

Option Description

Sync Time The synchronized workgroup time. Each workgroup service receives timestamps from a Master Time Sync Service (if one exists) and uses the synchronized workgroup time in this field. This creates a field with synchronized workgroup time across all the log files.

Time The time stamp from the local PC’s clock at the time the log entry is made.

Seq # Each log entry gets stamped with a number (starting at the number 0). That number increments after every entry until the service is restarted, and then it starts again at the number 0.

Level The logging severity level that the message represents. Choices are: SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST.


Process ID The process ID of the process that created the log entry.


Host Name The name of the computer that logged the entry.

Option Description

Thread Name ID The name (ID) of the thread logging the message.

Logger Name The name of the Logger.

Class Name The name of the Java class logging the message

Method Name The name of the Java method (function) logging the message.

Exception The name of the Exception.

Viewing Logs

53

Viewing Logs

You can view log information about services and the log information about them is displayed in the Log View pane.

Selecting Services

You can view log information about services when you select them in the Directory pane.

To view real-time log information:






The Avid Interplay Diagnostics window opens.


54

5. Select the services for which you want to display logging details. In the preceding example, both Avid Machine Monitor and Media Indexer are selected.The logging information appears in the Log View pane.

6. (Option) Click the Display filter button and set the logging parameters to filter out records that are not needed.

7. (Option) Use the Tool bar options to copy or save the desired logging information. For more information, see “Tool Bar” on page 40.

Viewing Local Log Information

Log information about local services is displayed in the Log View pane.

To open and view a local log file:



t Click the Open icon on the Tool bar.

t Select File > Open.

An Open dialog box opens.

3. Navigate to the location of the local ALF file and click the Open button.

Viewing Logs

55

4. Select the local ALF file and click the Open button.

The file opens in the Log View pane.

5. To open another file, repeat the preceding steps.

The next file opened is added to the previous file (in chronological order) and is displayed in the Log View pane.

If you do not want the two files to display in the Log View pane together, click the Clear tool on the tool bar or select Edit > Clear to clear the Log view pane prior to opening the next file.


56

Viewing Remote Log File Information

You can view remote log information in the Log View pane.

To open and view a remote log file:


2. Click the Open Remote icon on the Tool bar.

The Open Remote dialog box opens.

3. Use the Directory pane to locate the service whose log information you want to view.

The log file information is displayed in the Log View pane.

Overriding Logging Levels

By default, most services log only at the INFO level. You can override these logging levels while you view them.

n Logging levels that are set using the Override Logging Level dialog box remain in effect until the service is restarted or the levels are explicitly changed.

Overriding Logging Levels

57

To override a logging level:

1. Select Edit > Override Logging Levels.

The Override Logging Levels dialog box opens.

2. Right-click to expand or collapse all items in the directory or use the expand and collapse icons to do each item individually.

3. Click the name of the host ore process whose logging level you want to change.

4. Click the select button


58

5. Select a Logging Level using the drop down list.

n Selecting the ALL logging level can degrade a service’s performance


A small icon—the same as that in the Logging Level list—representing the new logging level appears in the directory tree. When the process is running at the default level, there is no icon present.

7. To use the logging level, select <default> from the list.

Copying and Saving Log Files

The Tool bar contains the tools needed to copy and save log files for diagnostic reference or for future use.

To copy log records:

1. Using the Directory pane, locate the service or services whose log information you want to copy.

2. Select the corresponding check boxes for each service.

3. Use one of the Copy icons on the Tool bar to copy the information to the clipboard. See “Tool Bar” on page 40 for information about the different Copy tools.

To save log records to a file:

1. Using the Directory pane, locate the service or services whose log information you want to save.

2. Select the corresponding check boxes for each service.

3. Click one of the Save icons on the Tool bar. See “Tool Bar” on page 40 for information about the different Save tools. A Save dialog box opens where you can specify a location in which to save the log information.

Logging level arrow

Logging level list

Copying and Saving Log Files

59

Packaging Remote Log Files

You can package remote log files and save them to a specified location. Packaging the files compresses them, by creating a zip file, so they use less storage space.

To package remote log files:


2. Select a workgroup and click the Select button.

The Avid Log Viewer window opens.

3. Click the Package Remote icon on the Tool bar.

A Package Remote dialog box opens.

4. In the Directory pane, select the services for the real-time logs you want to package.

5. Set the date range from which you want packaged logs.

6. Select the location to save the packaged (zipped) file.

The Open dialog box displays.


60

7. Type a name for the packaged file and click the Open button.

The Packaging Files dialog box opens and displays the logs as they are packaged, as shown in the following example.

8. Click the Close button.

Packaged log files are stored in the specified location.

Chapter 4

Avid Interplay Health Monitor

The Avid Interplay Health Monitor is an application that allows you to view the health of your Avid system at a glance. Interplay Health Monitor displays a variety of information provided by each of the registered Avid components on your network and notifies you with a warning or critical indication if a component goes beyond its normal operating range. Different Avid services can supply custom health information tailored to their specific functionalities.

n Additional information specific to an Avid component can also appear. This information varies depending on the type of system selected.


• Starting the Interplay Health Monitor

• The Health Monitor Window

• Setting Audio Alert Preferences

4 Avid Interplay Health Monitor

62

Starting the Interplay Health MonitorTo start the Interplay Health Monitor:

1. Click the Start button and select All Programs > Avid > Interplay Framework > Avid Interplay Health Monitor.






The Avid Interplay Health Monitor window opens.

The Health Monitor Window

63


The Avid Interplay Health Monitor window has the following components:

• Status Bar

• Audio Alert Button

• Directory and Health View Panes

The following example shows a system with Normal status, the Directory pane view expanded, and a process—avidmediaindexer—selected, which populates the Health View pane. In the following example the Information sections, in the Health View pane, are not expanded.

Health View paneDirectory pane

Click to expand view

Audio Alert buttonStatus bar


64

Status Bar

The colored Status bar provides a quick color indication of the overall system health of the selected workgroup. The colors and their descriptions are contained in the following table.

Audio Alert Button

When an audio device is installed in the computer on which the Interplay Health Monitor runs, audio alert preferences can be configured to alert you of any changes in the health of your system. See “Setting Audio Alert Preferences” on page 70for more information.

When audio alerts are enabled, the Audio button located next to the Overall System Status bar appears in an active state. The button appears inactive when the system has no sound card installed or when no speakers are installed. You use this button to stop an audio alert while it is sounding.

Directory and Health View Panes

The Directory pane lists available hosts and processes while the Health View pane displays various system and health information for the selected service. Right-clicking, either tab anywhere in the Directory pane, displays a menu allowing you to expand or collapse the entire tree-view.

Status Bar Color Color Description

Green Overall System Status: Normal. All components are functioning properly; no problems reported.

Yellow Overall System Status: Warning. A warning one or more components are not functioning properly and requires attention.

Red Overall System Status: Critical. A serious or fatal error condition exists.

Audio Icon State

Active - audio alerts are enabled on this system.

Inactive - audio alerts are disabled or no sound card is present on this system.


65

Directory Pane

The Directory pane has two tabs.These tabs determine how information is displayed in the Directory pane.

The Hosts tab displays an alphabetical list of all available hosts in the selected workgroup. When you select a host and click the expand button, the list shows all of the health producing processes running on the selected host.

The following example shows a system with Critical status, the Directory pane view expanded, and a process—avidmediaindexer—selected. Selecting the process populates the Health View pane. In the example, the Information sections, shown in the Health View pane, are expanded.

Directory pane Health View pane


66

The icons used in the Directory pane are described in the following table

n Right-clicking either tab anywhere in the Directory pane displays a menu allowing you to expand or collapse the entire tree view.

Colored Status icons are used in the Directory pane to show the health of individual hosts, processes, and services.

The following illustration shows a workgroup—in a critical state—with four hosts, two of which are expanded to showing their processes. Some of the Processes are running, while others are experiencing problems.

Icon Description

Group - The selected workgroup. Clicking this icon opens the Discovery Manager window. For more information, see “Discovery Manager” on page 28.

Host - A host computer in a workgroup.

Process - A process or service running on a host in a workgroup.

Expand list - Expands the entire directory tree view

Collapse list - Collapses the entire directory tree view

Icon Color Description

Green All components are functioning properly; no problems reported.

Blue A component was discovered but is no longer responding.

Yellow A warning condition requires attention.

Red A serious or fatal error condition exists.


67

The Processes tab displays all health-producing processes currently running in the selected workgroup. When a process is selected from the directory and the list is expanded, all of the hosts running that process are displayed.

The following example shows a system—with Normal status—from the Processes tab view. A process—Avid Media Indexer—is selected in the Directory pane and is expanded to show the host computers running the Media Indexer process.


68

Health View Pane

The Health View pane is located on the right side of the Avid Interplay Health Monitor window. When the window is first opened, and nothing is selected in the directory tree, the Health View Pane is empty.

After you select an item, the Health View pane is populated with Information sections, which you can expand to display system details. The type of information displayed depends on the process that is selected.

The following example shows the Health View pane populated with Information sections.

Directory Pane Health View Pane

Audio Alert buttonStatus Bar


69

When you click the Expand button on an Information section, its details are displayed.

.

Use the scroll bar, when available, to view all of the Information sections shown in the Health View pane.

Expand Button


70

Setting Audio Alert Preferences

When an audio device is installed on the computer on which the Interplay Health Monitor runs, you can configure audio alert preferences to warn you of any changes in the health of your system.

To set the audio alert preferences:

1. Start the Avid Interplay Health Monitor.

2. Select Tools > Audio Alert Options.

The Audio Alert Preferences dialog box opens.

3. Select the appropriate options.

n If the Enable audio alerts option is deselected, there is no sound card present or working on the system and you can not select any of the options

4. (Option) Select the Use custom audio clip option, if you want to use a custom clip. The clip must be a WAV file.


When an audio alert sounds, you can manually stop it by clicking the Stop Audio Alert button, located next to the Overall System Status bar. See “Audio Alert Button” on page 64.

Chapter 5

Avid Interplay Workgroup Properties

Avid Interplay Workgroup Properties is the Avid Interplay Framework application that supports high-level configuration and control of services on a particular computer.The Interplay Workgroup Properties application allows you to set and manage workgroup services. You can also configure the physical location of the computer (reported byAvid services and applications) to remote applications.


• Starting Interplay Workgroup Properties

• Configuring and Managing Workgroup Services

• Setting the Preferred Workgroup

• Managing the Lookup Services in a Workgroup

5 Avid Interplay Workgroup Properties

72

Starting Interplay Workgroup Properties

The Interplay Workgroup Properties application contains tabs, which display information and allow for configuration of local host properties.

To start Interplay Workgroup Properties:

1. Click the Start button and select All Programs > Avid > Interplay Framework > Avid Interplay Workgroup Properties.

The Avid Interplay Workgroup Properties window opens.

When you start the Interplay Workgroup Properties application, the Services tab appears by default displaying the name of the workgroup to which this computer belongs. It also shows the status of all the Avid services running on the local computer.

The Interplay Workgroup Properties application uses colored icons (combined with text) on the Services tab to show the status of all Avid services. The icons provide fast, easy identification of the current status of an Avid service.

Configuring and Managing Workgroup Services

73

To display information about the Interplay Workgroup Properties application:

1. Start Avid Interplay Workgroup Properties. For more information, see “Starting Interplay Workgroup Properties” on page 72.

2. Click the About tab.

Information similar to that shown in the following illustration appears.


The Services tab allows you change the settings of a workgroup to which the computer belongs, view the status of all the Avid services running on the local machine, or start, stop, and restart the local Avid workgroup services.

Editing and Creating a Workgroup Name

You can change the workgroup for a computer by clicking the Edit button located on the Services tab. After the workgroup name is edited, the workgroup associated services become members of the new workgroup.


74

To edit a workgroup name:

1. Click the Edit button on the Services tab.

The Services Workgroup dialog box opens.

2. Enter the new workgroup name in the text box.


The new name now appears in the Workgroup text box, however, this change is only effective after you restart the workgroup services.

4. Click the Apply button on the Services tab.

The Restart Avid Interplay Services dialog box opens.

5. Click the Yes button to restart the workgroup’s services so that the changes take effect.

Viewing the Status of Avid Interplay Services

The Services tab of the Interplay Workgroup Properties application displays the status of all the Avid services and applications running on the local computer. You can view the status of these components and then decide to stop or start those which require such action.

n Services have a startup type configured either as automatic—meaning they start automatically when the system starts or the service is called for the first time—or as manual—meaning you must start the service manually before it can be loaded by the operating system and made available for use.

Typically, all services except the Avid Service Starter service are set to manual start. After the Avid Service Starter is manually started, it starts the other services. If a service is configured as disabled, it cannot be started automatically or manually.

When all of the Avid components are running on the local computer, the Status appears as shown in the following illustration.


75

The Interplay Workgroup Properties application uses three Status icons—visible on the Services tab—to help you to quickly determine the status of all the Avid components running on the local computer.

Status icon Advanced button

Status Icon Description

When all of the enabled Avid components are running on the local machine, a green circle with a check mark in the center is shown next to the Status text box and the sentence—All enabled services are running—is displayed.

When none of the enabled Avid components are running on the local machine a red square is shown next to the Status text box and the sentence—No services are running—is displayed.

When some of the enabled Avid components are running on the local machine a caution symbol (yellow triangle with an exclamation mark in the center) is shown next to the Status text box and the sentence—some services are enabled but not running—is displayed.


76

You can see the individual status of each component running on the local computer when you click the Advanced button on the Services tab. See “Stopping and Starting Avid Interplay Services” on page 76 for more information about the status of services.

Stopping and Starting Avid Interplay Services

The Avid Interplay Services dialog box allows you to view the individual status of each component running on the local computer. You can also use it to stop, start, enable, or disable individual or multiple Avid services running on the local computer.

To stop, start, enable, or disable Avid services:

1. Click the Advanced button on the Services tab.

The Avid Interplay Services dialog box opens.

2. Click on a service that you want to stop, start, enable, or disable.

You can select multiple rows.

n If all of the services are running, then the Restart button will display instead.

Start Type Icon Start Type Icon Tool Tip Description

Start Type Automatic

Start Type Manual

Start Type Disabled


77

3. Click the action button corresponding to the action you want to perform.

n When you disable a service, the Disable button label changes to Enable.

For more information on the status icons during the start or stop process, see “Understanding the Status Icons” on page 77.

4. Click the Exit button to close the dialog box.

Understanding the Status Icons

When you move the mouse pointer over a Status or Start Type icon, a tool tip displays a description of that particular icon.

Action buttons

Status column

Start Type columnMultiple service selected

Status Icons and Descriptions

Status Icon Status Icon Tool Tip Description

Status Active

Status Inactive

Status Stopping


78

Status Starting


Status Icon Icon Tool Tip Description

Status Active When all of the enabled Avid components are running on the local machine, a green circle with a check mark in the center is shown next to the Status text box and the sentence—All enabled services are running—is displayed.

Status Inactive When none of the enabled Avid components are running on the local machine a red square is shown next to the Status text box and the sentence—No services are running—is displayed.

Status Stopping

Status Starting

Start Type Icons and Descriptions



Start Type Manual

Start Type Disabled


Status Icon (Continued) Status Icon Tool Tip Description (Continued)


79

When a service stops:

As a service stops, the icon in the far left Status column changes to a blue down-arrow briefly. When the service is fully stopped, the icon in the Status column changes to a red square.

After all of the services are stopped, the Stopping services dialog box closes and the new status is displayed, on the Services tab, as shown in the following illustration.

Start Type Icons and Descriptions



Start Type Manual

Start Type Disabled

Status ColumnStart Type Column A service that is stopping


80

When a service starts:

As a services starts, the icon in the far left status column changes to a green up-arrow briefly. When the service is fully started, the icon in the status column changes to a green circle with a check mark in the center.

When you move the mouse cursor over an icon, a tool tip displays a description of that particular icon

After all of the services are started, the Starting services dialog box closes and the new status is displayed, on the Services tab, as shown in the following illustration.

Status column

Start Type column A service that is starting

Start Type Icon and Description



Start Type Manual

Start Type Disabled


81

Cancelling the Start or Stop Service Action

The start or stop service action request happens quickly when the action is applied to an individual service so you might not be able to cancel the request. In this case you can restart or stop the service from the Services tab or using the Service Action buttons on the Avid Interplay Services dialog box. However, multiple start or stop service action requests can sometimes be cancelled a before the process is complete.

To cancel a multiple start or stop service action request:

1. After clicking the Stop or Start Action button, the Stopping or Starting services dialog box opens, as shown in the following illustration.

2. Click the Cancel button in the dialog box.

3. An Error dialog box is displayed similar to the one shown in the following illustration.


t Click the Yes button to proceed with the cancellation request. Clicking this button overrides the previous cancellation request and allows the requested start or stop service action to finish.

t Click the No button to abort the cancellation request. The Error dialog box closes and the status on the Services tab displays a message.


82

You can click the Support Information button to view information about the error message. A Support Information dialog box opens similar to the one shown in the following illustration.

Support Information Dialog Box

The Support Information dialog box contains the following tabs:

• Summary Tab

• Message Tab

• Exception Tab

• Properties Tab

Summary Tab

The Summary tab provides all of the in-depth technical information about an action that could not be completed. thus causing an error. The Error dialog box contains a Support Information button.You can copy and paste the information shown on the Summary tab into a TXT file for saving and later use.


83

To copy support information about an error:

1. Click the Support Information button in the error message dialog box.

The Support Information dialog box opens.

2. Click the Copy button located on the Summary tab.

The support information can be pasted into a.txt file for saving and later use.


84

Message Tab

The Message tab displays information about an action that could not be completed.

To view the Message tab:



2. Click the Message tab.

The Message tab displays only the text that was shown in the error message, similar to the one shown in the following illustration.


85

Exception Tab

The Exception tab displays Java exception information about a failed action that causes an error. A Java exception happens during program execution and disrupts the program.

To view the Exception tab:



2. Click the Exception tab.

The Java exception generated by the error is displayed, similar to the one shown in the following illustration.


86

Properties Tab

The Properties tab displays the Java properties that were in effect at the time of the error.

To view the Properties tab:

1. Click the Support Information button on the error message dialog box.


2. Click the Exception tab.

The Properties tab is displayed.

Setting the Preferred Workgroup

You can define a preferred workgroup for logging in to on the Login tab. This allows you to join a preferred workgroup when logging in to a Interplay Framework application without having to enter the workgroup name during each login process. This option is desirable when a site has more than one workgroup and when users are members of more than one workgroup.

To define a preferred workgroup for log in:

1. Start Avid Interplay Workgroup Properties.

Click the Login tab.

Managing the Lookup Services in a Workgroup

87

2. Select the Automatically join the preferred workgroup option.

When you select the “Automatically join the preferred workgroup” option, you automatically join the preferred workgroup when you log in. This option is desirable when a site has only one workgroup.

3. Click the Apply button.


The Lookup tab allows you to manage specific hosts in a workgroup and the services running on them. A workgroup is a way of grouping together a set of people who are all working together. Users who are members of a specific workgroup run all of their workgroup components—all Avid services and applications—under that specific workgroup name. For instance, a manager is starting a new project and wants to create a new workgroup where all of his project members run their workgroup components under one workgroup name.


88

Adding and Removing Workgroups

To add a workgroup:

1. Click the Lookup tab.

2. Click the Add button located below the Workgroup section.

The Add Workgroup dialog box opens.

3. Type the workgroup name you want to add.


The new workgroup name appears in the Workgroup section on the Lookup tab.


89

To remove a workgroup:


2. Select the workgroup

3. Click the Remove button located below the Workgroup section.

The workgroup is removed from the Workgroup section and its services are removed from the Lookup services section.

To save the workgroup properties:


t Click the Apply button to make the change permanent.

t Click the Cancel button to restore the workgroup properties and close the Interplay Workgroup Properties application.

Adding and Removing Lookup Services

To add Lookup services to a local computer:


2. Select a workgroup to which you want to add a Lookup service.

3. Click the Add button located below the Lookup services section.

The Add Lookup Service dialog box opens.

4. Type a fully qualified hostname of the computer where you want to add the service

n A fully qualified hostname is a globally unique name that includes the domain name for the computer. For instance, your computers name is MyComputer. Many people might have named their computers MyComputer. To distinguish between your MyComputer and all the other computers named MyComputer, we use the computer’s fully qualified hostname; MyComputer.global.mycompany.com

5. Ensure the port number is 4160.


90

6. (Option) Select Expected if you want to be notified (in the Interplay Health Monitor) when this host is not running.


The Host name appears in the Lookup services section.

To change a Lookup service on a host computer:


2. Select a workgroup to which you want to add a lookup service.

3. Click the Edit button located below the Lookup services section.

The Add Lookup Service dialog box opens.

4. In the Host name text box, type a new fully qualified host name for the service.


The changes appear in the Lookup services section.

To remove a Lookup service from a host computer:


2. Select the workgroup to which your host belongs.

3. Select the host name that you want to remove.

4. Click the Remove button located below the Lookup services section.

The host is removed from the Lookup services section.


91

To save the Lookup services for this workgroup:


t Click the Apply button on the Lookup tab to make the change permanent.

t Click the Cancel button on the Lookup tab to restore the Host name and close the Interplay Workgroup Properties application.

The next time the application is opened, the Host name reappears in the Lookup services section.

Defining the Host Computer Location

The Location tab allows you to define the physical location for a particular computer in an Avid workgroup. This defined physical location can be used by other viewers to find the computer even when the computer runs on a different platform.

To add location information:

1. Select the Location tab.

2. Enter the relevant location information.


92



Conducting System Tests

The System Check tab is used to help identify issues. Domain name service (DNS) issues can sometimes be the cause of other problems in a system. This tab helps you to quickly determine whether or not a problem is caused by a DNS issue. This system check does basic DNS name-resolution tests to confirm that core networking prerequisites are met for Avid Interplay Framework to work properly on this computer.

To perform a DNS system check:

1. Click the System Check tab.

The Status displayed in the System Check Status and System Check Details sections on the status at the time the Avid Interplay Workgroup Properties application was started. In the proceeding illustration, there were no DNS problems when the application was started.

2. Click the Perform System Check button to rerun the tests.


93

The Status is updated in the System Check Status and Details sections.

If there are potential system problems, the System Check Details reflect the specific causes. The System Check Status displays an overall status message. Examples are shown in the following illustrations.


94

Chapter 6

Using the Avid Interplay Media Indexer

The Avid Interplay Media Indexer keeps track of the media files in storage locations that you identify.


• About Media Indexer

• Configuring an Avid Interplay Media Indexer

• Adding Additional Media Indexer Services to Monitor Shared Storage

• Grouping Media Indexer Services

• Monitoring Memory Usage in the Health Monitor

n For information on setting up Media Indexer in an Interplay environment, see the Avid Interplay Best Practices guide.

Chapter 6 Using the Avid Interplay Media Indexer

96

About Media Indexer

The Avid Media Indexer manages the media on local and shared storage areas in your Interplay environment. The Media Indexer actively monitors and indexes the storage areas to allow for improved performance, better sharing of media across a network, and better interaction between Avid editing systems.

In an Avid Interplay environment, each Avid editing system has its own local Media Indexer that manages the local storage areas on that system. Each Avid Interplay environment also has at least one Media Indexer that manages media on shared storage. When the Avid editing system needs to access media on shared storage, it communicates with its local Media Indexer, which then communicates with the shared storage Media Indexer.

In a large workgroup environment you can define a group of Media Indexer services that run on different servers. This allows you to spread out the indexing workload to several Media Indexer services and maintain the network performance. This also provides a backup system so that if one Media Indexer goes offline, then you can automatically connect to another Media Indexer in the group.

The Avid Interplay Framework applications and services provide the communication link between the Media Indexer services and the Avid editing applications.

Tracking Media Files on a Standalone System

Historically, Avid editing applications have used database files known as PMR files and MDB files to keep track of media files. The Avid editing application reads PMR files to determine the location of media files to load into a monitor or into the Timeline. It then uses the MDB file to provide information for the re-link function and to populate the Media tool.

Avid editing application

Avid Interplay server

Avid Unity MediaNetwork or Avid Unity ISIS storage

Local Media Indexer indexes local storage

Media Indexer on server indexes shared storage

Chain the local Media Indexer to the shared storage Media Indexer

Configuring an Avid Interplay Media Indexer

97

A standalone system is defined as an Avid editing system that is not connected to an Avid Interplay environment. Standalone systems do not require the Media Indexer. Instead, they use PMR and MDB files.

Tracking and Indexing Media Files on an Avid Editing System in an Avid Interplay Environment

The Avid Interplay Media Indexer keeps track of the media files in storage locations that you identify. When an Avid editing application is configured as part of an Avid Interplay environment, it uses the Media Indexer service to keep track of the location and status of media. Avid editing systems associate each video or audio media file with a unique metadata object called a file mob (mob = media object). The Media Indexer maintains a database that maps file mob IDs to actual storage locations. This is how it keeps track of the location and status of media.

Each Avid editing application has a local Media Indexer service must be configured correctly using the Avid Interplay Framework Service Configuration tool. You also use the Interplay Framework Service Configuration application to connect the local Media Indexer to the Avid Interplay Server a Media Indexer if you are accessing shared storage.


This section assumes that the Media Indexer software has already been installed on your system. For information on installing Media Indexer software, see Avid Interplay Software Installation and Configuration.

Each Avid editing application in an Avid Interplay environment requires the following:

• A local Media Indexer that keeps track of local files.

• A connection to a Media Indexer that indexes shared storage. You connect (chain) the local Media Indexer to the shared storage Media Indexer. You can chain the local Media Indexer services from multiple editing systems to the same shared storage Media Indexer.

n The local Media Indexer does not send information about local media files to the shared storage Media Indexer. Only the local Media Indexer sees the local files.

The Media Indexer is a support service and doesn’t have its own user interface. You use the Interplay Framework Service Configuration application to configure the Media Indexer.

Configuring a Media Indexer to Monitor Shared Storage

The following procedure describes how to set up a Media Indexer to monitor shared storage.


98

To configure the Media Indexer to monitor shared storage:

1. Identify the Media Indexer as the leader of a High Availability group.

For more information, see “Grouping Media Indexer Services” on page 117.

2. Identify the shared storage locations for that Media Indexer to monitor.

3. Click the Start button, and then select All Programs > Avid > Interplay Framework > Avid Interplay Service Configuration. See “Starting the Interplay Service Configuration Application” on page 24.

4. On the Hosts tab in the Directory pane, select the system that contains the Media Indexer you want to use to monitor shared storage.

5. Select Avid Interplay Media Indexer. The system might prompt you for the Interplay Framework administrator password (By default, there is no password). Click OK.

n By default, Interplay Framework does not require a password. When a password is used, it is set through the Interplay Workgroup Properties tool. Check with your system administrator for the correct password.

6. Click Yes, in the a message box asking if you want to allow the service to run with unrestricted security.

The system displays the Media Indexer information in the Avid Interplay Service Configuration dialog box.


99

7. Click Join High Availability Group and enter a unique name for the group.

n Perform this step even if there is only one Media Indexer for shared storage. The Media Indexer that monitors shared storage must be part of a High Availability group even if there is only one Media Indexer in the group.



100


101

The following table describes the Media Indexer sections and options in the Configuration pane.

Section Name Description

High Availability Allows you to group Media Indexer services for redundancy and load balancing. The following options are available:

• Join High Availability Group - Allows you to make this Media Indexer part of a group. Only set this option on the Media Indexer services that index shared storage.

• Group Name - Allows you to enter a name for a new group.

n When you configure a new group, you only configure storage locations on the group leader. Other members of the group monitor the me storage as the leader.

• Weight in Group - The Media Indexer with the highest priority number is the group leader. If the leader goes offline, the Interplay Framework service selects the Media Indexer in the group with the next highest priority. Higher numbers indicate higher priority. If two Media Indexer services have the same priority number, then the one that has been a member of the group the longest becomes the leader.

Periodic Save Allows you to specify the frequency at which the Media Indexer automatically saves the indexer cache. A cache that is updated periodically improves launch time. The following options are available:

• Period (min) - identifies the time between saves, in minutes.

• Maximum Files - the maximum number of file change notifications received from the file system before the system performs a periodic save.

The system performs the periodic save after one of the following occurs:

• The specified period has elapsed

• The max file changes have occurred since the last periodic save

Media Indexer services with little activity will usually save at periodic intervals. Media Indexer services with busy folders will usually index more often, depending on the value of max files.

Configure Allows you to identify the media storage locations (local storage or folders on shared storage workspaces) that this Media Indexer will index.

n Media Indexer services that index shared storage on Avid Unity MediaNetwork must be installed on fibre attached clients.


102

n For information on the Advanced Settings area, see “Monitoring Memory Usage in the Health Monitor” on page 120.

9. Click the Configure button in the Storage section of the Configuration pane.

The Configure Storage dialog box opens. The following illustration shows a Media Indexer that is already configured to monitor folders on two workspaces on an Avid Unity.

10. Click the Add button to add a storage location (workspace).

The Add Storage dialog box opens.

11. Select the Media Files Location option and click OK.

The system opens the Media Files Location dialog box.

12. Enter the Universal Naming Convention (UNC) path to a folder within the workspace. For example, \\workstation_name\workspace_name\folder_name.

The following illustration shows the UNC path for the Avid MediaFiles folder on workspace3. The storage system name in this example is avid-6c85183baf.


103

n In general, avoid connecting directly to the high level workspace name. Connect to the Avid MediaFiles folder or another folder in the workspace that you know contains valid Avid media files. This way won’t waste time indexing non-Avid files.

13. Click Apply and click OK.

The system displays the Universal Naming Convention (UNC) path to the folder in the Configure Storages dialog box.

The message “Normal” indicates that the drive has been scanned and will be indexed. The message “Normal - Scanning” indicates the Media Indexer is now scanning the storage area.

n On shared storage, you must use Universal Naming Convention (UNC) path as the Media Indexer does not recognize mapped drive letters. See “Verifying the UNC Path Name” on page 104.

14. (Option) Click Add and repeat the process to add any additional folders.

15. Click Apply then click OK to close the Configure Storages dialog box.

n The first time that you configure a storage folder, the Media Indexer automatically indexes the media in the folder. This might take a while depending on the amount of media in the folder.


104

For information on configuring the Media Indexer on an Avid editing application system to communicate with this shared storage Media Indexer, see “Configuring the Media Indexer on an Avid Editing System to Recognize Shared Storage” on page 105.

Verifying the UNC Path Name

If the Media Indexer Configure Storages dialog box displays Storage Not Found for the path name you entered, verify that you are using the correct Universal Naming Convention (UNC) path name to a folder containing Avid media files.

n The Universal Naming Convention or Uniform Naming Convention (UNC) is a computer format for specifying the location of resources on a local-area network (LAN). It's format allows each shared resource to be identified with its own unique address. The format is: \\server-name\shared-resource-pathname.

To check the name to use in the UNC path:

1. Open My Computer on the Media Indexer system.

2. Check the name of the computer and workspace in the display.

The following illustration shows the name for the computer and workspace names used in this example.

This example requires the following UNC path for the Avid MediaFiles folder on Workspace1:

Workspace and computer name for workspace1


105

\\avid-6c85183baf\Workspace1\Avid MediaFiles

Configuring the Media Indexer on an Avid Editing System to Recognize Shared Storage

Each Avid editing application in an Avid Interplay environment has a local Media Indexer that indexes local storage. You typically chain this Media Indexer to the Media Indexer that indexes your shared storage.

Your editing system uses the Media Indexer chain as follows:

1. Your Avid editing application sends a request to the local Media Indexer for media.

2. The local Media Indexer checks its index to determine whether the media is available on the local drives.

3. If the media is not available on the local drives, the local Media Indexer forwards the request to the first Media Indexer in the chain.

n The local Media Indexer uses the Avid Interplay Framework Lookup service to locate Media Indexer services in the chain.

4. If that Media Indexer doesn’t have a record of the media, the local Media Indexer forwards the request to the next Media Indexer in the chain.

An administrator can configure the Media Indexer services for the Avid editing applications on the individual system, or from any system running the Interplay Service Configuration application.

To configure the Media Indexer for an Avid editing application:

1. Click the Start button, and then select Programs > Avid > Interplay Framework > Avid Interplay Service Configuration.

2. If more than one workgroup appears in the list, click the Expand List icon next to your Workgroup name to expand the Workgroup list.

3. Locate the Avid editing system in the list and select the Avid Interplay Media Indexer service. The following illustration shows an Avid editing system named techpub8200n.


106

The system might prompt you for the Interplay Framework administrator password (By default, there is no password).

4. The system displays a message asking if you want to allow the service to run with unrestricted security.

5. Click Yes.

6. Click the Configure Storages button.


107

The Configure Storages dialog box opens.

7. Click Add.


8. Select Avid Media Indexer and click the OK button.


108

The Avid Interplay Media Indexer dialog box opens

9. Click the Connect to a High Availability Media Indexer Group option.

10. Select an indexer group from the Group Name menu.

n Ask the Avid Interplay system administrator for the name of the High Availability Group.

11. Select a mode for the connection as follows:

12. Click the Apply button, and then the OK button.

Mode Type When to use this Mode

c All Avid editing systems that are part of a load-balanced group should have their chain configured as load balanced. Otherwise load balancing won’t occur and all Media Indexer services will only communicate with the master.

Load Balancing Choose this option if you want the Media Indexer to select any Media Indexer in the group. If this Media Indexer goes offline, the system will connect to another indexer in the group. For more information, see “Using Groups to Provide Load Balancing” on page 117.

Master Only Choose this option if you want to connect to the group leader. If the group leader goes offline, the Interplay Framework service selects a new leader and connects to it.


109

The system displays the high availability group in the Configure Storage dialog box.

You can have as many Media Indexer services as you want in the Configure Storage dialog box.

n Avid recommends that you do not nest Media Indexer services within the Configure Storage dialog box because it could overly complicate the management of your Media Indexer services.

13. Click Apply and then click OK to close the Configure Storage dialog box.


110

An administrator can select the Processes tab on the Interplay Service Configuration window and configure the Media Indexer services for all the systems on the Interplay environment from that tab.

The following illustration shows the Processes tab with the Media Indexer for shared storage selected.


111

Configuring the Local Media Indexer to Index Local Drives

n For information on configuring Media Indexer to index a P2 card, see Avid Interplay Software Installation and Configuration.

To configure the local Media Indexer to index your local drives:

1. Click the Start button, and then select Programs > Avid > Interplay Framework > Avid Interplay Service Configuration.

2. If more than one workgroup appears in the list, click the Expand List icon next to your Workgroup name to expand the Workgroup list.

3. Locate the Avid editing system in the list and select the Avid Interplay Media Indexer service. The following illustration shows an Avid editing system named techpub8200n.

The system prompts you for the Interplay Framework administrator password.

n By default, Interplay Framework does not require a password. When a password is used, it is set through the Interplay Workgroup Properties tool. Check with your system administrator for the correct password.


112

4. The system displays a message asking if you want to allow the service to run with unrestricted security.

5. Click the Yes button.

6. Click Configure Storages.

The Configure Storage dialog box opens. In the following illustration you can see that this local Media Indexer is already connected to the shared storage Media Indexer.

7. Select the Media Table icon and click the Add button.



113

8. Select Media Files Location and click the OK button.

The Media Files Location dialog box opens

9. Click the Browse button.

n Unlike the UNC pathname rule for shared storages you are allowed to use the drive letters for local storage.

The Open dialog box displays.

10. Navigate to the location of your Avid MediaFiles folder. The following illustration shows the Avid MediaFiles folder on a MediaDock storage device.

Browse button.


114

11. Click the Open button.

The Media Files Location dialog box opens and displays the new location.

12. Click the Apply and then the OK buttons.

The Configure Storages dialog box opens and displays the new location.


115

13. (Option) Click the Add button to add any additional storages.

14. Click the Apply and then the OK buttons to close the Configure Storage dialog box.

15. Close the Interplay Service Configuration window.

To instruct Media Indexer to automatically recognize local drives:

1. Start the Avid editing application.

2. Click Tools > Media Creation.

The Media Creation window opens.

Local storage


116

3. On the Drive Filtering and Indexing tab, click the “Auto-index local drives as they come online” button.

4. The local Media Indexer will automatically configure Avid media files on your local drives.

5. (Option) Click Manual Storage Scan to start a scan.

6. (Option) Select one of the warning options. The warning will occur if the Media indexer has problems scanning files on the local drive.

n If you don’t want the Media indexer to automatically scan your local drives, deselect the Auto-index option.

Adding Additional Media Indexer Services to Monitor Shared Storage

An individual Media indexer is capable of indexing a specific number of files. This means that an individual Media Indexer can monitor the following:

• Multiple workspaces that do not contain more than the maximum number of files.

• Separate directory trees within one or more workspaces that do not contain more than the maximum number of files.

n See the Avid Interplay Readme for the current Media Indexer file limitations.

Grouping Media Indexer Services

117

When you have large numbers of files on shared storage, it is useful to have some Media Indexer services (known as delegates) whose only purpose is to monitor shared storage. These delegates do not handle requests from Avid editing applications and other applications that require the Media Indexer services. You set up one or more Media Indexer services in a High Availability group to monitor the delegates and process requests from the Avid editing applications.

See the Interplay Best Practices for information on configuring delegates.


You can create a group of Media Indexer services to index your shared storage. All of the members of a group communicate with each other and maintain the same information. Groups provide automatic failover systems for your Media Indexer services — if the Media Indexer you are connected to stops working, the system automatically connects you to another Media Indexer in the group.

When you create a group, you can assign a priority to each Media Indexer in the group. The Media Indexer with the highest priority is the leader. Higher numbers are higher priority.

You configure storage locations for the leader of the group. Other members of the group maintain a copy of the information contained by the leader. If you add, remove, or change the order of indexed storage locations in the leader, the other Media Indexer services reflect the change.

If the Media Indexer leader goes offline, the Media Indexer in the group with the next highest priority becomes the leader. If two Media Indexer services have the same priority number, the Media Indexer that has been a member of the group for the longest time becomes the leader.

Groups are also used to establish a failover system for the Asset Manager. This is the only way to provide a fail over system for your Media Indexer services. For more information about defining a Media Indexer group see, “Defining a Media Indexer Group” on page 118.

Using Groups to Provide Load Balancing

There are two main components that make up the Media Indexer workload:

• The Media Indexer maintains a database of all the media files in the storage spaces that it has been configured to monitor. This is referred to as the indexing portion of the workload.


118

• The shared storage Media Indexer automatically notifies the local Media Indexer services when media files change or are added to the storage areas. This is referred to as the client notification portion of the workload.

Client notification takes place when the shared storage Media Indexer notifies the local Media Indexer services that media is changed or added to the shared storage areas. You can spread out this workload as follows:

• Create a group of shared storage Media Indexer services on different servers.

• When you configure your local Media Indexer services to connect to the group, select the Load Balanced mode option, as shown in the following illustration.

When you use this option, the system connects the local media indexer to a randomly selected member of the group. When you use this option the indexing workload does not change but because each member of the shared storage group is assigned fewer local Media Indexer services, it takes less time to notify the individual clients when media changes or is added to the shared storage.

After you gain experience running the Media Indexer services on your own workgroup, you can then determine the best way to provide load balancing for your shared storage.

Defining a Media Indexer Group

To define a Media Indexer group:

1. Install the Media Indexer software on two or more systems that have access to the same shared storage.

2. Open the Avid Interplay Service Configuration application and select the system that contains the Media Indexer that will be the leader of the group.

3. Select the Media Indexer from the list of services on that system.

Load Balanced Mode


119

The following illustration shows the Avid Interplay Service Configuration window.

4. On the Avid Media Indexer tab in the High Availability section, click the Join High Availability Group check box.

5. Type a name for the group.

6. Type a high number in the Weight in Group text box to make this Media Indexer the group leader.

7. Click the Configure Storage button and assign the storage locations for this Media Indexer.

8. From the Hosts area, select the system that contains the next Media Indexer that you want to join this group.

9. Select Avid Media Indexer from the list of services on that system.

10. Click the Join High Availability Group check box and select the Group name from the menu.


120

11. (Option) Assign a priority.

12. (Option) Click the Configure Storage button.

You can view the storage locations for the lower priority members of a group but you can only modify the storage locations from the leader.

13. Perform steps 8 through 11 for the other Media Indexer services you want in this group.

Now you can connect Avid editing applications to any of the Media Indexer services in the group. See “Configuring the Local Media Indexer to Index Local Drives” on page 111.

Monitoring Memory Usage in the Health Monitor

An individual Media Indexer is capable of indexing a specific number of files. The actual number of files depends on the memory used by the Media Indexer monitoring that particular portion of shared storage. You can use the Interplay Health Monitor to track the amount of memory used by the Media Indexer and take steps to reduce the number of files that are being indexed or add additional Media Indexer services if necessary.

n See the Avid Interplay Readme for the current Media Indexer file limitations.

To check the Media Indexer memory usage:

1. Click the Start button, and then select Programs > Avid > Workgroup Framework > Avid Interplay Health Monitor.

The Health Monitor login window appears.

2. Log in and select the Avid Media Indexer service on the system running the Media Indexer.


121

3. Check the memory usage for the Media Indexer.

Each Media Indexer has a certain amount of allocated memory. When the amount of free memory available for the Media Indexer goes below 10% of that amount, the Media Indexer stops indexing files. The Media Indexer still attempts to answer requests from the Avid editing applications, but it does not index any new files.

By default, the Overall System Status color bar at the top of the Avid Interplay Health Monitor window turns yellow warning when the free memory available to the Media Indexer goes below 15%. It turns red when the free memory goes below 10%. When this happens, if you open the Avid Interplay Diagnostics application, you might see “Memory usage too high” messages displayed for this Media Indexer.

You can use the sliders on the Avid Interplay Media Indexer panel of the Avid Interplay Service Configuration application to control when the bars change color.

n The default settings are appropriate for most installations.

Media Indexer Memory Usage


122

The following illustration shows the sliders in the Avid Interplay Service Configuration dialog box.

Adjust the sliders as follows:

• Low memory threshold — controls when the color bar in the Interplay Health Monitor application turns yellow

• Critical memory threshold — controls when the color bar turns red

For instance, if you want the bars to warn you before the free memory is 20%, you can change the Low memory threshold to 20%.

If your Media Indexer reaches the critical memory threshold, an Interplay system administrator can use the following techniques to resolve the problem:

• Delete unnecessary files from the folders monitored by that Media Indexer.

• Archive files and delete online versions of media files.

• Use the Interplay Service Configuration tool to remove workspaces or folders from the Media Indexer’s Media table.

Low memory threshold slider control

Critical memory threshold slider control

Configuration pane


123

• If practical, index specific folders within a workspace.

• Divide the storage areas being indexed between multiple Media Indexer services. This involves adding additional Media Indexer servers as delegates to the High Availability Group.

See the Interplay ReadMe for additional information based on your particular Interplay release.

You can use the Heath View pane of the Avid Interplay Framework Health Monitor application to view information about the Media Indexer. The following table describes some of the values shown in the Avid Interplay Media Indexer section of the Heath View pane:

Value Description

High Availability Group

Primary of Unity means this Media Indexer has the highest priority and is the group leader.

Channels The number of sources that the media files are related to. This refers to items like source tapes, file reels, and imported files.

Media files The number of unique media files. This number may be smaller than the actual number of media files because any copies of media files are not counted in this total.

Storages The number of folders that are being monitored by this Media Indexer and any other Media Indexer services that this Media Indexer is chained to.

Table Adapter Listeners

The number of Media Indexer services that are connected to that Media Indexer


124

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

AApplication

Diagnostics 15Health Monitor 16Interplay 14Interplay Diagnostics 37Service Configuration 14Workgroup Properties 17

Audio alert preferences, Machine Monitor service 23Avid Interplay Media Indexer

configuration options 101configuring on an Avid editing system 105defining a group 118delegate 117, 123grouping 117load balancing 117

Avid Interplay Service Configurationconfiguring services & applications 32

Avid media indexer, defined 22

CCritical memory threshold 122

DDate and time, filter 44Delegate Media Indexer 117, 123Discovery Manager, lookup service 28Display, filter 43

EEmail alerter service, defined 20Exception, filter 47

FFilter

date and time 44display 43exception 47logger name 46message 47severity 45, 45

HHealth Monitor 61

window 63

IInterplay

Diagnostics 37Health Monitor 61Service Configuration 23Workgroup Properties 71

LLog View, Interplay Diagnostics 47Logger name, filter 46Lookup

service defined 19service discovery manager 28

Low memory threshold 122

MMachine Monitor

audio alert preferences 23description 28

Index

Index A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

126

monitoring level 32service 32service defined 19

Media Indexerabout Media Indexer 96configuring a P2 card 111Critical memory threshold 122in large workgroup environments 96Installing 96installing Media Indexer 97interface 97low memory threshold 122managing media files 96monitoring shared storage 97on an Avid editing system 97

Message, filter 47Multicast repeater service, defined 19

OOnline support 10Overview

Avid Configuration Management 14Avid Health Monitor 61Avid Health Viewer 16Avid Interplay Diagnostics 37Avid Interplay Workgroup Properties 71Avid Log Viewer 15Avid Workgroup Properties 17

PP2 Card

configuring Media Indexer 111Password, setting 34, 98, 111Procedures

adding a workgroup to a local computer 88adding location information 91adding Lookup services to a local computer 89canceling a service action request 81changing Log View pane information display 43configuring Avid services 33configuring for editing applications 105coping log records 58copying error support information 83defining a Media Indexer group 118defining a preferred workgroup 86

displaying process log entries 43editing a Lookup service on a local computer 90editing a workgroup name 74enabling or disabling Avid services 76indexing local drives 111opening the Discovery Manager 28overriding logging levels 57packaging remote log files 59performing a DNS System Check 92removing a workgroup from a computer 89removing Lookup service 90resizing the Log View pane 49saving log records 58setting audio alert preferences 70setting date and time criteria 44setting log filters 43setting log view column headings 49setting system configuration passwords 98, 111starting Diagnostics 38starting Health Monitor 62starting Service Configuration application 24starting Workgroup Properties 72stopping all services 79stopping or starting Avid services 76view ing Lookup service information 30viewing a local log file 54viewing information in Discovery Manager 29viewing logs 53viewing remote log files 56viewing the Exception tab 85viewing the Message tab 84viewing the Properties tab 86

SService Configuration 23

window description 25Service starter service, defined 22Setting passwords, system configuration service 34Severity, filter 45Shared storage

adding workspaces 104SNMP gateway service, defined 20Starting

Avid Health Viewer 62Avid Interplay Service Configuration 24Avid Workgroup Properties 72

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Index

127

Interplay Diagnostics 38Support service

defined 18Email Alerter 20Interplay Framework 18Lookup Service 19Machine Monitor Service 19Media Indexer Service 22Multicast Repeater 19Service Starter Service 22SNMP Gateway Service 20System Configuration Service 22Time Syncronization Service 20

System configuration service, defined 22

TTime synchronization service, defined 20Troubleshooting 10

WWindow description

Avid Health Monitor 63Avid Interplay Diagnostics 39Avid Interplay Service Configuration 25Avid Workgroup Properties 72Discovery Manager 29

Workgroup Properties 72Workspaces

shared storage 104

Index A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

128

Documents

Avid Interplay Framework User's Guideresources.avid.com/SupportFiles/attach/InterplayFramework_UG.pdfThe “Interplay” name is used with the permission of Interplay Entertainment