avid service frameworkresources.avid.com/supportfiles/attach/broadcast/asf_ug_book.pdfmanufactured...

Avid® Service FrameworkUser’s Guide

2

Legal NoticesProduct specifications are subject to change without notice and do not represent a commitment on the part of Avid Technology, Inc.

This product is subject to the terms and conditions of a software license agreement provided with the software. The product may only be used in accordance with the license agreement.

Avid products or portions thereof are protected by one or more of the following United States Patents: 5,267,351; 5,309,528; 5,355,450; 5,396,594; 5,440,348; 5,467,288; 5,513,375; 5,528,310; 5,557,423; 5,577,190; 5,584,006; 5,640,601; 5,644,364; 5,654,737; 5,724,605; 5,726,717; 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,986,584; 5,999,406; 6,038,573; 6,061,758; 6,069,668; 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; 7,081,900; RE40,107; 7,403,561; 7,433,519; 7,671,871; D352,278; D372,478; D373,778; D392,267; D392,268; D392,269; D395,291; D396,853; D398,912. Other patents are pending.

Avid products or portions thereof are protected by one or more of the following European Patents: 0506870; 0635188; 0674414; 0694243; 0752174; 0895623; 1111910; 1629675. Other patents are pending.

This document is protected under copyright law. An authorized licensee of [product name] 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 [product name]. 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 © 2010 Avid Technology, Inc. and its licensors. All rights reserved.

The following disclaimer is required by Apple Computer, Inc.:APPLE COMPUTER, 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. THE EXCLUSION OF IMPLIED WARRANTIES IS NOT PERMITTED BY SOME STATES. THE ABOVE EXCLUSION MAY NOT APPLY TO YOU. THIS WARRANTY PROVIDES YOU WITH SPECIFIC LEGAL RIGHTS. THERE MAY BE OTHER RIGHTS THAT YOU MAY HAVE WHICH VARY FROM STATE TO STATE.

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:This software is based in part on the work of the Independent JPEG Group.

This Software may contain components licensed under the following conditions:Copyright (c) 1989 The Regents of the University of California. All rights reserved.

3

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 (C) 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.

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 (c) 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 Nexidia Inc.:© 2006 Nexidia. All rights reserved.

Manufactured under license from the Georgia Tech Research Corporation, U.S.A. Patent Pending.

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.”

4

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 Ultimatte Corporation:Certain real-time compositing capabilities are provided under a license of such technology from Ultimatte Corporation and are subject to copyright protection.

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

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 LegendU.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.

Trademarks003, 192 Digital I/O, 192 I/O, 96 I/O, 96i I/O, Adrenaline, AirSpeed, ALEX, Alienbrain, AME, AniMatte, Archive, Archive II, Assistant Station, AudioPages, AudioStation, AutoLoop, AutoSync, Avid, Avid Active, Avid Advanced Response, Avid DNA, Avid DNxcel, Avid DNxHD, Avid DS Assist Station, Avid Liquid, Avid Media Engine, Avid Media Processor, Avid MEDIArray, Avid Mojo, Avid Remote Response, Avid Unity, Avid Unity ISIS, Avid VideoRAID, AvidRAID, AvidShare, AVIDstripe, AVX, Axiom, Beat Detective, Beauty Without The Bandwidth, Beyond Reality, BF Essentials, Bomb Factory, Boom, Bruno, C|24, CaptureManager, ChromaCurve, ChromaWheel, Cineractive Engine, Cineractive Player, Cineractive Viewer, Color Conductor, Command|24, Command|8, Conectiv, Control|24, Cosmonaut Voice, CountDown, d2, d3, DAE, Dazzle, Dazzle Digital Video Creator, D-Command, D-Control, Deko, DekoCast, D-Fi, D-fx, Digi 003, DigiBase, DigiDelivery, Digidesign, Digidesign Audio Engine, Digidesign Development Partners, Digidesign Intelligent Noise Reduction, Digidesign TDM Bus, DigiLink, DigiMeter, DigiPanner, DigiProNet, DigiRack, DigiSerial, DigiSnake, DigiSystem, Digital Choreography, Digital Nonlinear Accelerator, DigiTest, DigiTranslator, DigiWear, DINR, DNxchange, DPP-1, D-Show, DSP Manager, DS-StorageCalc, DV Toolkit, DVD Complete, D-Verb, Eleven, EM, Euphonix, EUCON, EveryPhase, Expander, ExpertRender, Fader Pack, Fairchild, FastBreak, Fast Track, Film Cutter, FilmScribe, Flexevent, FluidMotion, Frame Chase, FXDeko, HD Core, HD Process, HDPack, Home-to-Hollywood, HYBRID, HyperControl, HyperSPACE, HyperSPACE HDCAM, iKnowledge, Image Independence, Impact, Improv, iNEWS, iNEWS Assign, iNEWS ControlAir, Instantwrite, Instinct, Intelligent Content Management, Intelligent Digital Actor Technology, IntelliRender, Intelli-Sat, Intelli-sat Broadcasting Recording Manager, InterFX, Interplay, inTONE, Intraframe, iS Expander, ISIS, IsoSync, iS9, iS18, iS23, iS36, ISIS, IsoSync, KeyRig, KeyStudio, LaunchPad, LeaderPlus, LFX, Lightning, Link & Sync, ListSync, LKT-200, Lo-Fi, Luna, MachineControl, Magic Mask, Make Anything Hollywood, make manage move | media, Marquee, MassivePack, Massive Pack Pro, M-Audio, M-Audio Micro, Maxim, Mbox, Media Composer, MediaFlow, MediaLog, MediaMatch, MediaMix, Media Reader, Media Recorder, MEDIArray, MediaServer, MediaShare, MetaFuze, MetaSync, MicroTrack, MIDI I/O, Midiman, Mix Rack, MixLab, Moviebox, Moviestar, MultiShell, NaturalMatch, NewsCutter, NewsView, Nitris, NL3D, NLP, Nova, NRV-10 interFX, NSDOS, NSWIN, Octane, OMF, OMF Interchange, OMM, OnDVD, Open Media Framework, Open Media Management, Ozone, Ozonic, Painterly Effects, Palladium, Personal Q, PET, Pinnacle, Pinnacle DistanTV, Pinnacle GenieBox, Pinnacle HomeMusic, Pinnacle MediaSuite, Pinnacle Mobile Media, Pinnacle Scorefitter, Pinnacle Studio, Pinnacle Studio MovieBoard, Pinnacle Systems, Pinnacle VideoSpin, Podcast Factory, PowerSwap, PRE, ProControl, ProEncode, Profiler, Pro Tools LE, Pro Tools M-Powered, Pro Transfer, Pro Tools, QuickPunch, QuietDrive, Realtime Motion Synthesis, Recti-Fi, Reel Tape Delay, Reel Tape Flanger, Reel Tape Saturation, Reprise, Res Rocket Surfer, Reso, RetroLoop, Reverb One, ReVibe, Revolution, rS9, rS18, RTAS, Salesview, Sci-Fi, Scorch, Scorefitter, ScriptSync, SecureProductionEnvironment, Serv|LT, Serv|GT, Session, Shape-to-Shape, ShuttleCase, Sibelius, SIDON, SimulPlay,

http://www.apache.org/

http://jcifs.samba.org/

5

SimulRecord, Slightly Rude Compressor, Smack!, Soft SampleCell, Soft-Clip Limiter, Solaris, SoundReplacer, SPACE, SPACEShift, SpectraGraph, SpectraMatte, SteadyGlide, Streamfactory, Streamgenie, StreamRAID, Strike, Structure, Studiophile, SubCap, Sundance Digital, Sundance, SurroundScope, Symphony, SYNC HD, Synchronic, SynchroScope, SYNC I/O, Syntax, TDM FlexCable, TechFlix, Tel-Ray, Thunder, Titansync, Titan, TL Aggro, TL AutoPan, TL Drum Rehab, TL Everyphase, TL Fauxlder, TL In Tune, TL MasterMeter, TL Metro, TL Space, TL Utilities, tools for storytellers, Torq, Torq Xponent, Transfuser, Transit, TransJammer, Trigger Finger, Trillium Lane Labs, TruTouch, UnityRAID, Vari-Fi, Velvet, Video the Web Way, VideoRAID, VideoSPACE, VideoSpin, VTEM, Work-N-Play, Xdeck, X-Form, Xmon, XPAND!, Xponent, X-Session, and X-Session Pro are either registered trademarks or trademarks of Avid Technology, Inc. in the United States and/or other countries.

