Interplay | MAM Thesaurus Administrator User`s Guide

Interplay® | MAM
Thesaurus Administrator
User’s Guide
Version 5
Legal Notices
Product specifications are subject to change without notice and do not represent a commitment on the part of Avid
Technology, Inc.
This product is subject to the terms and conditions of a software license agreement provided with the software. The product
may only be used in accordance with the license agreement.
This product may be protected by one or more U.S. and non-U.S patents. Details are available at www.avid.com/patents.
This document is protected under copyright law. An authorized licensee of Avid Interplay | Media Asset Manager 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 Avid Interplay | MAM. 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 © 2014 Avid Technology, Inc. and its licensors. All rights reserved.
The following disclaimer is required by Apache Commons Logging:
Copyright © 2003-2013 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
The following disclaimer is required by Apache Commons Net:
Copyright © 2001-2013 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
The following disclaimer is required by Apache Jakarta Commons HttpClient:
Copyright © 2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
The following disclaimer is required by Apache log4net:
Copyright © 2004-2011 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
The following disclaimer is required by Apache Xerxes:
Copyright © 2008 Apache Software Foundation
Licensed under the Apache License, Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0)
The following disclaimer is required by Behaviour.js:
This product includes software developed by Ben Nolan and his contributors. Copyright © 2006, 2007 Ben Nolan. All rights
reserved.
The following disclaimer is required by CFlatToolbar:
Portions of this product are Copyright © 2002 Roger Onslov, all rights reserved.
The following disclaimer is required by Cross-Browser X Library:
Copyright © 2000-2009 Michael Foster, distributed under the terms of LGPL (http://cross-browser.com/license.html)
The following disclaimer is required by CSXButton:
Copyright © 1998 Michael Santoro, all rights reserved.
The following disclaimer is required by CVersionInfo:
Portions of this product are Copyright © 1997 Roberto Rocco, all rights reserved.
The following disclaimer is required by Assisted Solutions InputMask:
Portions of this product are Copyright © Data Reasearch Group. All rights reserved.
The following disclaimer is required by dicas:
Portions of this product are Copyright © dicas digital image coding GmbH. All rights reserved.
2
The following disclaimer is required by DirectShowLib:
Copyright (C) 2007 http://sourceforge.net/projects/directshownet, distributed under the terms of LGPL V2.1
(http://www.gnu.org/licenses/lgpl-2.1.html)
The following disclaimer is required by Divelements:
Portions of this product are Copyright © 2003-2011 Divelements Limited.
The following disclaimer is required by DockPanelSuite:
This product includes software developed by Mark Twombley, Steve Overton, and Weifen Luo and their contributors. Copyright
© 2009 Mark Twombley, Steve Overton, and Weifen Luo.
The following disclaimer is required by FFmpeg:
FFmpeg is Copyright © 2000-2003 Fabrice Bellard and is licensed under the terms of the GNU Lesser General Public License,
which is included with this product.
The following disclaimer is required by GDCL Sample Parser:
Copyright 2004 GDCL (http://www.gdcl.co.uk)
The following disclaimer is required by getElementsByAttribute:
Copyright © 2006 Robert Nyman (http://www.robertnyman.com)
The following disclaimer is required by GoXam:
Portions of this product are Copyright © 1995-2011 Northwoods Software. All rights reserved.
The following disclaimer is required by IC#Code #ZipLib:
Copyright © 2000-2009 Michael Foster, distributed under the terms of GNU GPL with the following exception: As a special
exception, the copyright holders of this library give you permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable
under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the
license of that module. An independent module is a module which is not derived from or based on this library. If you modify this
library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do
so, delete this exception statement from your version.
The following disclaimer is required by IFilter Text Extracter:
IFilter Text Extracter Microsoft Public License (Ms-PL)
The following disclaimer is required by ImageMagick:
Copyright 1999-2014 ImageMagick Studio LLC, a non-profit organization dedicated to making software imaging solutions
freely available. (http://www.imagemagick.org/script/license.php)
The following disclaimer is required by Interplay Central Playback Service:
This product includes FFmpeg, which is covered by the GNU Lesser General Public License.
This product includes software that is based in part of the work of the FreeType Team.
This software is based in part on the work of the Independent JPEG Group.
This product includes libjpeg-turbo, which is covered by the wxWindows Library License, Version 3.1.
Portions copyright 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002 by Cold Spring Harbor Laboratory. Funded under
Grant P41-RR02188 by the National Institutes of Health.
Portions copyright 1996, 1997, 1998, 1999, 2000, 2001, 2002 by Boutell.Com, Inc.
Portions relating to GD2 format copyright 1999, 2000, 2001, 2002 Philip Warner.
Portions relating to PNG copyright 1999, 2000, 2001, 2002 Greg Roelofs.
Portions relating to gdttf.c copyright 1999, 2000, 2001, 2002 John Ellson ([email protected]).
Portions relating to gdft.c copyright 2001, 2002 John Ellson ([email protected]).
Portions relating to JPEG and to color quantization copyright 2000, 2001, 2002, Doug Becker and copyright (C) 1994, 1995,
1996, 1997, 1998, 1999, 2000, 2001, 2002, Thomas G. Lane. This software is based in part on the work of the Independent
JPEG Group. See the file README-JPEG.TXT for more information. Portions relating to WBMP copyright 2000, 2001, 2002
Maurice Szmurlo and Johan Van den Brande.
Permission has been granted to copy, distribute and modify gd in any context without fee, including a commercial application,
provided that this notice is present in user-accessible supporting documentation.This does not affect your ownership of the
derived work itself, and the intent is to assure proper credit for the authors of gd, not to interfere with your productive use of gd.
3
If you have questions, ask. "Derived works" includes all programs that utilize the library. Credit must be given in
user-accessible documentation.This software is provided "AS IS." The copyright holders disclaim all warranties, either express
or implied, including but not limited to implied warranties of merchantability and fitness for a particular purpose, with respect to
this code and accompanying documentation.Although their code does not appear in gd, the authors wish to thank David
Koblas, David Rowley, and Hutchison Avenue Software Corporation for their prior contributions.
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 the product.
The following disclaimer is required by JavaZoom:
Portions of this product are Copyright © JavaZoom. All rights reserved.
The following disclaimer is required by JQuery:
Copyright 2013 jQuery Foundation and other contributors (http://jquery.com/)
The following disclaimer is required by JQuery Plugin Autocomplete:
Copyright (c) 2009 Jörn Zaefferer. (http://www.opensource.org/licenses/mit-license.php)
The following disclaimer is required by jquery.contextMenu:
Copyright © 2008 A Beautiful Site, LLC
The following disclaimer is required by jquery.jqDnR:
Copyright © 2007 Brice Burgess (<[email protected]>, http://www.iceburg.net)
The following disclaimer is required by Ui.dropdownchecklist:
Copyright © 2008-2010 Adrian Tosca, Copyright (c) 2010-2011 Ittrium LLC
The following disclaimer is required by jquery.json:
Copyright © 2009 Brantley Harris
The following disclaimer is required by jquery.metadata:
Copyright © 2006 John Resig, Yehuda Katz, Jörn Zaefferer, Paul McLanahan
The following disclaimer is required by jquery.jqModal:
Copyright © 2007,2008 Brice Burgess (<[email protected]>)
The following disclaimer is required by jquery.jTemplates:
Copyright © 2009 Tomasz Gloc
The following disclaimer is required by jquery.treeview:
Copyright © 2007 Jörn Zaefferer
The following disclaimer is required by jquery UI:
Copyright © 2011, Scott Gonzalez et al. (http://jqueryui.com/about)
The following disclaimer is required by JScape:
Portions of this product are Copyright © JScape. All rights reserved.
The following disclaimer is required by JScript Hashtable:
Copyright © 2003 Michael Synovic This is a Javascript implementation of the Java Hashtable object.
The following disclaimer is required by JScript Table Sorter:
Copyright ©2010 Michael Leigeber. All Rights Reserved This script has been tested in all major browsers and is available free
of charge for both personal or commercial projects under the creative commons license.
The following disclaimer is required by Libjpeg-turbo:
libjpeg-turbo is Copyright © 1998-2005 Julian Smart, Robert Roebling et al and is licensed under the terms of the wxWindows
Library Licence, Version 3.1, which is included with this product.
4
The following disclaimer is required by Limited Concurrency Task Scheduler:
Portions Copyright © Microsoft Corporation Inc. All Rights Reserved. Microsoft Limited Public License version 1.1
The following disclaimer is required by MediaLooks:
Portions of this product are Copyright MediaLooks . All rights reserved.
The following disclaimer is required by Microsoft Corporation:
Portions of this product are Copyright © Microsoft Corporation. All rights reserved.
The following disclaimer is required by Microsoft.Net Framework Base Class Libraries, BigRational:
Portions of this product are Copyright © Microsoft Corporation. All rights reserved.
The following disclaimer is required by Microsoft Prism:
Microsoft patterns & practices License; Creative Commons Attribution License 3.0 Unported
The following disclaimer is required by MOG Solutions:
Portions of this product are Copyright © MOG Solutions. All rights reserved.
The following disclaimer is required by MPEG Audio:
MPEG Audio technology may be included with this product. Audio MPEG, Inc. and S.I.SV.EL., S.P.A. require this notice: This
product contains MPEG Audio technology licensed by Audio MPEG and SISVEL only for use in accordance with Avid's EULA.
Last Updated: March 2010
The following disclaimer is required by MSTS-adapter:
Copyright © 2008 Will Ballard / Duane Fields / ExactMagic
The following disclaimer is required by MVVM Lite:
Copyright (c) 2009 - 2011 Laurent Bugnion
The following disclaimer is required by nUnit:
Copyright (c) 2004-2009 Charlie Poole
The following disclaimer is required by Obout Software:
Portions of this product are Copyright © Obout Software. All rights reserved.
The following disclaimer is required by OpenSSL:
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (http://www.openssl.org/)
The following disclaimer is required by PixieLib:
Portions of this program borrowed from PixieLib.NET, Copyright 2005 Paul DiLascia.
The following disclaimer is required by FilterCode:
Copyright © 2011 phpleo
The following disclaimer is required by PlainIt Works JeeGooContext:
Copyright © 2009 - 2010 by Erik van den Berg
The following disclaimer is required by Prototype JavaScript Framework:
Copyright © 2005-2008 Sam Stephenson
The following disclaimer is required by RabbitMQ:
Copyright © 2013 GoPivotal, Inc. All rights reserved
The following disclaimer is required by ScintillaNET:
Copyright © 1998-2006 by Neil Hodgson ([email protected]) All Rights Reserved ScintillaNET bindings are Copyright ©
2002-2006 by Garrett Serack ([email protected]) All Rights Reserved
5
The following disclaimer is required by Script.Aculo.Us Web 2.0 JavaScript:
Copyright © 2005-2008 Thomas Fuchs (http://script.aculo.us, http://mir.aculo.us)
The following disclaimer is required by Search Highlighter:
Copyright (c) 2002, 2007, 2008 Stuart Langridge ([email protected])
The following disclaimer is required by Silverlight Menu:
Microsoft Public License (Ms-PL) http://sl3menu.codeplex.com/license
The following disclaimer is required by Silverlight Serializer:
Copyright © Mike Talbot, Microsoft Public License (Ms-PL)
The following disclaimer is required by tipsy:
Copyright (c) 2008 Jason Frame ([email protected]). The software and documentation is released under the MIT
license. https://github.com/jaz303/tipsy/blob/master/LICENSE.
The following disclaimer is required by WPF Themes:
Licensed under the Microsoft Public License (Ms-PL) http://wpf.codeplex.com/license
The following disclaimer is required by WPF Toolkit:
Microsoft Public License (Ms-PL)
The following disclaimer is required by Xmlextras.js:
Copyright © 2006 Erik Arvidsson Licensed under the Apache License, Version 2.
The following disclaimer is required by XNView:
Portions of this product are Copyright © XNView. All rights reserved.
Attn. Government User(s). Restricted Rights Legend
U.S. GOVERNMENT RESTRICTED RIGHTS. This Software and its documentation are “commercial computer software” or
“commercial computer software documentation.” In the event that such Software or documentation is acquired by or on behalf
of a unit or agency of the U.S. Government, all rights with respect to this Software and documentation are subject to the terms
of the License Agreement, pursuant to FAR §12.212(a) and/or DFARS §227.7202-1(a), as applicable.
Trademarks
003, 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 Ignite, 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, Beat Detective, Beauty Without The Bandwidth, Beyond Reality, BF Essentials, Bomb Factory, Bruno, C|24,
CaptureManager, ChromaCurve, ChromaWheel, Cineractive Engine, Cineractive Player, Cineractive Viewer, Color Conductor,
Command|24, Command|8, Control|24, Cosmonaut Voice, CountDown, d2, d3, DAE, D-Command, D-Control, Deko,
DekoCast, D-Fi, D-fx, Digi 002, Digi 003, DigiBase, 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, Do More, 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,
HyperSPACE, HyperSPACE HDCAM, iKnowledge, Image Independence, Impact, Improv, iNEWS, iNEWS Assign, iNEWS
ControlAir, InGame, Instantwrite, Instinct, Intelligent Content Management, Intelligent Digital Actor Technology, IntelliRender,
Intelli-Sat, Intelli-sat Broadcasting Recording Manager, InterFX, Interplay, inTONE, Intraframe, iS Expander, iS9, iS18, iS23,
iS36, ISIS, IsoSync, LaunchPad, LeaderPlus, LFX, Lightning, Link & Sync, ListSync, LKT-200, Lo-Fi, MachineControl, Magic
Mask, Make Anything Hollywood, make manage move | media, Marquee, MassivePack, Massive Pack Pro, Maxim, Mbox,
Media Composer, MediaFlow, MediaLog, MediaMix, Media Reader, Media Recorder, MEDIArray, MediaServer, MediaShare,
MetaFuze, MetaSync, MIDI I/O, Mix Rack, Moviestar, MultiShell, NaturalMatch, NewsCutter, NewsView, NewsVision, Nitris,
NL3D, NLP, NSDOS, NSWIN, OMF, OMF Interchange, OMM, OnDVD, Open Media Framework, Open Media Management,
Painterly Effects, Palladium, Personal Q, PET, Podcast Factory, PowerSwap, PRE, ProControl, ProEncode, Profiler, Pro Tools,
Pro Tools|HD, Pro Tools LE, Pro Tools M-Powered, Pro Transfer, 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, ScriptSync, SecureProductionEnvironment, Serv|GT,
Serv|LT, Shape-to-Shape, ShuttleCase, Sibelius, SimulPlay, SimulRecord, Slightly Rude Compressor, Smack!, Soft
SampleCell, Soft-Clip Limiter, SoundReplacer, SPACE, SPACEShift, SpectraGraph, SpectraMatte, SteadyGlide,
6
Streamfactory, Streamgenie, StreamRAID, SubCap, Sundance, Sundance Digital, SurroundScope, Symphony, SYNC HD,
SYNC I/O, Synchronic, SynchroScope, Syntax, TDM FlexCable, TechFlix, Tel-Ray, Thunder, TimeLiner, 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, Transit, TransJammer, Trillium Lane Labs, TruTouch, UnityRAID, Vari-Fi, Video the Web Way,
VideoRAID, VideoSPACE, VTEM, Work-N-Play, Xdeck, X-Form, Xmon and XPAND! are either registered trademarks or
trademarks of Avid Technology, Inc. in the United States and/or other countries.
Adobe and Photoshop are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States
and/or other countries. Apple and Macintosh are trademarks of Apple Computer, Inc., registered in the U.S. and other
countries. Windows is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other
countries. All other trademarks contained herein are the property of their respective owners.
Avid Interplay | MAM Thesaurus Administrator User’s Guide • December 2014 • This document is distributed
by Avid in online (electronic) form only, and is not available for purchase in printed form.
7
Contents
Using This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Symbols and Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
If You Need Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Avid Training Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Chapter 1
Getting Started with Interplay | MAM Thesaurus Administrator . . . . . . 12
About Interplay | MAM Thesaurus Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Basic Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Prerequisites for Using Thesaurus Administrator. . . . . . . . . . . . . . . . . . . . . . . . 14
Thesaurus Administrator Operation Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
Starting Thesaurus Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Understanding the Application Layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Navigation Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
Work Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Quitting Thesaurus Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Chapter 2
Working With Thesauri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Locking and Unlocking Thesauri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
Fixing Thesauri for the Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Creating a New Thesaurus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
Localizing Thesaurus Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Exporting a Thesaurus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Importing a Thesaurus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Reloading Thesauri . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Deleting a Thesaurus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Chapter 3
Working With Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Using the Integrated Search Feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Basic Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Searching for Terms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8
Understanding the Work Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Locking and Unlocking Terms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Creating a New Term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Editing the Term Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Switching Between Tenant-Specific Term Properties . . . . . . . . . . . . . . . . . . . . 41
Localizing Term Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Entering Description and Synonyms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Defining Relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Entering Links. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Moving a Term . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Approving and Rejecting Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Deleting a Term. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Chapter 4
Working With Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Creating a New Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Switching Between Languages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Applying Language-Dependent Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Exporting Localizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Importing Localizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Deleting a Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Chapter 5
Working With Tenants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Reloading Tenants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Assigning and Unassigning Terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Displaying Tenant-Specific Term Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Defining Default Labels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Copying Thesaurus Labels Between Tenants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Removing Tenants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
9
Using This Guide
Congratulations on your purchase of Avid® Interplay® | Media Asset Manager, a powerful
system for archiving and managing media in a shared storage environment. This guide
describes how to use Avid Interplay MAM Thesaurus Administrator, the central tool for
creating and maintaining thesaurus terms.
This guide contains all the task-oriented instructions and conceptual information you need to
work with Interplay MAM Thesaurus Administrator.
Symbols and Conventions
Avid documentation uses the following symbols and conventions:
Symbol or Convention Meaning or Action
n
A note provides important related information, reminders,
recommendations, and strong suggestions.
c
A caution means that a specific action you take could cause harm to
your computer or cause you to lose data.
w
>
A warning describes an action that could cause you physical harm.
Follow the guidelines in this document or on the unit itself when
handling electrical equipment.
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.
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.
If You Need Help
If You Need Help
If you are having trouble using your Avid product:
1. Retry the action, carefully following the instructions given for that task in this guide. It
is especially important to check each step of your workflow.
2. Check the latest information that might have become available after the documentation
was published:
You should always check online for the most up-to-date documentation because the
online version is updated whenever new information becomes available. To view
these online versions, visit the Knowledge Base at www.avid.com/support.
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 www.avid.com/support. 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.
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.
For information on courses/schedules, training centers, certifications, courseware, and
books, please visit www.avid.com/support and follow the Training links, or call Avid Sales
at 800-949-AVID (800-949-2843).
11
1 Getting Started with Interplay | MAM
Thesaurus Administrator
The following topics provide basic information to help you get started using Avid Interplay
MAM Thesaurus Administrator:
•
About Interplay | MAM Thesaurus Administrator
•
Starting Thesaurus Administrator
•
Understanding the Application Layout
•
Quitting Thesaurus Administrator
About Interplay | MAM Thesaurus Administrator
This quick start guide is designed to familiarize you with the most important functions of Avid
Interplay® Media Asset Manager Thesaurus Administrator, the thesaurus maintenance tool of
Interplay® Media Asset Manager.
Basic Features
Thesaurus Administrator is an administration tool that is used to create, maintain and edit
thesauri and terms. The thesauri and terms are used for searching in Interplay MAM Desktop’s
Retrieval, and for annotation in Interplay MAM Cataloger and Desktop’s Web Cataloging. In
these applications the terms of the thesauri can be entered via Thesauri pick tools. Additionally
the Thesaurus Administrator is used to approve or reject thesaurus terms created by users in the
Thesaurus pick tools of the mentioned MAM applications.
Thesauri
The following features are available:
•
Locking and unlocking thesauri
•
Fixing thesauri for the entire platform
•
Creating thesauri manually
•
Importing thesauri
•
Creating localized labels for thesauri
About Interplay | MAM Thesaurus Administrator
•
Exporting thesauri
•
Copying the language-dependent properties of all terms of a thesaurus at the same time
•
Reloading thesauri
•
Deleting thesauri
For additional information, see “Working With Thesauri” on page 26.
Terms
The following features are available:
•
Create new terms and sub-terms
•
Edit terms (rename, localize, and add descriptions, synonyms, relations, and links)
•
Approve or reject terms created by users in a Thesaurus pick tool
•
Move terms within a thesaurus
•
Delete terms
For additional information, see “Working With Terms” on page 35.
Languages
You can create new languages, thesauri and terms, and translate existing thesauri and terms into
the languages. You can also export and import localizable elements of thesauri. For additional
information, see “Working With Languages” on page 52.
Tenants
All features of the Thesaurus Administrator are bound to certain roles: Platform Administrator
and Tenant Administrator. The Platform Administrator has complete access to and editing rights
for all thesauri, while a Tenant Administrator only has editing rights for their designated thesauri.
For additional information, see “Working With Tenants” on page 59.
13
About Interplay | MAM Thesaurus Administrator
Prerequisites for Using Thesaurus Administrator
To use the Thesaurus Administrator, you need to be a member of an administrator group that has
specific group rights. The rights required depend on your user role. As an administrator you can
review and assign these group rights in the User Manager of Interplay MAM Administrator.
Platform Administrator
To use Thesaurus Administrator as a Platform Administrator, you need the following group
rights:
•
Administration/Use_ThesaurusAdministrator: grants the right to use the Thesaurus
Administrator
•
Administration/Platform_Administration: grants the right to create, edit, delete, and approve
terms for any tenant
Tenant Administrator
To use Thesaurus Administrator as a Tenant Administrator, you need the following group rights:
•
Administration/Query_UserConfiguration: grants the right to retrieve configuration
information from User Management
•
Administration/Use_ThesaurusAdministrator: grants the right to use the Thesaurus
Administrator
•
Administration/Tenant_Administration_<Tenant-Id>: grants access to the thesauri of the
specified tenant
•
Thesaurus/Modify: grants the right to modify terms
OR
Thesaurus/Modify_<Thesaurus-Id>: grants the right to modify the terms of the specified
thesaurus
•
Thesaurus/Delete: grants the right to delete terms
14
About Interplay | MAM Thesaurus Administrator
Thesaurus Administrator Operation Modes
You can use the Thesaurus Administrator in the following operation modes:
Mode
Function
Platform Administrator
Has full access to and editing options for all thesauri of the MAM installation.
In detail, a Platform Administrator can do the following:
Tenant Administrator
(No multi-tenancy
support)
•
Sets and resets the “Fix for Platform” flag and locks and releases thesauri
for Tenant Administrators.
•
Creates, imports, exports, and deletes thesauri.
•
Adds, edits, moves, and deletes terms for any thesaurus and tenant.
•
Approves or rejects terms of all thesauri that are created by users in MAM
Cataloger’s or MAM Desktop’s thesaurus pick tools.
•
Selects tenants and displays tenant-specific and tenant-independent
properties.
•
Assigns terms to tenants and removes assignments.
•
Adds and removes languages.
Has editing capabilities for the assigned terms only. In detail, a Tenant
Administrator can do the following:
•
Displays thesauri marked as “Fix for Platform” in read-only mode.
•
Adds, edits, moves, and deletes terms for the assigned tenant.
•
Approves or rejects terms that are created by users in MAM Cataloger’s or
MAM Desktop’s thesauri pick tools for the assigned tenant.
•
Displays tenant-specific thesaurus and term properties.
If your installation does not provide multi-tenancy support, a DEFAULT tenant
is automatically created in MAM. This default tenant has Platform
Administrator rights and grants you full access to all editing options for
thesauri and terms.
15
Starting Thesaurus Administrator
Starting Thesaurus Administrator
Start Thesaurus Administrator from the Windows Start menu.
To start Thesaurus Administrator:
1. Do one of the following:
t
Select Start > All Programs > Avid > Interplay MAM > ThesaurusAdminClient.
t
Double-click the Thesaurus Administrator desktop shortcut, if available.
The Thesaurus Administrator Login dialog box opens.
2. Do one of the following:
t
To log in for the first time, adapt the <localhost> entry of the preset URL
http://localhost:9910/ControlCenter/ConfigurationService by entering the real host
name.
t
For subsequent logins, select the appropriate URL from the URL of Configuration
Service drop-down list (if there are several entered).
3. Type your login name and password.
4. Click Login.
The Thesaurus Administrator Login dialog is closed. While the Thesaurus Administrator is
starting a Please wait window is displayed.
16
Understanding the Application Layout
The Thesaurus Administrator opens and displays the thesaurus that was open when the
Thesaurus Administrator was last closed.
Understanding the Application Layout
A layout is a set of panes and controls that is installed with of the Thesaurus Administrator
application. The following illustration and table describe the main panes of the Thesaurus
Administrator.
17
Understanding the Application Layout
Item
Description
1 Menu bar
Provides the File, Thesaurus, Term, Tenant, Localization, and Help menus, and all
the options required for the creation and maintenance of thesauri and terms. For
additional information, see “Menu Bar” on page 18.
2 Toolbar
Provides the Thesaurus, Show, and Language selection lists, and the icons to lock
and create thesauri, and create, modify, delete, and approve terms. For additional
information, see “Toolbar” on page 21.
3 Navigation pane
Displays all thesauri or one thesaurus with its terms in a tree structure, depending
on your selection in the Thesaurus selection list. Provides navigation and editing
options for thesauri and terms via context menus. Additionally, it indicates the lock
and editing status of thesauri and terms using colors and symbols. For additional
information, see “Navigation Pane” on page 23.
4 Work pane
Allows you to display and edit the labels for a selected thesaurus, and to display,
enter, and edit information for a term selected in the Navigation pane. The Work
pane is organized in tabs. The details and options displayed therein vary for
thesauri and terms, and are also influenced by your usage rights. For additional
information, see “Work Pane” on page 24 and “Understanding the Work Pane” on
page 38.
Menu Bar
The following options are provided by the Thesaurus Administrator Menu bar.
File Menu
Option
Alternative
Description
Search
Ctrl+F
Opens the Search dialog to search for terms in the Navigation pane.
For additional information, see “Using the Integrated Search
Feature” on page 35.
Import Thesaurus
-
Opens the Open File dialog to import thesauri. This option is
available for Platform Administrators only. For additional
information, see “Importing a Thesaurus” on page 32.
Export Thesaurus
-
Opens the Export Thesaurus dialog to export thesauri. This option is
available for Platform Administrators only. For additional
information, see “Exporting a Thesaurus” on page 31.
Reload
Ctrl+Shift+L
Reloads all thesauri without closing the Thesaurus Administrator.
For additional information, see “Reloading Thesauri” on page 33.
18
Understanding the Application Layout
Option
Alternative
Description
Close
Alt+F4
Closes the Thesaurus Administrator. For additional information, see
“Quitting Thesaurus Administrator” on page 24.
Localization Menu
Menu
Alternative
Description
New language
Alt+N
Opens the Add new language dialog to create a new language. This
option is available for Platform Administrators only. For additional
information, see “Creating a New Language” on page 52.
Delete language
-
Opens the Delete language dialog which you can use to delete a
language. This option is available for Platform Administrators only.
For additional information, see “Deleting a Language” on page 57.
Export
-
Exports the localizable elements of selected thesauri and saves them
in an XML file. For additional information, see “Exporting
Localizations” on page 55.
Import
-
Import previously exported thesaurus localizations. For additional
information, see “Importing Localizations” on page 57.
Thesaurus Menu
Menu
Alternative
Description
Lock Thesaurus
Ctrl+L
Locks the thesaurus selected in the Navigation pane and enables its
terms for editing. For additional information, see “Locking and
Unlocking Thesauri” on page 26.
Unlock Thesaurus Ctrl+U
Removes the lock from a thesaurus and sets all terms back to
read-only mode.
New Thesaurus
Ctrl+N
Opens the New Thesaurus dialog to create a new thesaurus. This
option is available for Platform Administrators only. For additional
information, see “Creating a New Thesaurus” on page 28.
Delete Thesaurus
-
Deletes the selected thesaurus. This option is available for Platform
Administrators only. For additional information, see “Deleting a
Thesaurus” on page 34.
19
Understanding the Application Layout
Menu
Alternative
Description
Copy Thesaurus
Entries
-
Opens the Copy Language to Tenant dialog to copy the labels of a
thesaurus’s terms and paste them to the thesaurus of another tenant.
This option is available for Platform Administrators only. For
additional information, see “Copying Thesaurus Labels Between
Tenants” on page 64.
Term Menu
Option
Alternative
Description
New Term
Ctrl+Shift+N
Inserts a new term in the selected thesaurus. For additional
information, see “Creating a New Term” on page 40.
Delete Term
-
Deletes the selected term. For additional information, see
“Deleting a Term” on page 50.
Cut Term
Ctrl+Shift+X
Cuts the term selected in the Navigation pane from its
current position. For additional information, see “Moving a
Term” on page 46.
Paste Term
Ctrl+Shift+V
Pastes a cut term at the current position (into a thesaurus if
a thesaurus is selected in the Navigation pane, or as a
sub-term if a term is selected in the Navigation pane).
Previous Term
Ctrl+Shift+ArrowUp
Highlights the previous term that needs approval in the tree
structure of the Navigation pane.
Next Term
Ctrl+Shift+ArrowDown
Highlights the next term that needs approval in the tree
structure of the Navigation pane.
Approve Term
Ctrl+Shift+A
Removes the “unapproved” flag from the term and makes
it an approved term that can be used by all users. For
additional information, see “Approving and Rejecting
Terms” on page 48.
Reject Term
Ctrl+Shift+R
Removes the term from the thesaurus.
Show Approval
Info
Shows and hides approval information (creation and
approval dates, creator’s and approver’s names) as header
of the Work pane.
20
Understanding the Application Layout
Tenant Menu
Option
Alternative Description
Remove Tenant -
Removes the tenant and all related information from all terms of all
thesauri. This option does not remove the tenant from User Management.
This option is available for Platform Administrators only. For additional
information, see “Removing Tenants” on page 66.
Reload Tenants -
Reloads the tenant configuration from User Management and updates the
list of available tenants. This option is available for Platform
Administrators only. For additional information, see “Reloading
Tenants” on page 59.
Help Menu
Option
Alternative
Description
Contents
F1
Opens Interplay MAM Thesaurus Administrator help.
About
Ctrl+I
Provides the application release number and license information.
Toolbar
The following options are provided by the Thesaurus Administrator toolbar.
Control
Description
Applies a thesaurus-dependent filter on the Navigation pane. The
selection list offers all available thesauri. When you select a thesaurus
from the selection list, the thesaurus opens in the Navigation pane and
shows the terms for the tenant selected in the Show selection list, and
shows the language selected in the Language selection list.
Applies a tenant-dependent filter on the Navigation pane.
For Platform Administrators: Displays the names of all tenants with an
"All Tenants" option. When you select "(all)," the Navigation pane
displays the labels (default labels) for all terms specified in the Thesaurus
selection list, in the language chosen from the Language selection list. If a
term has no default label its TermID is displayed.
For Tenant Administrators: Only shows the tenant for which you are
administrator. The list is read-only and does not provide a list from which
to select a different tenant.
21
Understanding the Application Layout
Control
Description
Applies a language-dependent filter on the Navigation pane. The selection
list offers all available languages. When you select a language from the
selection list the localized labels of the terms opened in the Navigation
pane are shown. For additional information, see “Switching Between
Languages” on page 54.
Lock Thesaurus: Locks the thesaurus selected in the Navigation pane and
enables its terms for editing.
Unlock Thesaurus: Removes the lock from a thesaurus and sets all terms
back to read-only mode.
For additional information, see “Locking and Unlocking Thesauri” on
page 26.
New Thesaurus: Opens the New thesaurus dialog to create a new
thesaurus. For additional information, see “Creating a New Thesaurus” on
page 28.
New term: Adds a new term to the selected thesaurus. For additional
information, see “Creating a New Term” on page 40.
Cut term: Cuts the term selected in the Navigation pane from its current
position. For additional information, see “Moving a Term” on page 46.
Paste term: Pastes a cut term at the current position (into a thesaurus if a
thesaurus is selected in the Navigation pane, or as a sub-term if a term is
selected in the Navigation pane).
Navigate to Previous: Highlights the previous term that needs approval in
the tree structure of the Navigation pane.
Navigate to Next: Highlights the next term that needs approval in the tree
structure of the Navigation pane.
Approve Term: Removes the “unapproved” flag from the term and makes
it an approved term that can be used by all users. For additional
information, see “Approving and Rejecting Terms” on page 48.
Reject Term: Removes the term from the thesaurus.
Indicates how many terms need to be approved.
22
Understanding the Application Layout
Control
Description
Toggle Approval Info Display: Shows and hides approval information
(creation and approval dates, and creator’s and approver’s names) as
header of the Work pane. If the Approval Info Display cannot be
displayed, the Approval Tracking is disabled in the Thesaurus services
configuration profile.
Navigation Pane
The Navigation pane displays thesauri, terms and sub-terms in a tree structure. The display in the
Navigation pane is subject to a threefold filter mechanism: it is influenced by the options you
select from the toolbar’s Thesaurus, Show, and Languages selection lists.
The Navigation pane’s tree is modelled on the standard Windows Explorer tree structure.
Item
Description
Clicking the plus symbol expands the thesaurus or term in the Navigation pane to
show all terms or sub-terms.
Clicking the minus symbol collapses an opened thesaurus or term.
Clicking a thesaurus or term name opens the thesaurus or term in the Work pane.
Clicking the name does not expand the thesaurus or term in the Navigation pane, so
the terms or sub-terms are not displayed.
Double-clicking a thesaurus or term name expands the thesaurus or term in the
Navigation pane and Work pane.
To edit thesauri and terms, select them in the Navigation pane. The font color indicates whether
they can be edited or not.
Color
Description
Black font indicates the thesaurus is not locked and cannot be edited until you lock it.
Green font indicates the thesaurus is locked by you and can be edited by you
exclusively.
Red font indicates the thesaurus is locked by another user and cannot be edited by
you.
Icons in the Navigation pane indicate if a thesauri or term requires action.
23
Quitting Thesaurus Administrator
Icon
Description
Indicates the thesaurus contains at least one term that was created by a pick tool of
MAM Cataloger or MAM Desktop, and it requires approval. Within the thesaurus,
the question mark indicates the specific terms that require approval. For additional
information, see “Approving and Rejecting Terms” on page 48.
Platform Administrators only: Indicates the thesaurus contains at least one term that
is not assigned to a tenant. Within the thesaurus, the warning symbol indicates the
specific term that requires tenant assignment. Warning symbols are only displayed
when you select the "all" option from the toolbar’s Show selection list. For additional
information, see “Assigning and Unassigning Terms” on page 60.
Work Pane
You can display and edit the labels and translations for a selected thesaurus and display, enter,
and edit information for the term or sub-term selected in the Navigation pane. The work area is
organized in tabs as described in the following table.
Tab
Description
A tab is displayed for each thesaurus. It contains an overview table with the name of
the thesaurus in all possible languages. The Fix for Platform check box is displayed,
which allows Platform Administrators to set or remove the platform flag. For
additional information, see “Fixing Thesauri for the Platform” on page 27 and
“Localizing Thesaurus Names” on page 30.
Terms are displayed with a separate tab for each language. All tabs for terms show
the same structure. If a thesaurus and its terms are not locked for editing, the boxes
inside the tabs are displayed in read-only mode. As soon as a thesaurus is locked,
the boxes in the tabs are activated for editing. For additional information, see
“Localizing Term Name” on page 42, “Entering Description and Synonyms” on
page 43 and “Entering Links” on page 45.
Quitting Thesaurus Administrator
When you are finished using Thesaurus Administrator, quit the application.
To quit Thesaurus Administrator:
1. Do one of the following:
t
Select File > Exit.
t
Press Alt+F4.
24
Quitting Thesaurus Administrator
t
Click the X symbol in the title bar.
The Close prompt opens.
2. Do one of the following:
n
t
Click Yes if you want to quit Thesaurus Administrator.
t
Click No if you want to continue working with Thesaurus Administrator.
Locks that you have set on thesauri are automatically removed when you quit Thesaurus
Administrator.
25
2 Working With Thesauri
Interplay MAM provides a set of thesauri that are available after initial system setup. All thesauri
can be adapted to your needs except “State Machine.”
c
The thesaurus “State Machine” is required to run Interplay | MAM business process
features. Avid strongly recommends that you do not edit or delete this thesaurus. If you do,
you will not be able to create or run processes.
This documentation uses a sample thesaurus “ISO3166-1 Country Codes” for all illustrations.
The following topics provide information about the basic options you have when working with
thesauri:
•
Locking and Unlocking Thesauri
•
Fixing Thesauri for the Platform
•
Creating a New Thesaurus
•
Localizing Thesaurus Names
•
Importing a Thesaurus
•
Exporting a Thesaurus
•
Reloading Thesauri
•
Deleting a Thesaurus
Locking and Unlocking Thesauri
Changes to thesauri directly impact the database, so only one user can edit a thesaurus at a time.
To prevent simultaneous access to a thesaurus by several users, a thesaurus is locked before it can
be edited. You receive a corresponding message if you try to edit a thesaurus before locking it.
For security reasons, you can only edit or unlock a thesaurus that was locked by you, not a
thesaurus that was locked by another user.
To lock a thesaurus:
1. (Option, Platform Administrator only) From the Show selection list, select the tenant from
which you want to display terms in the Navigation pane.
2. Do one of the following:
Fixing Thesauri for the Platform
t
From the toolbar’s Thesaurus selection list, select “(all)” to display all thesauri in the
Navigation pane.
t
From the toolbar’s Thesaurus selection list, select the thesaurus to be displayed in the
Navigation pane.
3. Click the thesaurus name in the Navigation pane.
The thesaurus is highlighted in the Navigation pane. A Thesaurus tab with an overview of
the thesaurus in all available languages opens in the Work pane.
4. Do one of the following:
t
Click the Lock thesaurus icon in the toolbar.
t
Select Thesaurus > Lock thesaurus.
t
Press Ctrl+L.
t
Open the context menu for the thesaurus and select the Lock thesaurus option.
The thesaurus is locked. The thesaurus, terms, and sub-terms are displayed in green font in
the Navigation pane. All input fields are set to edit mode in the Work pane.
To unlock a thesaurus:
1. In the Navigation pane, click a thesaurus or term that is displayed in green font.
2. Do one of the following:
t
Click the Unlock thesaurus icon in the toolbar.
t
Select Thesaurus > Unlock thesaurus.
t
Open the context menu for the thesaurus and select the Unlock thesaurus option.
The thesaurus is unlocked. The thesaurus, terms and sub-terms are displayed in black font in
the Navigation pane. All input fields are grayed out in the Work pane, indicating the
thesaurus is in read-only mode.
n
Locks that you have set on thesauri are automatically removed when you quit Thesaurus
Administrator.
Fixing Thesauri for the Platform
Platform Administrators can apply a Fix for Platform flag to a thesaurus. This prevents the
thesaurus from being edited by any Tenant Administrator in Thesaurus Administrator or any
privileged user in Interplay MAM Desktop’s Thesaurus pick tool. As long as the flag is set, the
thesaurus can only be accessed in read-only mode. Tenant Administrators cannot apply or
remove the Fix for Platform flag from any thesaurus.
27
Creating a New Thesaurus
To fix a thesaurus for the platform:
1. Select the thesaurus in the Navigation pane.
2. Lock the thesaurus.
3. Check the Fix for Platform check box in the Work pane.
4. Unlock the thesaurus.
The thesaurus is fixed and cannot be edited until a Platform Administrator removes the Fix
for Platform flag. All Tenant Administrators have read-only access to the fixed thesaurus.
To release the Fix for Platform flag:
1. Select the thesaurus in the Navigation pane.
2. Lock the thesaurus.
3. Uncheck the Fix for Platform check box in the Work pane.
4. Unlock the thesaurus.
The Fix for Platform flag is removed and the thesaurus can be edited by Tenant
Administrators with the appropriate access rights.
Creating a New Thesaurus
Platform Administrators can create new thesauri from scratch. This feature is not available for
Tenant Administrators.
To create a thesaurus:
1. Do one of the following:
t
Click the New Thesaurus icon on the toolbar.
t
Select Thesaurus > New Thesaurus.
t
Press Ctrl+N.
The Create Thesaurus dialog opens.
28
Creating a New Thesaurus
2. Type a unique thesaurus ID in the Thesaurus ID field. Blank spaces are not allowed.
3. (Option) To prevent the thesaurus from being edited by Tenant Administrators, check the Fix
for Platform check box.
4. Click OK.
The “Thesaurus succesfully created” message opens.
5. Click OK.
The message and the Create Thesaurus dialog are closed. The Loading Tree progress
indicator is shown as the new thesaurus is loaded. After that, the thesaurus is displayed in the
Navigation and Work panes.
6. Enter the labels for the thesaurus in all required languages. For additional information, see
“Localizing Thesaurus Names” on page 30.
7. Add terms to the thesaurus. For additional information, see “Creating a New Term” on
page 40.
n
Before you can use the new thesaurus it is required that you define it in the data model. Use the
MAM Datamodel Administrator’s “import thesauri” feature to register your new thesaurus in
the data model and assign the thesaurus to an attribute from type thesaurus.
29
Localizing Thesaurus Names
Localizing Thesaurus Names
If you have not entered localized labels for a thesaurus in the selected language, the Thesaurus
ID is displayed in the Navigation pane.
To localize a thesaurus name in the Work pane:
1. Display the thesaurus in the Navigation pane.
2. Select the thesaurus in the Navigation pane.
The Work pane shows the Thesaurus tab with an overview table that provides options to
enter labels in different languages.
3. Lock the thesaurus.
4. Click in the row of the desired language in the overview table.
5. Click in the Name field of the selected language.
The Name field is activated for text input.
6. Type the thesaurus name.
7. Do one of the following:
t
Press Enter.
t
Press the Tab key.
The thesaurus name is saved and the next language is automatically selected in the overview
table.
8. Repeat steps 5 through 7 for all languages.
To localize a thesaurus name in the Navigation pane:
1. Display the thesaurus in the Navigation pane.
2. Lock the thesaurus.
3. Select the desired language from the toolbar’s Language selection list.
30
Exporting a Thesaurus
4. Click slowly on the thesaurus name in the Navigation pane.
The Name field is activated for text input.
5. Type the thesaurus name.
6. Do one of the following:
t
Press Enter.
t
Click in the background of the Navigation or Work pane.
The thesaurus name is saved.
7. Repeat steps 3 through 6 for all languages.
Exporting a Thesaurus
You can export thesauri to create a backup, for example, or to edit a thesaurus externally.
To export a thesaurus:
1. Select File > Export Thesaurus.
The Export Thesaurus dialog opens.
2. Select the thesaurus from the Choose a thesaurus selection list.
3. Click Export.
The File Save As dialog opens.
4. Select the save directory, type a new name for the thesaurus in the File name text box
(option), and click Save.
The File Save As dialog box closes. An Export successful message is displayed when the
export is complete.
5. Click OK.
The message closes. The exported thesaurus is saved to the selected save directory as an
*.xml file.
31
Importing a Thesaurus
Importing a Thesaurus
As an alternative to creating a thesaurus manually you can also import a thesaurus. Prerequisite:
The import thesaurus file must have the correct file format (*.xml) and internal structure. The
Import Thesaurus option is available for Platform Administrators only.
To import a thesaurus:
1. Select File > Import Thesaurus.
The File Open dialog opens.
2. Select the thesaurus to be imported (*.xml) and click OK in the File Open dialog.
The File Open dialog is closed and the import starts. The Thesaurus Administrator shows a
white Navigation pane and the Please wait progress indicator while the thesaurus is
imported.
When the import is finished the tree structure is shown in the Navigation pane and the
Import successful message opens.
3. Click OK.
32
Reloading Thesauri
The message closes. The thesaurus and all its terms are available.
4. (Option) If all tenant- and owner-related information has been deleted from the thesaurus
during an external edit, the thesaurus will appear empty after import. To fix this, do the
following:
a.
Select “(all)” from the toolbar’s Show selection list.
The terms of the thesaurus are displayed in the Navigation pane, and all show a warning
icon.
b.
Assign the terms to tenants. For additional information, see “Assigning and Unassigning
Terms” on page 60.
Reloading Thesauri
You see your changes immediately when you work with a thesaurus or its terms. Changes made
by other users in the thesaurus database are only visible after you restart Thesaurus
Administrator. Alternatively, you can reload the thesauri to update the display.
You can recognize when a thesaurus is being edited by another user when the thesaurus’s name
has the suffix “locked by <Windows user name>” and is displayed in red font in the Navigation
pane.
To reload thesauri do one of the following:
t
Select File > Reload.
t
Press Ctrl+Shift+L.
33
Deleting a Thesaurus
The Thesaurus Administrator shows a white Navigation pane and the Please wait - Loading Tree
progress indicator while the thesauri are reloaded. After reloading you can see the changes made
by other users, even if they have not updated the display.
Deleting a Thesaurus
n
Before you delete a thesaurus, make sure it is not used in the data model (not assigned to an
attribute from type thesaurus). Since work is performed directly in the database, Thesaurus
Administrator does not offer an undo or restore function. If you delete a thesaurus by mistake
you will have to create a completely new thesaurus or import a backup (if you've created one).
To delete a thesaurus:
1. Select the thesaurus in the Navigation pane.
2. Lock the thesaurus.
3. Do one of the following:
t
Select Thesaurus > Delete Thesaurus.
t
Open the context menu of the thesaurus and select Delete Thesaurus.
The Delete thesaurus security prompt opens.
4. Do one of the following:
t
Click No if you want to cancel the delete process.
t
Click Yes if you want to irrevocably delete the thesaurus and all terms from the
database.
34
3 Working With Terms
The following topics provide information about the basic options you have when working with
terms:
•
Using the Integrated Search Feature
•
Understanding the Work Pane
•
Locking and Unlocking Terms
•
Creating a New Term
•
Editing the Term Properties
•
Moving a Term
•
Approving and Rejecting Terms
•
Deleting a Term
Using the Integrated Search Feature
The Thesaurus Administrator provides an integrated search option that enables you to search for
terms in the Navigation pane. This search can be used in the same way as searches in the
Thesaurus pick tools of MAM Cataloger and MAM Desktop. This means:
•
The search is only executed on the terms displayed in the Navigation pane. The search is
language- and tenant-dependent: The terms that are shown in the Navigation pane depend on
the language selected in the toolbar’s Language selection list, and the tenant selected in the
Show selection list.
•
The search begins with the selected item and progresses downward in the Navigation pane.
Searching in an upward direction is not possible.
•
If the search has reach the end of the Navigation pane, it will automatically start again at the
beginning.
Using the Integrated Search Feature
Basic Concepts
The Thesaurus Administrator search is straight forward. There are only a few guidelines.
•
The search is not case-sensitive.
•
Wildcards and operators are not supported.
•
If you use a single search string it is implicitly enhanced by an asterisk at the beginning and
end.
•
If you use a bipartite search string the first word must be written completely, and at least the
first letter of the second word must be typed. The second word is enhanced by an asterisk at
the end.
•
Punctuation marks like a dot or hyphen are ignored and do not need to be typed when using
a single search term. When using a bipartite search term the punctuation marks must be used
at the correct position.
The following table gives examples for the basic search concepts in Thesaurus Administrator.
Input
Result
Full search term
If English is the selected language the search only finds the search string
republic but not the German republik, even when the German label for the term
exists.
republic versus republik
Part of a search term
eri
Two search terms
separated by a space
central a
The search finds all words that contain eri at any position; for example, Eritrea,
Algeria, Nigeria, Overijsel, United States of America, and others,
because eri is interpreted as *eri*
The search finds all terms that start with central and continue with a. An
asterisk is only implicitly added to the end of the second term, a, so that central
a is interpreted as central a*. This means that central america, central africa,
central african republic, and central asia are classified as hits, but central
eritrea is not.
Punctuation marks in
single and bipartite
search terms
When you use a single search term you can ignore punctuation marks. For st the
search finds St. Helena, St. Christopher, and St. Pierre, but also Costa Rica,
Eastern Africa, Ivory Coast, Western Sahara, and others.
st versus st.
Type st. if you only want to find St. Helena, St. Christopher, or St. Pierre.
st. hel
Use punctuation marks for a bipartite search term. For st hel the search does not
find a hit. For st. hel the term St. Helena is found.
36
Using the Integrated Search Feature
Searching for Terms
When you execute a search, the first item that matches your query is highlighted in the tree
structure of the Navigation pane. In this context, searching in the Thesaurus Administrator
means stepping from item to item in the Navigation pane.
To search for terms:
1. (Option, Platform Administrators only) Select all thesauri or a specific thesaurus in which to
search from the toolbar’s Thesaurus selection list.
2. (Option, Platform Administrators only) From the Show selection list, select the tenant from
which you want to display terms in the Navigation pane. If you select “(all),” the default
labels will be displayed.
3. Select the language from the toolbar’s Language selection list.
4. Do one of the following:
t
Select File > Search.
t
Press Ctrl+F.
The Search dialog opens.
5. Type your search string in the text field of the Search dialog.
6. Click Search.
The search begins with the item selected in the Navigation pane. If you have not selected an
item the search begins with the first thesaurus in the Navigation pane, as it is the default
selection upon opening the Thesaurus Administrator or switching between thesauri.
When a term matching your search is found it is highlighted in the corresponding thesaurus.
The hierarchical folder structure is expanded to display the found term if it is a multi-level
thesaurus (with terms and sub-terms).
7. (Option) If you have not found the desired term, click Search in the Search dialog, until you
find the desired term.
37
Understanding the Work Pane
Understanding the Work Pane
You can display, enter, and edit information for terms in the Work pane. A separate tab is
displayed for each available language. All tabs show the same structure. If a thesaurus and its
terms are not locked for editing, the boxes inside the tabs are displayed in read-only mode. As
soon as a thesaurus is locked, the boxes in the tabs are activated for editing.
The following illustration and tables describe the areas of the Work pane.
Item
1 Approval
Information
Description
Shows approval information (creation and approval dates, and creator’s and
approver’s names) as header of the Work pane. Approval Information can be shown
or hidden by using the Approval Info Display toggle controls. For additional
information, see “Approving and Rejecting Terms” on page 48.
38
Locking and Unlocking Terms
Item
Description
2 Term Properties Defines the term properties (term name, scope note, synonyms, and relations) in
different languages and for different tenants (Platform Administrators only). For
additional information, see “Editing the Term Properties” on page 41.
3 Links
Sets links (URLs) for the term. For additional information, see “Entering Links” on
page 45.
4 Tenants
Manages the assignment of terms to different tenants. For additional information, see
“Displaying Tenant-Specific Term Properties” on page 62 and “Assigning and
Unassigning Terms” on page 60.
Locking and Unlocking Terms
As an alternative to locking and unlocking thesauri for editing, you can also lock and unlock
terms. For additional information, see “Locking and Unlocking Thesauri” on page 26.
To lock a term and its thesaurus:
1. In the Navigation pane, select a term displayed in black font.
2. Do one of the following:
t
Open the term’s context menu and select the Lock thesaurus option.
t
Click the Lock thesaurus icon on the toolbar.
t
Select Thesaurus > Lock Thesaurus.
t
Press Ctrl+L.
The term and its thesaurus are locked. The thesaurus, terms, and sub-terms are displayed in
green font in the Navigation pane. All input fields are set to edit mode in the Work pane.
To unlock a term and its thesaurus:
1. In the Navigation pane, select a term displayed in green font.
2. Do one of the following:
t
Open the context menu for the term and select the Unlock thesaurus option.
t
Click the Unlock thesaurus icon in the toolbar.
t
Select Thesaurus > Unlock thesaurus.
t
Press Ctrl+U.
The term and its thesaurus are unlocked. The thesaurus, terms and sub-terms are displayed in
black font in the Navigation pane. All input fields are grayed out in the Work pane,
indicating the thesaurus is in read-only mode.
39
Creating a New Term
Creating a New Term
When you add a new term to a thesaurus you create a top-level term, when you add a new term to
a term you create a sub-term. They are created in the same way.
To create a term:
1. (Option, Platform Administrator only) From the Show selection list, select the tenant from
which you want to display terms in the Navigation pane.
2. From the toolbar's Thesaurus selection list, select the thesaurus to be displayed in the
Navigation pane.
3. Select the language of the term to be added from the toolbar's Languages selection list.
The thesaurus is reloaded with the selected language.
4. Lock the thesaurus.
5. (Option) Select the term for which you want to create a sub-term in the Navigation pane.
6. Do one of the following:
t
Click the New Term icon on the toolbar.
t
Select Term > New Term.
t
Press Ctrl+Shift+N.
t
Open the context menu of the thesaurus or term and select the New Term option.
In the Navigation pane a New Term text box is added underneath the thesaurus or term
name.
7. Enter the term name in the New Term text box and press Enter.
The term is created in the thesaurus and is immediately available in the system for
documentation and retrieval purposes.
Language-dependent tabs for entering term properties are displayed in the Work pane. The
tab of the currently selected language is opened automatically.
40
Editing the Term Properties
When a Platform Administrator creates a new term it is assigned to all tenants automatically.
When a Tenant Administrator creates a new term it is only assigned to the tenant of the
Tenant Administrator.
8. Enter the term’s properties. For additional information, see “Editing the Term Properties” on
page 41.
Editing the Term Properties
Most term properties are edited in the Work pane, where for each language a separate tab with
input fields is displayed. All tabs for terms show the same structure. As long as a thesaurus and
its terms are not locked for editing, the fields insides the tabs are displayed in read-only mode.
As soon as a thesaurus is locked, the fields in the tabs are activated for editing. Most term
properties are language-dependent, but all are tenant-specific. This means a Platform
Administrator can edit term properties for different tenants individually.
Switching Between Tenant-Specific Term Properties
Platform Administrators have access to a Tenant selection list for each term in the Work pane.
The list contains the names of the tenants to whom the terms are assigned (the names that are
displayed in the Assigned Tenants group field). You can switch between tenants for each term,
and edit term properties for the individual tenants independently. Additionally, a “No Tenant”
option allows you to define default labels -- tenant-independent labels that can be used as a
fallback when tenant-specific labels are not defined. This reduces administration effort.
n
While the Show selection list on the toolbar only applies a tenant-specific filter on the
Navigation pane, the Tenant selection list in the Work pane only affects the tenant-specific
display in the Work pane. The selection lists are not synchronized.
To switch between tenant-specific term properties:
1. Open a term in the Work pane.
The term properties for the selected tenant are displayed. By default this is the tenant that
was last used in the Work pane.
2. Select another tenant from the Tenant selection list.
The Work pane displays the term properties for the selected tenant. When you select the No
Tenant option the default labels are displayed (labels that are not assigned to any tenant).
41
Editing the Term Properties
Localizing Term Name
If you have not entered localized labels for a term in the selected language, the Term ID is
displayed in the Navigation and Work panes. The term name is the only term property that can be
edited in the Navigation and Work panes.
To localize a term name in the Work pane:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
3. Lock the thesaurus.
4. Select the term in the Navigation pane.
The term properties are displayed in the Work pane.
5. (Option, Platform Administrator only) Check and select the correct tenant from the Work
pane’s Tenant selection list.
6. Select the language by clicking the language tab in the Work pane.
7. Click in the Term Name field and type the term name.
8. Do one of the following:
t
Press the Tab key.
t
Click in another field of the Work pane or in the Navigation pane.
The term name is saved.
9. Repeat steps 5 through 7 for all other languages.
10. (Option, Platform Administrator only) Repeat steps 5 through 8 for other tenants and the
default label.
42
Editing the Term Properties
To localize a term name in the Navigation pane:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
3. Lock the thesaurus.
4. Select the desired language from the toolbar’s Language selection list.
5. Select the term in the Navigation pane.
6. Do one of the following:
t
Press F2.
t
Click on the term name.
The Name field is activated for text input.
7. Type the term name.
8. Do one of the following:
t
Press Enter.
t
Click the background of the Navigation or Work pane.
The term name is saved.
9. Repeat steps 5 through 8 for all other languages.
10. (Option, Platform Administrator only) Repeat steps 5 through 8 for other tenants and the
default label.
Entering Description and Synonyms
You can enter additional information for a term (such as a description, or synonyms) that is
displayed in the Thesaurus pick tools of MAM Desktop and Cataloger. Like the term name,
descriptions and synonyms are language-specific, so they are entered individually for each
language. If you enter a description and a synonym in English, for example, theses properties are
not copied to other languages, and have to be entered again for German, for example.
To enter descriptions and synonyms:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
43
Editing the Term Properties
3. Lock the thesaurus.
4. Select the term in the Navigation pane.
The term properties are displayed in the Work pane.
5. (Option, Platform Administrator only) Check and select the correct tenant from the Work
pane’s Tenant selection list.
6. Select the language by clicking the language tab in the Work pane.
7. Click in the Description field and enter a description for the term.
8. Click in the Synonyms field and type synonyms for the term. If you enter several synonyms,
use a comma as a separator between the synonyms. (The separator can be configured in
MAM System Administrator).
9. Click outside the Synonyms field.
The properties are applied to the term.
10. Repeat steps 6 through 9 for all other languages.
11. (Option, Platform Administrator only) Repeat steps 5 through 9 for other tenants and the
default label.
Defining Relations
You can define relations between terms within the same thesaurus. This allows users to access
related terms directly in the Thesaurus pick tools. Unlike other term properties, you do not have
to define relations for different languages. Once a relation is set, the related term is displayed for
each language in the Work pane and with the corresponding localized name.
To define relations:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
3. Lock the thesaurus.
4. Select the term in the Navigation pane.
The term properties are displayed in the Work pane.
5. (Option, Platform Administrator only) Check and select the correct tenant from the Work
pane’s Tenant selection list.
6. Click on another term of the same thesaurus in the Navigation pane, and press and hold the
mouse key while dragging the term to the Relations field on the Work pane.
44
Editing the Term Properties
The relation is set, and the ID and name of the related term are displayed in the Relations
group field. At the same time the corresponding reverse relation is set in the referenced term.
In the example shown below, a relation to Adan is set for Sanaa; at the same time, a relation
to Sanaa is established for Adan.
7. (Option) To delete a relation, select the desired row in the Relations group field and press
Del.
The relation is removed from both terms automatically.
8. (Option, Platform Administrator only) Repeat steps 4 through 6 for other tenants and the
default label.
Entering Links
You can enter links (normally URLs) in the Work pane's Links group field. The entries are
language-independent, so the same links will be displayed in every language tab. The links
entered in Thesaurus Administrator allow the users in MAM Desktop to access additional
information for a term via hyperlink.
To enter links:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
3. Lock the thesaurus.
4. Check and select the correct tenant from the Work pane’s Tenant selection list.
45
Moving a Term
5. Select the term in the Navigation pane.
The term properties are displayed in the Work pane.
6. Go to the Links group field and type or copy a link in the URL field.
7. Press Enter.
The link is saved to the database. A new, empty row for entering an additional link is added
underneath the row with the link.
8. (Option, Platform Administrator only) Repeat steps 4 through 7 for other tenants and the
default label.
Moving a Term
You can move terms within a thesaurus. In doing so you also move all sub-terms of the moved
term. It is not possible to move terms between different thesauri.
n
Although the moving term feature is available for Platform Administrators and Tenant
Administrators, Avid recommends that Tenant Administrators avoid moving terms because of
side effects of the move operation.
To move a term:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
3. Lock the thesaurus.
4. Select the term in the Navigation pane.
46
Moving a Term
5. Drag the term to the new target in the Navigation pane or continue with step 6.
6. Do one of the following:
t
Click the Cut Term icon on the toolbar.
t
Select Term > Cut Term.
t
Press Ctrl+Shift+X.
t
Open the context menu of the term and select the Cut Term option.
The Paste Term controls are activated.
7. Select the target (term or the thesaurus name) in the Navigation pane.
8. Do one of the following:
t
Click the Paste Term icon on the toolbar.
t
Select Term > Paste Term.
t
Press Ctrl+Shift+V.
t
Open the context menu of the term or thesaurus and select the Paste Term option.
If the term was moved by a Platform Administrator, the term and all its sub-terms are moved
to the new position and subordinated to the target in the tree. In the database only a new
Parent ID is set, so the Term IDs do not change and references do not need to be updated.
47
Approving and Rejecting Terms
n
When a Tenant Administrator moves a term, a copy of this term and its sub-terms is created
within the thesaurus. New Term IDs are set for the copied terms. If users of this tenant use a
moved term for annotation in MAM Desktop or Cataloger, a broken link in the form ##TermID##
remains in the affected Thesaurus attribute field. The user has to manually remove the broken
link and replace it with the new term.
Approving and Rejecting Terms
You can approve or reject terms created by users in the Thesaurus pick tools of MAM Desktop
and Cataloger. As a Platform Administrator you can approve or reject terms for all tenants; as a
Tenant Administrator you can approve or reject terms only for your tenant.
If activated in your MAM system, information about the approval process can be tracked.
Information about the term creator, approver, and the creation and approval time can be written
to the database. The Approval Tracking feature can be activated using the Interplay MAM
System Administrator (profile: ThesaurusWS, section: Config, key: TrackApproval).
To approve or reject a term:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesauri in the Navigation pane.
Question marks in the Navigation pane indicate thesauri that contain at least one term that
requires approval. The number of terms that need approval is indicated on the toolbar. This
number is influenced by the selection in the Show and Thesaurus selection lists (the thesauri
that are displayed for each tenant in the Navigation pane).
3. Lock the thesaurus.
4. Do one of the following:
t
Click the Navigate to Next icon on the toolbar.
t
Select Term > Next Term.
t
Press Ctrl+Shift+ArrowUp.
48
Approving and Rejecting Terms
The tree expands in the Navigation pane and selects the next term that needs to be approved.
The Approval controls on the toolbar are activated.
5. (Option) Do one of the following:
t
Click the Show Approval Info icon on the toolbar.
t
Select Term > Show Approval Info.
The Approval Info field is displayed as header of the Work pane.
6. To approve a term, do one of the following:
t
Click the Approve Term icon on the toolbar.
t
Select Term > Approve Term.
t
Press Ctrl+Shift+A.
The question mark is removed from the term in the Navigation pane. The “terms remaining”
count on the toolbar is adapted. If Approval Tracking is enabled in the system, the Approval
Info is updated for the approved term (the name of the Approver and the Approval date are
shown). The next term that needs approval is automatically selected in the Navigation pane.
49
Deleting a Term
7. To reject a term, do one of the following:
t
Click the Reject Term icon on the toolbar.
t
Select Term > Reject Term.
t
Press Ctrl+Shift+R.
If a Platform Administrator rejects the term, it and its sub-terms are deleted from the
database. If a Tenant Administrator rejects the term, it and its sub-terms are only removed
for the specific tenant.
In both cases the “terms remainig” count on the toolbar is adapted and the next term that
needs approval is automatically selected.
n
When you reject a term that has already been used for annotation in MAM Desktop or Cataloger,
a broken link in the form ##TermID## remains in the affected Thesaurus attribute field. Since
deleted terms cannot be removed using MAM Desktop’s Search and Replace feature, the user has
to manually remove the broken link and replace it with a valid term.
Deleting a Term
Terms can be deleted by Platform Administrators and Tenant Administrators. The effect of the
delete operation depends on the role of the user that deletes a term.
To delete a term:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
3. Lock the thesaurus.
4. Select the term in the Navigation pane.
The term properties are displayed in the Work pane.
5. Do one of the following:
t
Select Term > Delete Term.
50
Deleting a Term
t
Open the context menu of the term and select the Delete Term option.
A security prompt opens.
6. Click Yes.
If a Platform Administrator deletes the term, the term and its sub-terms are deleted from the
database. It doesn’t matter if the term is still assigned to other tenants or not.
If a Tenant Administrator deletes the term, the following happens:
n
-
If the term is assigned to other tenants, it and its sub-terms are only removed for the
tenant whose Administrator deletes the term. For all other tenants the term is still
visible.
-
If the term is not assigned to any other tenant, the term and its sub-terms are deleted
from the database.
When you delete a term that has already been used for annotation in MAM Desktop or
Cataloger, a broken link in the form ##TermID## remains in the affected Thesaurus attribute
field. Since deleted terms cannot be removed using the MAM Desktop’s Search and Replace
feature, the user has to remove the broken link manually and replace it with a valid term.
51
4 Working With Languages
The following topics provide information about the basic options you have when working with
languages:
•
Creating a New Language
•
Switching Between Languages
•
Applying Language-Dependent Labels
•
Deleting a Language
Creating a New Language
Platform Administrators can create new languages for localizing purposes.
n
The new language must already be defined in the data model, or you must create it in the data
model using Interplay MAM Datamodel Administrator. Creating a new language in Thesaurus
Administrator does not automatically create the language in the data model, and vice versa.
To create a new language:
1. Do one of the following:
t
Select Localization > New Language.
t
Press Alt+N.
The Add new language dialog opens.
2. Select the language to be created from the New Language selection list.
Creating a New Language
3. (Option) To copy term labels and properties from an existing language to the new one, check
the Copy from check box and select the language to be copied from the selection list.
To create the new language with this option requires that no thesaurus is locked by another
user; otherwise, the creation process will be aborted during the next step.
4. Click Add.
The Language created message opens.
(If you chose the “Copy from” option and a thesaurus is locked by another user, the new
language cannot be created. Instead the “Language can’t be created” message opens and
shows the thesauri that are locked by other users. Click OK to cancel the creation process.)
5. Click OK.
The message is closed and the Please wait - Loading Tree progress indicator is shown while
the tree in the Navigation pane is reloaded. The new language is not opened automatically,
the language selected before you created the new language is still active.
-
If you chose the “Copy from” option while creating the new language, the terms and
their properties are copied from the chosen language to the new language.
-
If you did not copy an existing language, and instead created one from scratch, the terms
are copied, but the labels are created in English (fallback language).
6. Localize the thesauri and terms for the new language. For additional information, see
“Applying Language-Dependent Labels” on page 55.
53
Switching Between Languages
Switching Between Languages
The Thesaurus Administrator offers two controls to switch between languages: the toolbar’s
Language selection list (to apply a language filter on the Navigation pane) and the Work pane’s
language tabs. The two language controls are not synchronized; switching between the Work
pane’s language tabs does not apply the same language filter on the Navigation pane, and vice
versa.
Control
Description
Applies a language-dependent filter on the Navigation pane. The selection
list offers all available languages. When you select a language from the
selection list the localized labels of the terms of the thesaurus opened in
the Navigation pane are shown.
A tab is displayed for each thesaurus. It contains an overview table with
the name of the thesaurus in all possible languages.
Terms are displayed with a separate tab for each language. The tabs
contain the input fields for localizing the terms.
To switch between languages in the Navigation pane:
t
Select the language from the toolbar’s Language selection list.
The labels for the thesauri and terms are displayed in the selected language in the Navigation
pane. If neither a localized label in the selected language nor a default label is defined for a
term, the Term ID is displayed.
To switch between languages in the Work pane:
t
Click the language tab.
The Work pane shows the label and properties of the term selected in the Navigation pane in
the chosen language.
54
Applying Language-Dependent Labels
Applying Language-Dependent Labels
Localizing in Thesaurus Administrator involves entering different languages for labels for
thesauri, terms, and term properties.
To apply language-dependent labels:
1. (Option, Platform Administrator only) From the toolbar’s Show selection list, select the
tenant whose terms are to be displayed.
2. Display the thesaurus and its terms in the Navigation pane.
3. Select the desired language from the toolbar’s Language selection list.
4. Lock the thesaurus.
5. For a thesaurus, enter a language-dependent name in the Navigation or Work pane.
For additional information, see “Localizing Thesaurus Names” on page 30.
6. For a term, do the following:
t
Enter a language-dependent label in the Navigation or Work pane.
t
Enter a language-dependent description in the Work pane.
t
Enter language-dependent synonyms in the Work pane.
For additional information, see “Localizing Term Name” on page 42 and “Entering
Description and Synonyms” on page 43.
Exporting Localizations
Thesaurus Administrator allows you to export the localizable elements — labels, synonyms, and
scope notes — of thesauri. The main purpose of the export is to localize the elements outside
Thesaurus Administrator and later re-import the localized elements.
To export localizations:
1. Select Localization > Export.
The Export of labels dialog opens.
55
Exporting Localizations
2. Define the thesauri whose localizations are to be exported by checking the corresponding
check boxes in the Select thesauri field.
3. Define the tenants whose localizations are to be exported by checking the corresponding
check boxes in the Select tenants field.
4. Select the languages of the localizations by checking the corresponding check boxes in the
Select languages field.
5. Click Browse, select the export directory in the Browse For Folder dialog and click OK.
6. Click Export.
The labels, synonyms, and scope notes are exported to the selected directory and saved in
different XML files, one file per thesaurus, language and tenant. The file names show the
structure <thesaurusID>_<language>_<tenant>_<date>_<time stamp>.xml (for example
Rights_de_DEPARTMENT_1_2014-08-25_20-37-49.xml).
7. Confirm the export succeeded message with OK.
56
Importing Localizations
Importing Localizations
As an alternative to localizing labels manually you can also import localized elements.
Prerequisite: The import localization file must have the correct file format (*.xml) and internal
structure. This is the case when you import localized elements that have been previously
exported from MAM Thesaurus Administrator using the export localizations feature.
To import localizations:
1. Select Localization > Import.
The Import of labels dialog opens.
2. Click Browse, select the label files to be imported (for example
Rights_de_DEPARTMENT1_2014-08-25_20-27-26.xml) and click OK in the File Open
dialog.
3. (Option) To exclude a label file from import uncheck its check box.
4. Define the effects of the label import:
t
Uncheck the “overwrite existing labels” check mark if existing labels are not be
overwritten by the import labels: Only not existing labels and scopenotes are added; if
synonyms for a term already exist, new values are not added.
t
Check the “overwrite existing labels” check mark if existing labels are to be overwritten
by the import labels: Existing labels and scopenotes are updated with new values, not
existing labels and scopenotes are added. If the import file contains information about
synonyms for a term, all existing synonyms for that term are replaced.
5. Click Import.
The Import Report dialog opens. It shows information for each imported label file.
6. Click Close.
The Navigation pane is reloaded.
Deleting a Language
Languages can only be deleted by Platform Administrators.
n
Before you delete a language in Thesaurus Administrator make sure that the language is not
referenced in the data model. If you delete a language that is still in use, the users in MAM
Desktop or Cataloger will see term labels in the fallback language or the Term ID, instead of the
deleted language.
57
Deleting a Language
To delete a language:
1. Select Localization > Delete Language.
The Delete dialog opens.
2. Select the language to be deleted from the Language selection list.
3. Click Delete.
A security prompt opens.
4. Click Yes.
The language is deleted, and the Language successfully deleted message opens.
(If the thesaurus is locked by another user the language cannot be deleted. Instead, the
“Language can’t be deleted” message opens and shows the thesauri that are locked by other
users. Click OK to cancel the deletion process.)
5. Click OK.
The Navigation pane is reloaded and the Please wait - Loading tree progress indicator is
displayed. When it is closed the deleted language is no longer accessible via the Language
selection list. In the Work pane the language is removed from the thesaurus’s language table,
and the tab of the deleted language is no longer displayed.
All text entered in the deleted language is removed from the database.
58
5 Working With Tenants
Working with tenants is a task that is reserved for Platform Administrators. Therefore, the
features described in this section are not available for Tenant Administrators.
The following topics provide information about the basic options for working with tenants:
•
Reloading Tenants
•
Assigning and Unassigning Terms
•
Displaying Tenant-Specific Term Properties
•
Defining Default Labels
•
Copying Thesaurus Labels Between Tenants
•
Removing Tenants
Reloading Tenants
Tenants for the Interplay MAM system are defined in Interplay MAM User Management. To
provide greater portability of thesauri through multiple MAM instances, tenant information for
thesauri is managed independently from User Management, and stored in a separate table of the
Thesaurus Service.
n
Avid suggests that you regularly import the tenants created in User Management into Thesaurus
Administrator using the Reload Tenant feature.
To reload tenant information from User Management:
t
Select Tenant > Reload Tenants.
The tenant information is retrieved from User Management. During this time the Loading
Tree progress indicator is shown and the thesauri in the Navigation pane are reloaded. After
that, updated tenant information is available in Thesaurus Administrator.
Assigning and Unassigning Terms
Assigning and Unassigning Terms
Assigning terms to tenants is the most basic aspect of working with terms. Tenants can only view
terms that are explicitly assigned to them. Conversely, removing a term's assignment from a
tenant removes the tenant's ability to see the term.
To edit the term assignment:
1. Open and lock the thesaurus containing the desired term.
2. Open the term in the Work pane.
3. To assign the term to tenants, go to the Tenant Assignment group fields and do one of the
following:
t
To assign the term to all unassigned tenants, click the Add All (>>) button.
t
To assign the term to an individual tenant, select the tenant in the Available Tenants
group field and click the Add (>) button.
The tenants are removed from the Available Tenants list and are displayed in the Assigned
Tenants list. The Apply and Revert buttons are activated.
60
Assigning and Unassigning Terms
4. To cancel an assignment, do one of the following:
t
To unassign the term from all tenants at the same time, click the Remove All (<<)
button.
t
To unassign the term from an individual tenant, select the tenant in the Assigned Tenants
group field and click the Remove (<) button.
The tenants are removed from the Assigned Tenants list and are displayed in the Available
Tenants list.
5. Do one of the following:
t
Click Apply to apply your changes.
t
Click Revert to discard your changes.
A security prompt opens.
6. Click Yes.
Your changes are applied or discarded. The Apply and Revert buttons are deactivated.
-
If you assigned a tenant, it is directly available in the Workpane’s Tenant selection list
and can be used to enter the tenant-specific term label and term properties.
-
If you unassigned a tenant, the term is not visible for the tenant any longer.
61
Displaying Tenant-Specific Term Properties
If you unassigned the term from all tenants, you can only make the term visible again if
you select "(all)" from the toolbar’s Show selection list. The term is shown again but
marked with a warning icon that indicates there is no assigned tenant. The warning icon
is also shown for the thesaurus, indicating that at least one of its terms has no assigned
tenant.
Displaying Tenant-Specific Term Properties
A Tenant selection list is displayed for each term in the Work pane. The list contains the names
of the tenants to whom the terms are assigned (the names that are displayed in the Assigned
Tenants group field). You can switch between tenants for each term, and edit term properties for
the individual tenants independently. Additionally, a “No Tenant” option allows you to define
default labels — tenant-independent labels that can be used as a fallback when tenant-specific
labels are not defined.
n
While the Show selection list on the toolbar only applies a tenant-specific filter on the
Navigation pane, the Tenants selection list in the Work pane only affects the tenant-specific
display in the Work pane. The selection lists are not synchronized.
62
Defining Default Labels
To switch between tenant-specific term properties:
1. Open a term in the Work pane.
The term properties for the tenant selected in the Work pane’s Tenant selection list are
displayed. By default this is the tenant that was last used in the Work pane.
2. Select another tenant from the Tenant selection list.
The Work pane displays the term properties for the selected tenant. When you select the No
Tenant option the default labels are displayed (the labels that are not assigned to any tenant).
Defining Default Labels
As a Platform Administrator you can define default labels. These are tenant-independent labels
that can be used as a fallback when tenant-specific labels are not defined. It is recommended to
enter the default label directly when creating a new term, but you can also add them later.
As long as you have not entered a default label for a term, its Term ID will be displayed in the
Navigation pane when you select “(all)” from the toolbar’s Show selection list, and in the Work
pane when you select No Tenant from the Work pane’s Tenant selection list, as shown in the
following illustration.
To define default labels:
1. Display the thesaurus and its terms in the Navigation pane.
2. Select “(all)” from the toolbar’s Show selection list.
The default labels are shown in the Navigation pane. For each term without a default label
the Term ID is shown.
3. Lock the thesaurus.
63
Copying Thesaurus Labels Between Tenants
4. Select the term in the Navigation pane.
5. Select the language by clicking the language tab in the Work pane.
6. (Option) To check the term label entered for another tenant, select the tenant from the Work
pane’s Tenant selection list.
7. Select No Tenant from the Work pane’s Tenant selection list.
8. Click in the Term Name field and type the default label.
9. (Option) Enter default labels for Scopenote, Synonyms, and Relations.
10. Repeat steps 5 through 9 to enter the term’s default labels in other languages.
11. Repeat steps 5 through 10 to enter default labels for other terms of the thesaurus.
Copying Thesaurus Labels Between Tenants
The Thesaurus Administrator offers you the possibility to copy the term labels and properties of
a thesaurus and insert them into the same thesaurus for another tenant. To prevent you from
overwriting existing labels, you can only insert the labels into a thesaurus where the new tenant
is not yet assigned to any term.
To copy term labels between tenants:
1. Open the thesaurus in the Navigation pane.
2. From the toolbar’s Show selection list, select the tenant whose terms are to be displayed.
3. Lock the thesaurus.
4. Select Thesaurus > Copy Thesaurus Entries.
The Copy Thesaurus Entries dialog box opens. It shows the name of the selected tenant
(Source Tenant) and thesaurus.
64
Copying Thesaurus Labels Between Tenants
5. Select the tenant to which you want to copy the labels from the destination Tenant selection
list. The selection list only offers those tenants that are not assigned to any term of the
thesaurus to be copied.
6. (Option) If you want to copy more than the term properties label, scope note, and synonyms,
do one of the following:
t
To also copy the relations of the terms, check the Relations check box.
t
To also copy the links defined for the terms, check the Links check box.
7. To define the languages, do one of the following:
t
To copy the term information only for individual languages, check the check box of the
language in the Cultures group box.
t
To copy the term information in all languages, check the All cultures check box.
8. Click OK.
The dialog box closes, and the terms are copied. During this time the Loading Tree progress
indicator is shown and the thesauri in the Navigation pane are reloaded. After that, all copied
terms are assigned to the new tenant and all term information is made available.
65
Removing Tenants
Removing Tenants
The Thesaurus Administrator offers you the option to remove tenants. Even though you do not
delete tenants from User Management with this option, Avid recommends you use the Remove
Tenant feature with extreme care.
n
Before you remove a tenant in Thesaurus Administrator make sure that the tenant is not
referenced in the data model and User Management. When you remove a tenant that is still in
use, users in MAM Desktop or Cataloger will see a broken link in the form ##TermID## in the
affected Thesaurus attribute field. You cannot restore a removed tenant or its term assignment in
Thesaurus Administrator. Even if you reload the tenant from User Management, you have to
reassign all terms to the tenant completely.
To remove a tenant:
1. Select Tenant > Remove Tenant.
The Remove Tenant dialog box opens.
2. Select the tenant to be deleted from the Select Tenant you want to remove selection list.
3. Click Remove.
a.
If at least one thesaurus is locked the tenant cannot be removed, and a message opens.
Click OK and the remove process is canceled.
b.
If no thesaurus is locked a security prompt opens.
4. Click Yes.
The tenant is removed and the Tenant successfully removed message opens.
5. Click OK to close the message.
The Loading Tree progress indicator is shown and the thesauri in the Navigation pane are
reloaded. The tenant is removed from the thesaurus’s tenants table, and all references that
had linked the term to the tenant are removed.
66
Index
A
D
Applying
language-dependent labels 55
language-specific filter 54
tenant-specific filter 41, 62
Approval tracking 48
Approving term 48
Assigned Tenants 60
Assigning terms to tenants 60
Available Tenants 60
Avid
online support 11
training services 11
Data model 34, 52, 57, 66
Default labels 41, 54, 62
Defining
default labels 63
links 45
relations 44
Delete Language 57
Delete Term 50
Delete Thesaurus 34
Deleting
language 57
term 50
thesaurus 34
Description
entering 43
localizing 43
Dialog
Export of labels 55
Import of labels 57
Displaying tenant-specific term properties 62
B
Basic features 12
Broken link 50, 66
Button
Export 55
C
Closing 24
Copy from 52
Copy Thesaurus Entries 64
Copying
labels between tenants 64
labels during language creation 52
Creating
language 52
term 40
thesaurus 28
Cut Term 46
E
Editing
term properties 41, 42, 43, 44, 45
term-tenant assignment 60
Export Thesaurus 31
Exporting
localization 55
thesaurus 31
F
Fallback language 52, 57
Fix for platform 27
Index
Fixing thesaurus 27
Font color 23, 33, 39
Layout
Menu bar 18
Navigation pane 23
Thesaurus Administrator 17
Toolbar 21
Work pane 24
Links, defining 45
Loading Tree 28, 32, 33, 52, 57, 59, 64, 66
Localization
exporting 55
Localizations
importing 57
Localizing
description and synonyms 43
term name 42
thesaurus name 30
Locking
terms 39
thesaurus 26
G
Group rights 14
I
Icon
Approval Info Display 21
Approve Term 21
Cut Term 21
Lock Thesaurus 21
Navigate to Next 21
Navigate to Previous 21
New Term 21
New Thesaurus 21
Paste Term 21
Reject Term 21
Unlock Thesaurus 21
Import Thesaurus 32
Importing
localization 57
thesaurus 32
Integrated search 35
Interplay MAM Cataloger 46, 48, 50, 57
Interplay MAM Datamodel Administrator 28, 52
Interplay MAM Desktop 46, 48, 50, 57
Interplay MAM System Administrator 48
Interplay MAM User Management 14, 59, 66
M
Menu bar 18
Moving term 46
N
Navigate to Next 48
Navigate to Previous 48
Navigation pane 23
displaying localized labels 54
entering localized labels 55
font color 23, 33
imported thesaurus 32
new term 40
question mark 23
searching 37
term name 42
thesaurus name 30
tree structure 23
updating display in 33
warning icon 23
New Language 52
New Term 40
New Thesaurus 28
No Tenant 41, 62, 63
L
Labels
copying between tenants 64
copying during language creation 52
exporting 55
importing 57
Language
applying filter 54
applying localized labels 55
copying labels 52
creating 52
deleting 57
selection list 21, 54, 55
working with 52
68
Index
O
R
Online support 11
Operation modes 15
Overview Thesaurus Administrator features 12
Rejecting term 48
Relations, defining 44
Reload 33
Reload Tenants 59
Reloading
tenants from User Management 59
thesaurus 33
Remaining terms 48
Remove Tenant 66
Removing
locks 26, 27
tenants 66
P
Parent ID 46
Paste Term 46
Platform Administrator
applying localized labels 55
approving and rejecting terms 48
assigning terms to tenants 60
copying labels between tenants 64
creating language 52
creating term 40
creating thesaurus 28
defining default labels 63
defining links 45
defining relations 44
deleting language 57
deleting term 50
deleting thesaurus 34
exporting thesaurus 31
features 15
fixing thesaurus for platform 27
importing thesaurus 32
localizing description and synonyms 43
localizing term name 42
localizing thesaurus name 30
locking terms 39
locking thesaurus 26
moving terms 46
reloading tenants 59
reloading thesaurus 33
removing tenant 66
required rights 14
searching for terms 37
switching between languages 54
switching between tenants 41, 62
working with tenants 59
Prerequisites 14
S
Searching for terms 35, 37
Select languages 55
Select tenant 55
Selection list
Language 21, 54, 55
Show 21, 41, 60, 62, 63
Tenant 41, 60, 62, 63
Thesaurus 21
Show Approval Info 48
Show, selection list 21
Starting Thesaurus Administrator 16
Switching
between languages 54, 55
between tenant-specific term properties 41, 62
Synonyms
entering 43
localizing 43
T
Tabs 24
Tenant Administrator
applying localized labels 55
approving and rejecting terms 48
creating term 40
defining links 45
defining relations 44
deleting term 50
features 15
localizing description and synonyms 43
Q
Question mark 23, 48
69
Index
localizing term name 42
localizing thesaurus name 30
locking terms 39
locking thesaurus 26
reloading thesaurus 33
required rights 14
searching for terms 37
switching between languages 54
Tenant Assignment 60
Tenant, selection list 63
Tenants
applying filter 41, 62
assigning terms 60
copying labels between 64
reloading 59
removing 66
working with 59
Term ID 46, 57, 63, 66
Term properties
description 43
editing 42, 43, 44, 45
links 45
name 42
relations 44
synonyms 43
tenant-specific 41, 62
Terms
approving and rejecting 48
assigning tenants 60
creating 40
defining default labels 63
defining links 45
defining relations 44
deleting 50
displaying localized labels 54
editing properties 41
entering localized labels 55
localizing description and synonyms 43
localizing name 42
locking 39
moving 46
question mark 48
searching for 37
switching between tenant-specific properties 41,
62
unlocking 39
working with 35
Thesaurus
copying labels between tenants 64
creating 28
deleting 34
exporting 31
exporting localization 55
fixing for platform 27
importing 32
importing localization 57
localizing name 30
locking 26
moving terms within 46
question mark 48
reloading 33
removing locks 26
selection list 21
unlocking 26
working with 26
Thesaurus Administrator
basic features 12
closing 24
layout 17
Menu bar 18
Navigation pane 23
operation modes 15
overview 12
prerequisites for usage 14
starting 16
Toolbar 21
Work pane 24
Thesaurus ID 28, 30, 42
Toolbar 21
Training services 11
Tree structure 23
Troubleshooting 11
U
Understanding
application layout 17
Work pane 38
Unlocking
terms 39
thesaurus 26
Updating
display in Navigation pane 33
tenant information 59
70
Index
Using Search Feature 35, 37
W
Warning icon 23, 32, 60
Work pane 24
approval information 38
defining default labels 63
editing term properties 41
entering localized labels 55
Fix for Platform check box 27
links 38
new term 40
tabs 24, 54
tenant assignment 38
term properties 38
thesaurus tab 30, 42
understanding 38
Working with
languages 52
tenants 59
terms 35
thesauri 26
71
Avid
Technical Support (USA)
Product Information
75 Network Drive
Burlington, MA 01803-2756 USA
Visit the Online Support Center
at www.avid.com/support
For company and product information, visit us on the web at www.avid.com