FootageArri — Courtesy of Arri/Fauer — John Fauer, Inc.Bell South “Anticipation” — Courtesy of Two Headed Monster — Tucker/Wayne Atlanta/GMS.Canyonlands — Courtesy of the National Park Service/Department of the Interior.Eco Challenge British Columbia — Courtesy of Eco Challenge Lifestyles, Inc., All Rights Reserved. Eco Challenge Morocco — Courtesy of Discovery Communications, Inc.It’s Shuttletime — Courtesy of BCP & Canadian Airlines. Nestlé Coffee Crisp — Courtesy of MacLaren McCann Canada. Saturn “Calvin Egg” — Courtesy of Cossette Communications. “Tigers: Tracking a Legend” — Courtesy of www.wildlifeworlds.com, Carol Amore, Executive Producer."The Big Swell" — Courtesy of Swell Pictures, Inc.Windhorse — 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.Ice Island — Courtesy of Kurtis Productions, Ltd.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.

News material provided by WFTV Television 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 Service Framework User’s Guide • 0130-30604-01 Rev A • Created 11/3/10 • This document is distributed by Avid in online (electronic) form only, and is not available for purchase in printed form.

http://www.wildlifeworlds.com

http://www.avid.com/footage

Contents

Symbols and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

If You Need Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Viewing User Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Accessing the Interplay Online Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

How to Order Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Avid Training Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 1 Avid Service Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Service Framework Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Avid Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Avid Diagnostics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Avid Health Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Avid Workgroup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Support Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Avid Lookup Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Machine Monitor Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Avid Multicast Repeater Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Avid Email Alerter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Avid SNMP Gateway Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Avid Time Synchronization Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Using the Time Synchronization Service in an Avid Interplay Environment 24

Avid System Configuration Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Avid Service Starter Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Avid Media Indexer Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Chapter 2 Avid Service Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Starting the Service Configuration Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Service Configuration Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Workgroup Services Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

8

Using Discovery Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Configuration Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Configuring Services and Application Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Chapter 3 Avid Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

Starting Avid Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

The Diagnostics Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Diagnostics Tool Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Workgroup Services Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Selecting Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48

Quick Filter Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Column Headings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Text Field Filters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Sample Unique Text Field Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Level of Severity Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Log View Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Log View Column Headings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Service Selection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Local Avid Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Avid Log Files in a Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Remote Log File Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Message Details Section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Log Levels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Log Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Packaging Remote Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Chapter 4 Avid Health Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

Starting the Avid Health Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

The Health Monitor Window. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Health Monitor Status Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Health Monitor Audio Alert Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Directory and Health View Panes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Health Monitor Workgroup Services panel . . . . . . . . . . . . . . . . . . . . . . . . . 73

Health Monitor Health View Pane. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

9

Setting Audio Alert Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

Chapter 5 Avid Workgroup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

Starting Workgroup Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Configuring and Managing Workgroup Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . 81

Editing and Creating a Workgroup Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

Viewing the Status of Avid Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Stopping and Starting Avid Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Service Status Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

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

Using the Summary Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Using the Message Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90

Using the Exception Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Using the Properties Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

Setting the Preferred Workgroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

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

Adding and Removing Workgroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Adding and Removing Lookup Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Defining the Host Computer Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Conducting System Tests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Chapter 6 Avid Workstation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

Installing the Avid Workstation Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Configuring the Avid Workstation Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104

Configuring Avid Workstation Service Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Setting Workstation Service Time Synchronization . . . . . . . . . . . . . . . . . . . . . 107

Setting Workstation Service Health Monitoring . . . . . . . . . . . . . . . . . . . . . . . . 108

Configuring Service Starter Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109

Configuring a System Check. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Chapter 7 Media Indexer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117

Media Indexer in an Interplay System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

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

Tracking and Indexing Media Files in an Avid Interplay Environment. . . . . . . . . . . 118

Configuring Media Indexer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Configuring Media Indexer to Monitor Shared Storage . . . . . . . . . . . . . . . . . . 119

10

Media Indexer Options in the Configuration Pane. . . . . . . . . . . . . . . . . . . . . . 124

Verifying the UNC Path Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

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

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

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

Grouping Media Indexer Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Using Groups to Provide Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Defining a Media Indexer Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Media Indexer Information in Health Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Media Indexing Workers Thread Pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142

Storage Activity and Storage Root . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Media Table Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145

Media Table Operations and Media Table Queries Performance . . . . . . . . . . 148

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

Resolving Memory Threshold Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153

Using This Guide

You can use your Avid Service Framework applicationsto 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 Service Framework applications.

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

n The documentation describes the features and hardware of all models. Therefore, your system might 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.

> 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.

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

(Windows), (Windows only), (Macintosh), or (Macintosh only)

This text indicates that the information applies only to the specified operating system, either Windows XP or Macintosh OS X.

12

If You Need Help

If you are having trouble using your Avid product:

1. Retry the action, carefully following the instructions given for that task in this guide. It is especially important to check each step of your workflow.

2. Check the latest information that might have become available after the documentation was published:

- If the latest information for your Avid product is provided as printed release notes, they ship with your application and are also available online.

If the latest information for your Avid product is provided as a ReadMe file, it is supplied on your Avid installation CD or DVD as a PDF document (README_product.pdf) and is also available online.

You should always check online for the most up-to-date release notes or ReadMe because the online version is updated whenever new information becomes available. To view these online versions, select ReadMe from the Help menu, or visit the Knowledge Base at http://support.avid.com.

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

4. Visit the online Knowledge Base at http://support.avid.com. 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 or join online message-board discussions.

Viewing User Documentation

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

Bold font Bold font is primarily used in task instructions to identify user interface items and keyboard sequences.

Italic font Italic font is used to emphasize certain words and to indicate variables.

Courier Bold font Courier Bold font identifies text that you type.

Ctrl+key or mouse action Press and hold the first key while you press the last key or perform the mouse action. For example, Command+Option+C or Ctrl+drag.

Symbol or Convention Meaning or Action

http://support.avid.com

http://support.avid.com

Accessing the Interplay Online Library

13

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 a 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 Service Framework User’s Guide from the list of user’s guides.

Accessing the Interplay Online Library

The Avid Interplay Online Library DVD contains all the Avid Interplay product documentation in PDF format.The Online Library includes a Master Glossary of all specialized terminology used in the documentation for Avid products.

Most Avid online libraries also include multimedia content such as feature presentations. This multimedia content is an excellent first resource for learning how to use your application or for helping you understand a particular feature or workflow.

n You need Adobe® Reader® to view the documentation online. You can download the latest version from the Adobe web site.

To access the online library from the Online Library DVD:

1. Insert the Online Library DVD into the drive.

2. Double-click the Mainmenu file.

How to Order Documentation

To order additional copies of this 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.

14

To learn about Avid's new online learning environment, Avid Learning Excellerator™ (ALEX), visit http://learn.avid.com.

For information on courses/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://learn.avid.com

http://www.avid.com/training

1 Avid Service Framework

Avid Service Framework is a common service distribution framework that 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 Service Framework consists of applications and services that provide dynamic discovery and lookup mechanisms, a scalable notification system, a centralized configuration tool, diagnostic logging for workgroup-enabled applications and services, system-3 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 Service Framework applications.

n Depending on your system, you might need to disable some of the Service Framework services to conserve memory usage. This is done using the Workgroup Properties application.For more information, see “Avid Workgroup Properties” on page 19.

This section contains the following information:

• Service Framework Applications

• Support Services


16

Service Framework ApplicationsThe Service 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 Service Configuration

• Avid Diagnostics

• Avid Health Monitor

• Avid Workgroup Properties

Avid Service Configuration

The Avid 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. 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.

Service Framework Applications

17

The Service Configuration window is divided into several sections includingthe Workgroup Services and Configuration panels.

The Workgroup Services panel lists available hosts and processes in a directory tree-style navigation list. Two tabs determine how information is displayed in the Workgroup Services panel. 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 panel displays system information that varies depending on the tab selected, Host or Processes.

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

Avid Diagnostics

Avid 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.


18

The Avid Diagnostics window is divided into several panels and sections including a Workgroup Services panel, a Quick Filter panel, Log View section and Message Details panel. By default all of the panels and sections are displayed but you can configure the application to only display specified panels for your workflow.

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

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

Avid Health Monitor

Avid Health Monitor is an application that enables you to view the health of your Avid system at a glance. The 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 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 Health Monitor window is divided into a tabbed Workgroup Services panel and a Preview panel. It also provides a Status bar that provides an at-a-glance view of the overall status of the system.

Service Framework Applications

19

The Workgroup Services panel 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 Health Monitor application, see “Avid Health Monitor” on page 69.

Avid Workgroup Properties

Avid Workgroup Properties is an application that supports high-level configuration and control of services on a particular computer. The 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 example, 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 Workgroup Properties window contains different tabs that allow you to display information, start, and stop the various Avid services.


20

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 Workgroup Properties.

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

Support Services

21

Support ServicesSome of the Avid Service Framework services are known collectively as Support services. These services are installed with the Service Framework and are viewed, monitored, and configured using the Service 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.

Avid Lookup Service

The Avid Lookup service supports other important Avid services used throughout your Avid environment. It acts as a broker or locator between services and clients and it is an important communication link between the Avid Service 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 example, if you have problems configuring a Multicast Repeater service and need to connect your systems to the Avid Service Framework.

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


22

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 Avid Service Framework and monitors the system health of the host on which it runs. 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 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 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 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 rebroadcasts the message within its own multicast domain.

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 Avid Service 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.

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

Support Services

23

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 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 Service Framework 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.

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.


24

Using the Time Synchronization Service in an Avid Interplay Environment

To implement Time Synchronization in an Interplay environment:

t 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.

t 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, the Time Synchronization slave service disables itself to keep the local clock from jumping back and forth. The Time Synchronization slave service also posts a warning, which is displayed in the Health Monitor.

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

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 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 Auto Transfer.

Support Services

25

Avid Service Starter Service

The Avid Service Starter service is responsible for starting all the other Service 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 Avid Service Framework services provide the communication link between the Media Indexer services and the Avid editing applications.

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


26

2 Avid Service Configuration

The Avid 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 Health Monitor. However, you can add or remove monitored processes to or from the Machine Monitor service using the 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 Service Configuration Application

• Service Configuration Window

• Configuring Services and Application Parameters


28

Starting the Service Configuration ApplicationTo start the Service Configuration application:

1. Click the Start button and select All Programs > Avid > Service Framework > Avid 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 Select.

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

Service Configuration Window

29

Service Configuration WindowThe Avid 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:

• Workgroup Services Panel

• Configuration Pane

Workgroup Services Panel

The Workgroup Services panel has two tabs that list available hosts or processes in a tree-style navigation list. Right-clicking on either tab anywhere in the Workgroup Services panel 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.

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.


30

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

The following table describes the icons that appear in the Workgroup Services panel.


31

The following example shows the various icons as they appear in the Workgroup Services panel. The Hosts tab is selected and one host is expanded to display the Avid processes running on that system. It also shows process information about the selected service in the Configuration pane.

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

Icon Description

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

Host - The hosts in the selected workgroup.

Expand list - Expands the list view.

Collapse list - Collapses the list view.

Primary service


32

Using Discovery Manager

The Discovery Manager allows you to see the Lookup services detected by the Service Framework application you are running, such as Service Configuration, Health Monitor, and 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 Workgroup Services panel.

The Discovery Manager window opens.

The Discovery Manager lists the lookup services that are detected by the 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.

Lookup services list Services button Refresh button


33

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.

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

t Double click the service name in the list.

Expected Lookup service columnLookup Service status column

Lookup service list


34

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 E-mail Alert Service running on the qawgsvr2 host is selected from the list on the Process tab.

Hosts on which this service is running


35

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.

The following buttons are available located above the Configuration pane:

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.


36

These buttons are enabled only after you select a service and host in the Workgroup Services panel 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 ParametersThe Avid 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 Health Monitor. For more information see “Avid Health Monitor” on page 69.

The following procedure is an example of how to use Avid 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 Service Framework system.

To configure the Avid Automatic Archive service using Service Framework:

1. On any system with the Service Configuration application installed, open the application by clicking the Start button and selecting All Programs > Avid > Service Framework > Avid Service Configuration.


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

3. Click Select.

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 Service Configuration window opens.

Configuring Services and Application Parameters

37

4. When the Avid 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 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 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 Workgroup Services panel.

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.

n By default, Service 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 Service Framework Administrator password and click OK.

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


38

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

9. Click the Service Settings tab.

Service settings for Avid services are displayed in this tab.

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.

Configuring Services and Application Parameters

39

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

11. Do one of the following

t Click Apply to apply the changes to an individual service

t Click Apply To 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 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.


40

3 Avid Diagnostics

Avid 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 Diagnostics

• The Diagnostics Window

• Quick Filter Panel

• Text Field Filters

• Logs

• Log Levels

• Log Files

3 Avid Diagnostics

42

Starting Avid DiagnosticsTo start Avid Diagnostics:

1. Click the Start button, and select All Programs > Avid Service Framework > Avid Diagnostics.





4. Click the Select button.

The Avid Diagnostics window opens.

Starting Avid Diagnostics

43

By default all of the panels and sections in the Avid Diagnostics user interface are displayed but you can configure the display of the different panels to best suit your particular workflow. Any of the panels can be docked, floated, or hidden from view while the Log View section always remains visible in the window. The following illustration shows the panels floating.

3 Avid Diagnostics

44

When the panels are floating they can be dragged to another location on the desktop, such as a different monitor, if you have more than one monitor configured.

The Diagnostics WindowAfter starting the Diagnostics application, the Avid Diagnostics window opens. By default all of the panels and sections in the Avid Diagnostics application are displayed in this window but you can configure the display of the different panels to best suit your particular workflow. This window contains the Workgroup Service panel that allows you to select the service or services from a host, or hosts. This selection results in a real-time view of the log messages for the services selected.

The Diagnostics Window

45

The Log Viewer section of the window is divided into several sections:

• Diagnostics Tool Bar

• Workgroup Services Panel

• Quick Filter Panel

• Log View Section

• Message Details Section

Diagnostics Tool Bar

The Tool bar contains icons which perform the following functions:

3 Avid Diagnostics

46

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.

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.

The Diagnostics Window

47

Workgroup Services Panel

The Workgroup Services panel has two tabs that list available hosts or processes in a tree-style navigation list (see “Selecting Processes” on page 48). Right-clicking either tab, anywhere in the workgroup Services panel, 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 Workgroup Services panel, as described in the following table.

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 Log View section. Clearing the Log View section also clears the filters in the filter columns.

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 “Using Discovery Manager” on page 32.

Host - A host PC in a workgroup.

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

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

Secondary process or service - A secondary 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.

3 Avid Diagnostics

48

Selecting Processes

When you select a process in the Workgroup Services panel, check boxes located to the left of each process are displayed. When a check box is marked, a logging listener is added to that process and the details about that particular process are logged to the Log View section in real time. You can select multiple processes from which to obtain logs. For more information, see “Log View Section” on page 53.

Two tabs determine how information is displayed in the Workgroup Services panel:

• Hosts

• Processes

The following illustration shows a workgroup with hosts and processes expanded in the Workgroup Services panel.

When one or more of the check boxes in the Workgroup Services panel are selected, information for those processes is displayed in the Log View section.

Quick Filter Panel

49

n 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.

To change information displayed for a process in the Log View section, do one of the following:

1. Right-click on any column heading to open a menu.

2. Select different column headings from the View > View Columns menu.

n You may change the order in which the column headings display by clicking and dragging them to a different location in the Log View section.

Quick Filter PanelThe Quick Filter panel contains columns, which allow you to filter the type of information displayed in the Log view section. You can choose the columns to display and select the filter criteria and logging levels. Logging levels range from low level events that do not compromise the system to those of higher importance, such as fatal errors.

3 Avid Diagnostics

50

Column Headings

You can choose the columns to display in the Quick Filter panel.

To select filter columns to display:

1. Select different filter column headings from the View > View Columns menu.

n This menu is also displayed when you right-click on any column currently shown in the Quick Filter panel.

Text Field FiltersLogs can contain large amounts of data but sometimes not as much information is needed or desired. Setting text field filters helps limit the information in the Log View section to only the information that you require. You can select filters from a drop-down list or create a unique text filter specific to your needs. For more information, see “Sample Unique Text Field Filter” on page 51.

Text Field Filters

51

To set text field filters:

1. In the Workgroup Service panel, select services that correspond to the real-time logs and the details that you want to view. For more information, see “Logs” on page 55.

2. Click the Quick Filter down arrow.

The drop-down list opens as shown in the following illustration.

By default, the filter is set to All (meaning all the columns selected for display in the Quick Filer panel), Case insensitive, and Match anywhere.

Sample Unique Text Field Filter

You can create a unique text field filter when you are looking for logs that only contain very specific text. For instance, in the following example we only want to view the logs containing the text VDC so we type in the text “VDC”.

As a result, only those log messages containing the text VDC are displayed in the Log View section, as shown in the following illustration.

3 Avid Diagnostics

52

Level of Severity Filter

The level of severity by which to filter is based on the logging level selected in Level column of the Quick Filter panel. If you want to view all severity logs, click to select All in the Level column. You can also select multiple levels by holding down the Ctrl key and clicking each level by which to filter.

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

Log View Section

53

Log View Section

The Log View section is always displayed but remains unpopulated until a host or process is selected from the Workgroup Services panel. After selections are made, details about the selected processes are displayed in the Log View section. The information displayed varies depending on how the text field filters are defined.

You can select the column headings to display in the Log View section so that you see only the information that you require.

Filter Option Selections Filter Option Descriptions

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

WARNING Shows only log records at a severity level of WARNING. WARNING indicates that something is wrong but does not affect operation of the application. For example, if some parameter is out of range, it might log it as a WARNING and then use a safe default.

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

LOG_CFG Shows only LOG_CFG records. LOG_CFG records provide a variety of static configuration information, which assist in debugging problems associated with particular configurations. For example, a LOG_CFG record might include the CPU type, the graphics depth, the GUI look and feel, and so on.

FINE Shows only log records that are of FINE level. FINE is usually used for debug level logging. These logs provide tracing information and are not of interest to most users.

FINER Shows only log records that are of FINER level. FINER level 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. FINEST is usually used for debug level logging. These logs are more verbose and detailed—not of particular interest to most users.

3 Avid Diagnostics

54


To change visible column headings:

1. Start Diagnostics.

2. Do one of the following:

t From the Menu bar select View > View Columns.

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

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

3. Select the column headings that you want to display in the Log View section.

For information about the column headings, see “Log View Column Headings” on page 54.

Log View Column Headings

The following table describes column headings available in the Log View section of the Diagnostics window.


Logs

55

LogsYou can view logs about services in the Log View section.The following topics provide more information about viewing logs:

• Service Selection

• Local Avid Log Files

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).

Time Zone The time zone to which the computer running the service or application that wrote the logs, was set.

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 “Quick Filter Panel” on page 49.

Message The message of the log entry. 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.

3 Avid Diagnostics

56

• Remote Log File Information

Service Selection

You can view log information about specific services when you select the service in the Workgroup Services panel.

To view real-time log information:





4. Click the Select button.

The Avid Diagnostics window opens.

5. Select the services for which you want to display logging details.

Logs

57

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

Local Avid Log Files

Avid Log Files are those files with a .alf file extension. Log information about local services is contained in the .alf and can be displayed in the Log View section.

To open and view a local .alf 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.

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

3 Avid Diagnostics

58

The file opens in the Log View section.

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 section.

Avid Log Files in a Folder

You can also open all.alf files contained in a folder.

To open and view all .alf files in a folder:



t Click the Open icon on the Tool bar.

t Select File > Open.

An Open dialog box opens.

Logs

59

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

All .alf files in the folder are opened and displayed in the Log View panel.

n When you are opening a larger group of files, a progress bar is displayed.

You can also open Log files in compressed in a .zip file, as shown in the following illustration.

3 Avid Diagnostics

60

Remote Log File Information

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

To open and view a remote log file:


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

The Open Remote dialog box opens.

Message Details Section

61

3. Use the Workgroup Services panel to locate the service whose log information you want to view.

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

Message Details SectionThe Message Details section the Diagnostics window displays information about the record displayed in the Log View section. There is a Basic and an Advanced tab for viewing information about the log record. By default, the text information displayed is wrapped for easier reviewing.

3 Avid Diagnostics

62

The tabs contain icons that can be used for quick, easy identification.

Basic Tab

A basic log message is displayed (in the text box area of the Basic tab) and can include the information 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 information described in the following table.

Tab Icon Tab Type

Basic

Advanced

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.

Time Zone The time zone to which the computer running the service or application that wrote the log entry, was set.

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.For more information, see “Quick Filter Panel” on page 49.


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


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

Log Levels

63

Log LevelsBy 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.

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. An exception is an event that happens during the execution of a program that interrupts the normal flow of the program’s instructions.

3 Avid Diagnostics

64

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. Select the name of the process whose logging level you want to change or click the Select All button to select all of the processes.

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

Log Files

65

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

5. Click the OK button.

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.

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

Log FilesThe 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 Workgroup Services panel, locate the service or services whose log information you want to copy.

2. Select options for each service.

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

To save log records to a file:

1. Using the Workgroup Services panel, locate the service or services that contain log information you want to save.

2. Select options for each service.

3. Click one of the Save icons on the Tool bar. See “Diagnostics Tool Bar” on page 45 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

3 Avid Diagnostics

66

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:

1. Start the Diagnostics.

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 tree, 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 in which to save the packaged (zipped) file.

The Open dialog box displays.

Log Files

67

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.

3 Avid Diagnostics

68

4 Avid Health Monitor

The Avid Health Monitor is an application that allows you to view the health of your Avid system at a glance. 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 functions. For information about Health Monitor options for the Avid Media Indexer, see “Media Indexer Information in Health Monitor” on page 141.

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


• Starting the Avid Health Monitor

• The Health Monitor Window

• Setting Audio Alert Preferences


70

Starting the Avid Health MonitorTo start the Health Monitor:

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





4. Click Select.

The Avid Health Monitor window opens.

The Health Monitor Window

71

The Health Monitor WindowThe Avid Health Monitor window has the following components:

• Health Monitor Status Bar

• Health Monitor Audio Alert Button

• Directory and Health View Panes

The following example shows a system with Normal status, the Workgroup Services panel view expanded, and a process—Avid Media Indexer—selected, which populates the Health View pane. In the following example, the Information sections in the Health View pane are not expanded.

Health Monitor 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.


72

Health Monitor Audio Alert Button

When an audio device is installed in the computer on which the 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 77 for 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 Workgroup Services panel of the Health Monitor window 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 Workgroup Services panel, displays a menu allowing you to expand or collapse the entire tree view.

See the following topics:

• Health Monitor Workgroup Services panel

• Health Monitor Health View Pane

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 that 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.


73

Health Monitor Workgroup Services panel

The Workgroup Services panel has two tabs.These tabs determine how information is displayed in the Workgroup Services panel.

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 Workgroup Services panel 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.

The icons used in the Workgroup Services panel are described in the following table.

Icon Description

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

Host - A host computer in a workgroup.


74

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

Colored Status icons are used in the Workgroup Services panel 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.

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

Primary process or service- A primary 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 (Continued) Description (Continued)

Icon Color Description

Green check mark

All components are functioning properly; no problems reported.

Blue question mark

A component was discovered but is no longer responding.

Yellow exclamation point

A warning condition requires attention.

Red X A serious or fatal error condition exists.


75

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 Workgroup Services panel and is expanded to show the host computers running the Media Indexer process.


76

Health Monitor Health View Pane

The Health View pane is located on the right side of the Avid 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.

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

Setting Audio Alert Preferences

77

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

Setting Audio Alert PreferencesWhen an audio device is installed on the computer on which the 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 Health Monitor.

2. Select Tools > Audio Alert Options.

The Audio Alert Preferences dialog box opens.


78

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.

5. Click OK.

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. For more information, see “Health Monitor Audio Alert Button” on page 72.

5 Avid Workgroup Properties

Avid Workgroup Properties is the Avid Service Framework application that supports high-level configuration and control of services on a particular computer.The 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 Workgroup Properties

• Configuring and Managing Workgroup Services

• Setting the Preferred Workgroup

• Managing the Lookup Services in a Workgroup


80

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

To start Workgroup Properties:

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

The Avid Workgroup Properties window opens.

When you start the 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 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.

To display information about the Workgroup Properties application:

1. Start Avid Workgroup Properties.

For more information, see “Starting Workgroup Properties” on page 80.

Configuring and Managing Workgroup Services

81

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.

The following topics provide more information about using the Services tab:

• Editing and Creating a Workgroup Name

• Viewing the Status of Avid Services

• Stopping and Starting Avid Services

• Cancelling the Start or Stop Service Action


82

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.

To edit a workgroup name:

1. Click the Edit button on the Services tab.

The Services Workgroup dialog box opens.

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

3. Click OK.

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


t To apply your changes and keep the Workgroup Properties window open, click the Apply button.

The Restart Avid Services dialog box opens.

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

t To apply your changes and close the Workgroup Properties window, click the OK button.


83

Viewing the Status of Avid Services

The Services tab of the 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.

The 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.


84

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 Services” on page 84 for more information about the status of services.

Stopping and Starting Avid Services

The Avid 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 Advanced on the Services tab.

The Avid Services dialog box opens.

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

You can select multiple rows.

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 a message that 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 a message that 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 a message that some services are enabled but not running is displayed.

Start Type Icon Tool Tip Description

Start Type Automatic

Start Type Manual

Start Type Disabled


85

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

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 “Service Status Icons” on page 85.

4. Click Exit to close the dialog box.

Service 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.

Status Icons

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 a message that 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 a message that no services are running is displayed.


86

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.

Status Stopping As services are in the process of stopping, this icon is displayed.

Status Starting As services are in the process of starting, this icon is displayed.

Start Type Icons

Start Type Icon Icon Tool Tip

Start Type Automatic

Start Type Manual

Start Type Disabled

Status Icons (Continued)

Status Icon Icon Tool Tip Description

Status ColumnStart Type Column A service that is stopping


87

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.

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.

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 Services dialog box. However, multiple start or stop service action requests can sometimes be cancelled a before the process is complete.

Status column

Start Type column A service that is starting


88

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 Cancel in the dialog box.

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


t Click Yes 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 No to abort the cancellation request. The Error dialog box closes and the status on the Services tab displays a message.

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.


89

The Support Information dialog box includes four tabs. For more information, see the following topics:

• Using the Summary Tab

• Using the Message Tab

• Using the Exception Tab

• Using the Properties Tab

Using the 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 text file for saving and later use.


90

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.

Using the 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.


91

Using the 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.


92

Using the 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

93

Setting the Preferred WorkgroupYou 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 Service Framework application without having to type 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 Workgroup Properties.

2. Click the Login tab.


94

3. 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.

4. Click the Apply button. This change does not require you to restart the services.

Managing the Lookup Services in a Workgroup

The Lookup tab allows you to manage specific hosts in a workgroup and the services running on them.


95

For more information about using the Lookup tab, see the following topics:

• Adding and Removing Workgroups

• Adding and Removing Lookup Services

• Defining the Host Computer Location

• Conducting System Tests

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.


96

3. Type the workgroup name you want to add.

4. Click OK.

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






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.



The Restart Avid Services dialog box opens.Click the Yes button to restart the workgroup’s services so that the changes you applied will take effect.


To save the workgroup properties, do one of the following:

t Click the Apply button on the Lookup tab and the Yes button on the Restart Avid Services dialog box to make the change permanent.


97

t Click Cancel to restore the workgroup properties and close the 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 example, your computer’s name is MyComputer. Many people might have named their computers MyComputer. To distinguish between your MyComputer and all the other computers named MyComputer, use the computer’s fully qualified hostname; MyComputer.global.mycompany.com

5. Ensure the port number is 4160.

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

7. Click OK.

The Host name appears in the Lookup services section.





98



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.

5. Click OK.

The changes appear in the Lookup services section.





99



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.






To save the Lookup services for this workgroup, do one of the following:

t Click the Apply button on the Lookup tab and the Yes button on the Restart Avid Services dialog box to make the change permanent.


100

t Click Cancel on the Lookup tab to restore the Host name and close the 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. Type the relevant location information.





101


t To apply your changes and close the Workgroup Properties window, click the OK button and

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 Service 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 is the status at the time the Avid Workgroup Properties application was started. In the following illustration, there were no DNS problems when the application was started.


102

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

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.

6 Avid Workstation Service

The Workstation Service service is part of the Avid Service Framework system and one of the Avid services in your workgroup that are known collectively as Support services. These are sometimes called Avid Controlled services and are defined as Avid services managed by the Avid Service Starter service.

This service combines the workstation relevant functions of the Avid Service Starter service, Avid Time Synchronization service, and Avid Machine Monitor service into a single service installed on a client system. The Workstation Service is mutually exclusive of these other Framework services. By installing the Avid Workstation Service instead of those services, the number of service registrations, which the Lookup service keeps track of within the system, is reduced. It also reduces the amount of memory used by the Avid Service Framework components.

The Avid Workstation Service has no direct user interface but is configured and monitored using the Avid Service Configuration, Avid Health Monitor, Avid Workgroup Properties, and Avid Diagnostics applications that are provided by your Avid Service Framework system.


• Installing the Avid Workstation Service

• Configuring the Avid Workstation Service

• Configuring Avid Workstation Service Settings

• Configuring Service Starter Options

• Configuring a System Check


104

Installing the Avid Workstation ServiceThe Workstation Service is installed on a client system in a workgroup. The installer automatically removes other Avid Service Framework services from the system.

Do not install the Workstation Service on a system running the Lookup service or Multicast Repeater.

To install the Workstation Services software:

1. Insert the Avid installer CD or DVD and browse to the following location:

Installers\wgframework\Avid_Framework_Workstation

2. Run the Setup.exe application and follow the on screen prompts.

Configuring the Avid Workstation ServiceYou can use the Avid Service Configuration application to view and configure the Avid Workstation Service.

To view the Avid Workstation Service:

1. Start the Avid Service Configuration application.

2. Select a Workgroup.

3. Click the OK button. The application window opens.


t Click the Hosts tab in the Workgroup Services panel.

Configuring the Avid Workstation Service

105

t Click the Processes tab in the Workgroup Services panel.


106

The Avid Workstation Service displays configuration information on two tabs in the Configuration pane. The Workstation Settings tab, as shown in the previous illustration, allows you to enable or disable Workstation Time Synchronization and Workstation Health Monitoring.

The Service Starter Options tab, as shown in the following illustration, of the Workstation service acts as the Avid Service Starter service for all of the Avid controlled (Framework) services on the workstation. It is used to start all the other Avid Service Framework services installed on the workstation computer when the machine is first started. It can also be configured to restart any services that are stopped unexpectedly.

Configuring Avid Workstation Service Settings

107

Configuring Avid Workstation Service SettingsThe Workstation Settings tab is used to enable or disable Workstation Time Synchronization and Workstation Health Monitoring.

Setting Workstation Service Time Synchronization

If you need your workstation to be synchronized with other machines in your workgroup you can enable Workstation Time Synchronization.

To enable the Workstation Time Synchronization option:

1. Click the Workstation Settings tab.

2. Select the Enable Workstation Time Synchronization option, as shown in the following illustration.


108

To disable the Workstation Time Synchronization option:


2. Clear the green check mark to disable the Workstation Time Synchronization option.

Setting Workstation Service Health Monitoring

If you need to view the health status of your workstation or to be alerted of a change the status you can enable Workstation Health Monitoring on your workstation.

To enable Workstation Health Monitoring:


2. Select the enable Workstation Health Monitoring option, as shown in the following illustration.

Configuring Service Starter Options

109

To Disable Workstation Health Monitoring:


2. Clear the green check mark to disable Workstation Health Monitoring option.

Configuring Service Starter OptionsThe Service Starter Options tab of the Workstation service acts as the Avid Service Starter service for all of the Avid controlled (Framework) services on the workstation. It is used to start all the other Avid Service Framework services installed on the workstation computer when the computer is first started. It can also be configured to restart any services that are stopped unexpectedly.

The upper portion of this tab contains options, which can be configured to tell the service when to start or restart the Avid controlled services.


110

To configure service starter options:

1. Start the Avid System Configuration service.


t On the Host tab, click the host in the Workgroup Services panel and select the Avid Workstation service.

t On the Process tab, click the Avid Workstation service in the Workgroup Services panel.

In the following example, the Hosts tab is selected. The default settings for the Service Starter Options and the System Check settings are shown on the Service Starter Options tab.

3. Click the Service Starter Options tab in the Configuration pane, as shown in the previous illustration.

Configuring Service Starter Options

111

4. Select the service starter options required for your services.

Service Starter Option Description

Automatically start other Avid Controlled services

Selecting this option ensures that all other Avid controlled services are started when the Avid Workstation service is started. If this option is not selected only the Avid Workstation service will be started when the workstation or Workstation Service is started.

When using this option you can also select either the Only Start controlled services once (at startup) option or the Start controlled services any time they stop unexpectedly option. You can also select the Start Controlled services after time delay option

Only Start controlled services once (at startup)

Selecting this option ensures that all Avid controlled services are started automatically one time, during workstation or Workstation Service startup. To use this setting you must first select the Automatically start other Avid Controlled services option. If for some reason one or more Avid controlled services stop they are not automatically restarted. If this option is not selected the Avid controlled services are not started at startup.

You can also select the Start Controlled services after time delay setting to use with this option. The Start controlled services any time they stop unexpectedly setting is not available when this option is selected.


112

Configuring a System CheckThe lower portion of the Service Starter Options tab is used to configure a system check for your workstation. IP Address and domain name service (DNS) issues can sometimes be the cause of problems in a system. The options on this tab allow you to check for problems that may be caused by an IP address or DNS issue. This system check does basic IP address or DNS name resolution tests to confirm that core networking prerequisites are met before the Avid controlled services are started.

To configure system check options:

1. Start the Avid Service Configuration application.


Start controlled services any time they stop unexpectedly

Selecting this option ensures that all Avid controlled services are restarted any time they stop unexpectedly. When this option is selected and any services are stopped using the Workgroup Properties application, the services remain stopped until they are manually restarted. To use this setting you must first select the Automatically start other Avid Controlled services option.

You can also select the Start Controlled services after time delay setting to use with this option. The Only Start controlled services once (at startup) setting is not available when this option is selected.

Start Controlled services after time delay Selecting this option ensures that all Avid controlled services are started after a specified time delay. The delay is set using the Seconds counter. To use this setting you must first select the Automatically start other Avid Controlled services option.

When using this option you can also select either the Only Start controlled services once (at startup) option or the Start controlled services any time they stop unexpectedly option. You can also select the Automatically start other Avid Controlled services option.

Service Starter Option Description

Configuring a System Check

113

t On the Host tab, click the host in the Workgroup Services panel and select the Avid Workstation service.

t On the Process tab, click the Avid Workstation service in the Workgroup Services panel.

In the following example, the Hosts tab is selected.


114

3. Select the select the system check service options required for your services

System Check Option Description

Check for valid IP addresses before starting controlled services

Select this option to check for valid IP addresses before starting any controlled services.

When using this option you can also select either the Start services if ANY address is valid or the Start services when ALL addresses are valid option. You can also select the Check for proper registration with DNS before starting services option.

Note that a controlled service is one that is managed by the Service Starter service or the Workstation service. In a workgroup you can see these services using the Workgroup Properties application.

Check for proper registration with DNS before starting services

Select this option to check for proper registration with DNS before starting any controlled services. before starting any controlled services.

When using this option you can also select either the Start services if ANY address is valid or the Start services when ALL addresses are valid option. You can also select the Check for valid IP addresses before starting controlled services option.

Start services if ANY address is valid Select this option to start controlled services if any IP address on the workstation is valid. A workstation could have multiple NICs, in which case it would have more than one IP address assigned to it.

This option can be used along with the Check for valid IP addresses before starting Controlled services option and the Check for proper registration with DNS before starting services option.

This option is not available when the Start services when ALL addresses are valid option is selected.

Configuring a System Check

115

Start services when ALL addresses are valid

Selecting this option starts controlled services only when all IP addresses on the workstation are valid.

This option can be used along with the Check for valid IP addresses before starting Controlled services option and the Check for proper registration with DNS before starting services option.

This option is not available when the Start services if ANY address is valid option is selected.

System Check Option Description


116

7 Media Indexer

The Media Indexer keeps track of the media files in storage locations that you identify. It 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.

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


• Tracking and Indexing Media Files in an Avid Interplay Environment

• Tracking Media Files on a Standalone System

• Adding Additional Media Indexer Services to Monitor Shared Storage

• Configuring Media Indexer

• Grouping Media Indexer Services

• Media Indexer Information in Health Monitor

• Monitoring Memory Usage in the Health Monitor

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

7 Media Indexer

118

Media Indexer in an Interplay SystemIn 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, you can automatically connect to another Media Indexer in the group.

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

Tracking Media Files on a Standalone SystemHistorically, 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 relink function and to populate the Media tool.

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 in an Avid Interplay Environment

Avid 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 (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.

Configuring Media Indexer

119

Each Avid editing application has a local Media Indexer service must be configured using the Avid Service Configuration application. You also use the Service Configuration application to connect the local Media Indexer to the Media Indexer monitoring shared storage.

Configuring Media IndexerThis section assumes that the Media Indexer software has already been installed on your system. For information on installing Media Indexer software in an Interplay environment, 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 Avid Service Configuration application to configure the Media Indexer.

The following topics provide more information about configuring the Media Indexer:

• Configuring Media Indexer to Monitor Shared Storage

• Media Indexer Options in the Configuration Pane

• Verifying the UNC Path Name

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

• Configuring the Local Media Indexer to Index Local Drives

Configuring Media Indexer to Monitor Shared Storage

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

To configure the Media Indexer to monitor shared storage:

1. Identify the Media Indexer as the leader of a High Availability Group (HAG).

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

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

7 Media Indexer

120

3. Click the Start button, and then select All Programs > Avid > Avid Service Framework > Avid Service Configuration.

For more information, see “Starting the Service Configuration Application” on page 28.

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

5. Select Avid Media Indexer.

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

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

6. Click OK.

A message box opens asking if you want to allow the service to run with unrestricted security

7. Click Yes.

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


121

8. Click Join High Availability Group and type 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 (HAG) even if there is only one Media Indexer in the group.

9. Click Apply.

For more information about other options, see “Media Indexer Options in the Configuration Pane” on page 124.

7 Media Indexer

122

10. Click Configure 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.


123

11. Click Add to add a storage location (workspace).

The Add Storage dialog box opens.

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

The Media Files Location dialog box opens.

13. Type 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.

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 you won’t waste time indexing non-Avid files.

14. Click Apply and click OK.

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

7 Media Indexer

124

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. For more information see “Verifying the UNC Path Name” on page 126.

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

16. Click Apply, and 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.

For more information about 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 127.

Media Indexer Options in the Configuration Pane

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


125

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

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 type 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 Avid Service Framework 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 usually save at periodic intervals. Media Indexer services with busy folders 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.

7 Media Indexer

126

Verifying the UNC Path Name

If the Media Indexer Configure Storages dialog box displays Storage Not Found for the path name you typed, 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). Its 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:

\\avid-6c85183baf\Workspace1\Avid MediaFiles

Workspace and computer name for workspace1


127

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.

The local Media Indexer uses the Avid Service 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 Avid Service Configuration application.

To configure the Media Indexer for an Avid editing application:

1. Click the Start button, and then select Programs > Avid > Avid Service Framework > Avid 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 Media Indexer service.

The following illustration shows an Avid editing system named techpub8200n.

7 Media Indexer

128

The system might prompt you for the Avid Service Framework administrator password (by default, there is no password).

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

4. Click Yes.

5. Click the Configure Storages button.

The Configure Storages dialog box opens.


129

6. Click Add.


7. Select Avid Media Indexerr and click OK.

The Avid Media Indexer dialog box opens

7 Media Indexer

130

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

9. Select an indexer group from the Group Name list.

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

10. Select a mode for the connection as follows:

11. Click Apply, and then click OK.

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

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 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 connects to another indexer in the group. For more information, see “Using Groups to Provide Load Balancing” on page 138.

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


131

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.

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

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.

7 Media Indexer

132

Configuring the Local Media Indexer to Index Local Drives

Each Avid editing application in an Avid Interplay environment has a local Media Indexer that indexes local drives.

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

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

1. Click the Start button, and then select Programs > Avid > Avid Service Framework > Avid 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 Media Indexer service.

The following illustration shows an Avid editing system named techpub8200n.


133

The system prompts you for the Avid Service Framework administrator password.

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

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

4. Click Yes.

5. 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 Media Indexer

134

6. Select the Media Table icon and click Add.


7. Select Media Files Location and click OK.

The Media Files Location dialog box opens

Browse button.


135

8. Click the Browse button.

The Open dialog box displays.

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

9. Navigate to the location of your Avid MediaFiles folder.

The following illustration shows the Avid MediaFiles folder on a MediaDock storage device.

10. Click Open.

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

11. Click Apply and then OK.

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

7 Media Indexer

136

12. (Option) Click Add to add any additional storages.

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

14. 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

Adding Additional Media Indexer Services to Monitor Shared Storage

137

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

The local Media Indexer automatically configures Avid media files on your local drives.

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

5. (Option) Select one of the warning options. The warning occurs 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.

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

7 Media Indexer

138

that require the Media Indexerservices. 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 Guide for more information on configuring delegates.

Grouping Media Indexer ServicesYou 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 139.

The following topics provide more information about grouping Media Indexer services:

• Using Groups to Provide Load Balancing

• Defining a Media Indexer Group

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.

Grouping Media Indexer Services

139

• The shared storage Media Indexer automatically notifies the local Media Indexerr 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 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.

The following illustration shows the Avid Service Configuration window.

Load Balanced Mode

7 Media Indexer

140

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.

11. (Option) Assign a priority.

Media Indexer Information in Health Monitor

141

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. For more information, see “Configuring the Local Media Indexer to Index Local Drives” on page 132.

Media Indexer Information in Health Monitor This section describes the Media Indexer information that is available when using the Avid Health Monitor application.

The following terms are used in this section:

• ummdworker - A Media Indexer process (ummdworker.exe). Two processes run per CPU on each system running a Media Indexer, so each machine running the Media Indexer software has two ummdworkers processes. If the system has two CPUs, there are four ummdworker processes.

• HAG - The High Availability Group (HAG) makes up the group of Media Indexers monitoring shared storage. The primary Media Indexer is the leader of the group. You configure this Media Indexer to monitor the shared storage locations. Other Media Indexers in the HAG join the group and mirror the storage locations. When a Media Indexer on an Avid editing system requests information on a media file, the request is automatically routed to one of the HAG members. Adding more HAG members increases the number of clients that can work with the HAG.

For more information on the number of clients that are supported in an Interplay environment, see the Avid Interplay ReadMe for your specific release.

• Cache files - There are two types of Media Indexer cache files. The channel*.cache files contain the media clip metadata. The ummds.cache files contain the connections to other Media Indexer and to shared and local storage locations.The cache files are stored in the following directory:

C:\Program Files\Avid\AvidMI\state

See the following topics:

• Media Indexing Workers Thread Pool

• Storage Activity and Storage Root

• Media Table Statistics

• Media Table Operations and Media Table Queries Performance

7 Media Indexer

142

Media Indexing Workers Thread Pool

The following illustration shows the Media Indexing Workers Thread Pool section displayed in Health Monitor.

The following table describes the values shown in the Media Indexing Workers Thread Pool section displayed in Health Monitor.


143

Storage Activity and Storage Root

There is a Storage Activity section and a Storage Root section for each shared storage location that the Media Indexer is monitoring. Storage locations can be folders on shared storage for Media Indexers in the HAG, or local storage areas for a Media Indexer running on an Avid editing application. The following illustration shows the Storage Activity and Storage Root sections.

Option Description

Handshake errors Counts number of handshaking errors between the Media Indexer process and the ummdworkers.

Timeout errors Number of times a ummdworker process failed to return the metadata information to the Media Indexer. This value can be a good indication of corrupted media files. If the number is rising over time, check the log files over the last 24 hours for Quarantine or Indexing error messages.

Avg. metadata extraction time Average time it takes the Media Indexer to retrieve metadata from the file.

ummdworker One-to-one relation with a ummdworker process (ummdworker.exe). Each entry indicates a media file being indexed and the time the indexing request was received.

7 Media Indexer

144

The following table describes the values shown in the Storage Activity and Storage Root sections displayed in Health Monitor.


145

Media Table Statistics

The following illustration shows the Media Table Statistics section displayed in Health Monitor.

Option Description

Storage Activity Shows the time when the last “file created” or “file deleted” notifications from the file system were received by the Media Indexer. This information is useful for debugging media offline problems. It lets you know whether the Media Indexer received the notification. For example, when a file is ingested or deleted, the corresponding entry should show the time. If it does not, there might be a problem with file notifications between the Media Indexer and Avid Unity file system.

Storage Root Shows indexing information for a given storage location. This allows you to examine the Media Indexer performance on a specific workspace.The following values are displayed:

• Indexing status

• Files found (startup scan)

• Files ignored (startup scan)

• Media Clips quarantined - represents the number of media files quarantined since the Media Indexer process last restarted.

• Pending media clips (folder scan)

• Pending media clips (updates)

7 Media Indexer

146

The following table describes the values shown in the Media Table Statistics section displayed in Health Monitor.


147

Value Description

High Availability Group

Specifies whether the Media Indexer is a member of a High Availability Group and if so, identifies the Media Indexer’s position in the group. The member with the highest priority value is the leader of the group. You set the priority in the Service Configuration tool.

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 total number of media files monitored by the Media Indexer. This number includes any copies of media files. For a breakdown by storage locations, see the Storage Root windows.

Unique Media files

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

Channel Listeners

The number of channels on which the Media Indexer could be sending notifications. There is one channel listener per source ID (source media track) used by each editor. For example, if an editor is working with a video track in the timeline that contains three clips from different sources, there are three corresponding channel listeners.

Table Adapter Listeners

The number of Media Indexer services that are connected to this Media Indexer This number should be close to the actual number of machines connected to the Media Indexer. If this number keeps growing and becomes greater than the number of clients by an order of magnitude, call Avid Technical Support and schedule a restart for the Media Indexer.

Pending channel events

Pending notification messages for new, removed, or updated media.

Pending table adapter events

Pending notifications between HAG members for media table configuration changes. These communications are sent from the primary Media Indexers to the backup Media Indexer in the HAG.

Pending server events

This option is reserved for future use.

7 Media Indexer

148

Media Table Operations and Media Table Queries Performance

The following illustration shows the Media Table Operations and Media Table Queries Performance sections as shown in Health Monitor.

The following table describes the values shown in the Media table Operations and the Media Table Queries Performance sections displayed in Health Monitor.

Free memory The amount of free memory available to this 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 color bar at the top of the Health Monitor window turns yellow when the free memory available to the Media Indexer goes below 15%. It turns red when the free memory goes below 10%. If you check the Avid Diagnostics application at this point, you might see “Memory usage too high” messages. For information on adjusting the value, see the Avid Interplay Best Practices guide.

Value Description

Option Description

Media Table Operations

Next media table commit time - The next time that the system will save the Media Indexer cache file. You set the frequency of cache saves in the Service Configuration window. A Commit Immediately button in the Service Configuration window also allows you to save the cache file immediately.

Setting the periodic save value too low can affect performance in a large Interplay environment. Set the save frequency in relation to the frequency with which you create new media. For example, if you are not frequently capturing, consolidating, or otherwise creating new media, you don’t need to set a low value for periodic saves. During a save operations there is less CPU power available to handle client requests.

n The Save time is based on the Windows Setup time on the local computer.

Media Table Queries Performance

The average values are calculated over time and should generally be under one second. This is the average value since the Media Indexer was last restarted. The value is most relevant if the Media Indexer was recently restarted.

Monitoring Memory Usage in the Health Monitor

149

Monitoring Memory Usage in the Health MonitorAn 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 Avid 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 For more information about the current Media Indexer file limitations in an Interplay environment, see the Avid Interplay Readme.

To check the Media Indexer memory usage:

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

The Health Monitor login window appears.

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

3. Check the memory usage for the Media Indexer.

7 Media Indexer

150

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 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 Diagnostics application, you might see “Memory usage too high” messages displayed for this Media Indexer.

To adjust when the color bar changes:

1. Open the Avid Service Configuration application and locate the system running the Media Indexer service.

2. Click the Avid Media Indexer service.

3. Use the sliders on the Avid Media Indexer panel to control when the bars change color.

n The default settings are appropriate for most installations.

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

Adjust the sliders as follows:

- Low memory threshold — controls when the color bar in the Avid Health Monitor application turns yellow

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

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

Monitoring Memory Usage in the Health Monitor

151

The following topic provides more information about monitoring memory usage in the Health Monitor:

• Resolving Memory Threshold Problems

Resolving Memory Threshold Problems

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 Avid Service Configuration application to remove workspaces or folders from the Media Indexer’s Media table.

• If practical, index specific folders within a workspace.

• Divide the storage areas you are indexing between multiple Media Indexer services. This involves adding additional Media Indexer servers as delegates to the High Availability Group (HAG).

For more information about Avid Media Indexer in an Interplay environment, see the Avid Interplay ReadMe for your particular version of Interplay.

7 Media Indexer

152

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

Symbols.alf

Avid log files 58opening log files 58viewing log files 58

AApplication

Avid Diagnostics 17Avid Health Monitor 18Avid Service Configuration 16Avid Workgroup Properties 19Diagnostics 41

Audio alertHealth Monitor 72preferences 27

Avid Health MonitorUI 71

Avid Media Indexerconfiguration options 125configuring on an Avid editing system 127defined 25defining a group 139delegate 137, 151

Avid Service Frameworkapplications 16overview 15Workgroup Properties 79

Avid servicescanceling a service action request 87copying error support information 89starting and stopping 84stopping and starting 85viewing status using Workgroup Properties 83

CConfiguration pane, description 34Critical memory threshold 150

DDelegate Media Indexer 137, 151Diagnostics

overview 41starting the application 42toolbar 45user interface 44window description 44workgroup services panel 47

Directory panetabs 29

Discovery Managerdescription 32Lookup service 32

DNSsystem check 101system check with Workgroup Properties 101

EEmail Alerter service, defined 23Exception tab

Workgroup Properties 91

FFilter

log information 50quick filter columns 50sample text field filter 51setting quick filters for logs 50

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

154

severity 52

GGrouping,Media Indexer 138

HHealth Monitor

audio alert 72directory pane 72health view pane 72, 76options for Media Indexer 69overview 69starting the application 70status bar 71user interface 72window description 71

Health viewdirectory pane 73

IIndexing local drives

Media Indexer 132

LLog files

copying 65packaging remote log files 65remote log files 66saving 65

Log filters 50Log Levels

overriding 63Log view

Diagnostics 53overview 53setting column headings 53

Logging levelssetting levels 63

Logslocal log information 55remote log file information 55, 60service selection 55, 56viewing local log information 57

Lookup servicediscovery manager 32managing with the Workgroup Properties

application 97Lookup service, defined 21Low memory threshold 150

MMachine Monitor

audio alert preferences 27defined 22description 31monitoring level 36support service 36

Media Indexeradding Media Indexer services to monitor shared

storage 137configuring 117, 119configuring a P2 card 132configuring for editing applications 127critical memory threshold 150defining a group 138, 139delegates 137grouping 117, 138Health Monitor information 117, 141indexing local drives 132installing 118interface 119load balancing using groups 138low memory threshold 150managing media files 118media indexing workers thread pool 142media table operations and queries 141, 148media table queries performance 148media table statistics 141, 145monitoring memory useage 117monitoring shared storage 119setting password 119, 132setting system configuration passwords 132storage activity and storage root 141, 143tracking media files on a standalone system 117,

118with an Avid editing system 118with an Interplay system 118workers thread pool 141

Message details

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

155

panel 61Message tab

Workgroup Properties 90Multicast Repeater service,defined 22

OOverview

Avid Health Monitor 18, 69Avid Log Viewer 17Avid Service Configuration application 16Avid Service Framework applications 15Avid Workgroup Properties 19

PP2 Card

configuring Media Indexer 132Panel

message details 61Password,setting 36Preferred workgroup

defining 93Procedures

adding a workgroup to a local computer 95adding location information 100adding Lookup services to a local computer 97changing Log View section information display

48configuring Avid services 36copying log records 65defining a Media Indexer group 139defining a preferred workgroup 93displaying process log entries 48editing a Lookup service on a local computer 97editing a workgroup name 82opening the Discovery Manager 32packaging remote log files 66performing a DNS System Check 101removing a workgroup from a computer 95removing Lookup service 97saving log records 65setting audio alert preferences 77setting log view column headings 53setting system configuration passwords 119starting Health Monitor 70starting Service Configuration application 28

stopping or starting Avid services 84viewing information in Discovery Manager 32viewing Lookup service information 32viewing remote log files 60viewing the Message tab 90

Properties tabWorkgroup Properties 92

QQuick filter

columns 50menu 49panel 49

RRemote log files

packaging 65

SService Configuration

configuring services & applications 36starting the application 28window description 29

Service Starter service, defined 25Setting passwords, system configuration service 36Severity, filter 52Shared storage

adding workspaces 126SNMP gateway service, defined 23Support service

defined 21Email Alerter 23Lookup service 21Machine Monitor service 22Media Indexer service 25Multicast Repeater 22Service Starter service 25SNMP Gateway service 23System Configuration service 24Time Syncronization service 23

System checkconfiguring 112

System configuration service, defined 24

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

156

TTime Synchronization service, defined 23

UUser interface

Health Monitor 72

WWindow description

Avid Service Configuration 29Workgroup Properties

about 79adding a Lookup service 97adding location information 100adding or removing a workgroup 95configuring workgroup services 79defining a preferred workgroup 93DNS system check 101editing a Lookup service 97Managing the Lookup service in a workgroup 79removing a Lookup service 97setting the preferred workgroup 79starting the application 79, 80status of Avid services 83user interface 80viewing the exception tab 91viewing the message tab 90viewing the properties tab 92

Workgroup services paneldescription 47

Workspacesshared storage 126

Workstation serviceconfiguring 103, 104configuring Health Monitor settings 107configuring service check 103configuring service starter options 103configuring Service Starter service options 109configuring settings 107configuring system check 112configuring Time Synchronization settings 107defined 103installing 103, 104

Avid75 Network DriveBurlington, MA 01803-2756 USA

Technical Support (USA)Visit the Online Support Center at www.avid.com/support

Product InformationFor company and product information, visit us on the web at www.avid.com

avid service frameworkresources.avid.com/supportfiles/attach/broadcast/asf_ug_book.pdfmanufactured...

Documents