Interplay MAM Cache Management Administrator

Transcription

1 Interplay MAM Cache Management Administrator User s Guide Version 5

2 Legal Notices Product specifications are subject to change without notice and do not represent a commitment on the part of Avid Technology, Inc. This product is subject to the terms and conditions of a software license agreement provided with the software. The product may only be used in accordance with the license agreement. This product may be protected by one or more U.S. and non-u.s patents. Details are available at 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 2015 Avid Technology, Inc. and its licensors. All rights reserved. The following disclaimer is required by Apache Commons Logging: Copyright The Apache Software Foundation Licensed under the Apache License, Version 2.0 ( The following disclaimer is required by Apache Commons Net: Copyright The Apache Software Foundation Licensed under the Apache License, Version 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 ( The following disclaimer is required by Apache log4net: Copyright The Apache Software Foundation Licensed under the Apache License, Version 2.0 ( The following disclaimer is required by Apache Xerxes: Copyright 2008 Apache Software Foundation Licensed under the Apache License, Version 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 Michael Foster, distributed under the terms of LGPL ( 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

3 The following disclaimer is required by DirectShowLib: Copyright (C) distributed under the terms of LGPL V2.1 ( The following disclaimer is required by Divelements: Portions of this product are Copyright 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 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 ( The following disclaimer is required by getelementsbyattribute: Copyright 2006 Robert Nyman ( The following disclaimer is required by GoXam: Portions of this product are Copyright Northwoods Software. All rights reserved. The following disclaimer is required by IC#Code #ZipLib: Copyright 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 ImageMagick Studio LLC, a non-profit organization dedicated to making software imaging solutions freely available. ( 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 (ellson@lucent.com). Portions relating to gdft.c copyright 2001, 2002 John Ellson (ellson@lucent.com). 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

4 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 ( The following disclaimer is required by JQuery Plugin Autocomplete: Copyright (c) 2009 Jörn Zaefferer. ( 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 (<bhb@iceburg.net>, The following disclaimer is required by Ui.dropdownchecklist: Copyright Adrian Tosca, Copyright (c) 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 (<bhb@iceburg.net>) 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. ( 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 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

5 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) Laurent Bugnion The following disclaimer is required by nunit: Copyright (c) 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 ( 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 by Erik van den Berg The following disclaimer is required by Prototype JavaScript Framework: Copyright Sam Stephenson The following disclaimer is required by RabbitMQ: Copyright 2013 GoPivotal, Inc. All rights reserved The following disclaimer is required by ScintillaNET: Copyright by Neil Hodgson (neilh@scintilla.org) All Rights Reserved ScintillaNET bindings are Copyright by Garrett Serack (gserack@gmail.com) All Rights Reserved 5

6 The following disclaimer is required by Script.Aculo.Us Web 2.0 JavaScript: Copyright Thomas Fuchs ( The following disclaimer is required by Search Highlighter: Copyright (c) 2002, 2007, 2008 Stuart Langridge The following disclaimer is required by Silverlight Menu: Microsoft Public License (Ms-PL) 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 The software and documentation is released under the MIT license. The following disclaimer is required by WPF Themes: Licensed under the Microsoft Public License (Ms-PL) 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 (a) and/or DFARS (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

7 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 Cache Management Administrator User s Guide Created 9/7/2015 This document is distributed by Avid in online (electronic) form only, and is not available for purchase in printed form. 7

8 Contents Using This Guide Symbols and Conventions If You Need Help Avid Training Services Chapter 1 Getting Started About Interplay MAM Cache Management Administrator Basic Features Prerequisites for Using Cache Management Administrator Cache Management Administrator Configuration Options Basic Checks Opening Cache Management Administrator The Cache Management Administrator Layout Quitting Cache Management Administrator Chapter 2 Configuring Cache Management Cache Management Configuration Options Basic Concepts Evaluation Mode Watermarks Pools Filter Rules Sorting Criteria Configuration of Date Fields in Filter Rules and Sorting Criteria Verification of Nearline Locations Post-Processing Handling of Cache Management Configuration Errors Use Cases Cleaning Up Physical Files From Online Storage Forcing Post-Processing with Customized Workflow Post-Processing When Nearline Location Does Not Exist

9 Configuring Filter Rules Configuring Sorting Criteria Chapter 3 Working with Interplay MAM Cache Management Administrator Understanding the Cache Management Administrator Layout The Toolbar The Service Information Area The Pool Information Area The Log Information Area Reinitializing Cache Management Triggering Cleanup Manually Monitoring Cleanup Activities Index

10 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 Cache Management Administrator, the central tool for monitoring that the used disk space of online storages is kept in a defined range. This guide is intended for all system administrators charged with maintaining Interplay Media Asset Manager. n This guide contains all the task-oriented instructions and conceptual information you need to work with the Interplay MAM Cache Management Administrator. All tasks described in this guide can only be performed by users with administrative privileges. Symbols and Conventions Avid documentation uses the following symbols and conventions: Symbol or Convention Meaning or Action n c w A note provides important related information, reminders, recommendations, and strong suggestions. A caution means that a specific action you take could cause harm to your computer or cause you to lose data. 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 Italic font Bold font is primarily used in task instructions to identify user interface items and keyboard sequences. Italic font is used to emphasize certain words and to indicate variables.

11 If You Need Help Symbol or Convention Meaning or Action Courier Bold font Ctrl+key or mouse action Courier Bold font identifies text that you type. 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 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 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 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 and follow the Training links, or call Avid Sales at AVID ( ). 11

12 1 Getting Started The following topics provide basic information to help you get started using Avid Interplay MAM Cache Management Administrator: About Interplay MAM Cache Management Administrator Opening Cache Management Administrator The Cache Management Administrator Layout Quitting Cache Management Administrator About Interplay MAM Cache Management Administrator This quick start guide is designed to familiarize you with the most important functions of Interplay MAM Cache Management Administrator, an Interplay MAM tool to monitor and maintain that used disk space of online storage remains within a defined range. Basic Features Cache Management is a service for cleaning up online storage. It finds elements that can be deleted from essence pools by performing regular searches for preconfigured attribute values. For additional information, see Pools on page 24. Cache Management reads the drive's total size and the free space that is assigned to a pool, and then calculates the disk space to be freed. The drives size information is determined with respect to possible existing user quotas. Usable online storage disk space is kept between two levels: Low-water mark and High-water mark. If used disk space exceeds the High-water mark, files are deleted from online storage until the Low-water mark of disk space allocation is met. This is to ensure that as many files as possible are kept online. For additional information, see Watermarks on page 23. Depending on the configuration, objects are either marked to contain deletable elements ( deletion candidates ) or the corresponding elements are deleted. Deletable elements include essence locations and the physical representation of the file. If a file cannot be deleted for example, because it is not nearline but it should be, a post-processing customized workflow

13 About Interplay MAM Cache Management Administrator can be activated. For additional information, see Evaluation Mode on page 21 and Post-Processing on page 28. Filter rules can be configured to select objects for deletion. A Filter rule uses comparison rules to compare selected attributes against defined values. If more than one comparison rule is configured, both rules must validate to true to select the corresponding object (AND concatenated). For additional information, see Filter Rules on page 26. Cache Management service has a GUI called Cache Management Administrator that can be used by administrators to monitor the configured disk cleanup and trigger cleanup manually. Cache Management Administrator provides the following features: Monitoring Cleanup Activities Triggering Cleanup Manually Prerequisites for Using Cache Management Administrator To use Cache Management, the following users and rights must be present in MAM User Management: A user titled Service-CacheManagement, assigned to the group systemservices To use Cache Management Administrator you must be a member of an administrator group that has the following group rights: CacheManagement/Administration Cache Management is provided as part of the Interplay MAM package Mam.Kit.TapeArchive. After the installation of the Mam.Kit.TapeArchive package all required users and rights are present in MAM User Management. As an administrator you can review and modify these rights in the User Manager of Interplay MAM Administrator. For additional information, see the Interplay MAM User Manager User s Guide that is shipped with the software. Cache Management Administrator Configuration Options Cache Management features are subject to configuration. The default installation comes with an example configuration to illustrate how Cache Management can be configured. As an administrator you can review and modify these configuration settings. For additional information, see Configuring Cache Management on page 18. Additionally you can modify the following feature of the Cache Management Administrator GUI: 13

14 About Interplay MAM Cache Management Administrator Profile Section Affected Feature CacheManagementWS CacheManagement/GUI Refresh interval Basic Checks For additional information, see the Interplay MAM Configuration Settings Reference that is shipped with the software. Before using Cache Management Administrator, check and adjust the following settings, if necessary. These settings have been configured during the installation of the Mam.Kit.TapeArchive package and already display correct values. n To check the configuration: 1. Sign in to Interplay MAM Control Center as an administrator. 2. Start Interplay MAM Administrator from within MAM Control Center. 3. Open the System Administrator from within Interplay MAM Administrator. 4. In the Configuration tab, select the profile CacheManagementWS > section CacheManagement and ensure that the value of the key Active is set to true. 5. Select the key EvaluateOnly and ensure that it shows the needed value: - False: Locations are deleted (default value). - True: All affected objects are marked as Deletion Candidates, but locations are not deleted. 6. Select the section CacheManagement/ManagedPools/<Pool name> and ensure that it shows the needed value for the following keys: - Active: Must be set to true. - ObjectClasses: Shows the names of the object classes that are to be included in delete operations. - PoolGUID: Shows the PoolGUID of the corresponding pool in Essence Management Administrator. - EvaluateOnly: Evaluation mode is active for the pool or not, as needed. If you change any settings, refresh the configuration of the CacheManagementWS or restart the pool MAM_3100_CacheManagement in MAM Control Center s Service Controller. 14

15 Opening Cache Management Administrator To check required rights: 1. Start Interplay MAM Administrator from within MAM Control Center. 2. Open the User Manager from within Interplay MAM Administrator. 3. Ensure that the following user and right are assigned properly: - The user Service-CacheManagement is assigned to the group systemservices - The right CacheManagement/Administration is assigned to the admins group To check required services: 1. Sign in to Interplay MAM Control Center as an administrator. 2. Open the Service Controller from within MAM Control Center. 3. Ensure that the following pools and services are running: - Pool MAM_1000_Backend1 - Pool MAM_2000_Backend2 - Pool MAM_3100_CacheManagement - Pool MAM_3100_DIVArchiveConnector or Pool MAM_3100_SGLFlashNetConnector (depending on which one is used in your installation) - Service CacheManagementWS - Service EssenceManagerWS - Service EssenceServerDisk_1 - Service DIVArchiveConnector_1 or SGLFlashNetConnector_1 (depending on which one is used in your installation) Opening Cache Management Administrator Cache Management Administrator is started from within Interplay MAM Control Center. To start Cache Management Administrator: 1. Open an Internet browser and enter the URL The Interplay MAM Control Center login dialog opens. 2. Type your user name and password, and click Login. Interplay MAM Control Center opens. 3. Click MAM Administrator on the Links pane. The Interplay MAM Administrator login dialog opens. 4. Type your user name and password, and click Login. 15

16 The Cache Management Administrator Layout Interplay MAM Administrator opens. 5. Click the Cache Management Administrator link on the Overview page of Interplay MAM Administrator. Cache Management Administrator opens in a new tab. The Cache Management Administrator Layout q w e r Cache Management Administrator includes the following four areas: Area Description 1 Toolbar Provides buttons to refresh the GUI, reinitialize Cache Management, and trigger cleanup manually. For additional information, see The Toolbar on page Service Information Displays the current Cache Management execution status and general information that is relevant for all pools. For additional information, see The Service Information Area on page Pool Information Displays pool-specific information, including its current status. For additional information, see The Pool Information Area on page Log Information Displays the tail of the Cache Management log file. For additional information, see The Log Information Area on page

17 Quitting Cache Management Administrator Quitting Cache Management Administrator When you are finished using Cache Management Administrator, quit the application. To quit the application: t Click the X in the Cache Management Administrator tab. Cache Management Administrator quits, but both Interplay MAM Control Center and Interplay MAM Administrator remain open. You can resume working in both applications or quit. 17

18 2 Configuring Cache Management The following topics provide information about the basic concepts and configuration options of Cache Management: Cache Management Configuration Options Basic Concepts Use Cases For a description of all configuration settings, see the Interplay MAM Configuration Settings Reference that is shipped with the software. Cache Management Configuration Options Cache Management features are subject to configuration. The default installation comes with an example configuration (CacheManagementWS profile) that illustrates how Cache Management can be configured in Interplay MAM System Administrator. q w e r

19 Cache Management Configuration Options Level Description 1 Cache Management On Cache Management level, you can configure the following: Enable and disable Cache Management (section CacheManagement, key Active) Enable and disable Evaluation mode (section CacheManagement, key EvaluateOnly). For additional information, see Evaluation Mode on page 21. Define the time when cleanup is to be performed (section CacheManagement/ExecutionTimes, keys StartTime and EndTime) Define the refresh interval for the Cache Management Administrator UI (section CacheManagement/GUI, key RefreshInterval) 2 Pool Each pool is configured as a subsection in the CacheManagement/ManagedPools section.the name of the subsection is free. Subsections and keys are configured similarly for each pool. A new pool configuration can therefore be created as a copy of an existing pool. Attributes from a source pool might be deleted if not needed for the current pool, or deactivated, or new attributes might be added. On pool level, you can configure the following: Configure the pool to be used (key PoolGUID) Enable and disable the pool (key Active) Enable and disable Evaluation mode for the pool and define the attribute that is to be set in Evaluation mode (keys EvaluateOnly and EvaluationDMAttribute). For additional information, see Evaluation Mode on page 21. Define the object classes that are to be included in cleanup (key ObjectClasses). For additional information, see Pools on page 24. Define watermarks for the cleanup (keys HighWatermark and LowWatermark). For additional information, see Watermarks on page 23. Define if online locations are to be deleted and if this should only be possible when files are already saved to nearline storage (keys DeleteOnlineLocation and ForceNearlineLocation). For additional information, see Verification of Nearline Locations on page 28. Define if objects are marked to be post-processed, and which attribute is to be used as marker (keys DeleteObjects and PostProcessingDMAttribute). For additional information, see Post-Processing on page 28. Define if post-processing is triggered either when deletion is not possible or after a successful cleanup, and which workflow is to be triggered (keys PostProcessingRequiredOnFailure, PostProcessingRequiredOnSuccess, and PostProcessingWorkflow). Define the priority and quota for the pool if several pools are used (keys Priority and Quota). 19

20 Cache Management Configuration Options Level Description 3 Filter Rules You can use Data Manager attributes, Essence Manager attributes, and Location attributes to configure Filter rules. Within the pool section for each attribute type, a sub-section must be created that has the Filter rule as an additional sub-section. The names of the sub-sections are descriptive only and not significant in a technical sense but they should be meaningful. The configuration of a filter section consists of four key-value pairs: For Data Manager attributes, these are Active, AttributeName, Relation, and Value. For Essence Manager and Location attributes, these are Active, AttributeNameInDB, Relation, and Value. For additional information, see Filter Rules on page Sorting You can use Data Manager attributes, Essence Manager attributes, and Location attributes to configure Sorting criteria which are used to initially sort the list of cleanup candidates. Within the pool section for each attribute type, a sub-section must be created that has the Sorting criterion as an additional sub-section. The configuration of a sorting section consists of four key-value pairs: For Data Manager attributes, these are Active, AttributeName, Order, and Prio. For Essence Manager and Location attributes, these are Active, AttributeNameInDB, Order, and Prio. For additional information, see Sorting Criteria on page 26. Mandatory Configuration Elements To use Cache Management, configure the following elements: 1. Enable Cache Management (section CacheManagement, key Active). 2. Set the Cache Management Evaluation mode (section CacheManagement, key EvaluateOnly). 3. Set the execution times (section CacheManagement/ExecutionTimes, keys StartTime and EndTime). 4. Configure the pool in the subsection CacheManagement/ManagedPools/<Pool name>: - Configure the pool GUID (key PoolGUID). - Enable or disable the pool (key Active). - Define if the pool runs in Evaluation mode. If it runs in Evaluation mode, define the EvaluationDMAttribute (key EvaluateOnly). - Define the object classes to be included in cleanup (key ObjectClasses). - Define the High- and Low- water marks (keys HighWatermark and LowWatermark). 20

21 Basic Concepts - Decide if online locations are to be deleted, and if this should only be possible when files are already saved to nearline storage (keys DeleteOnlineLocation and ForceNearlineLocation). OR Define if objects are marked to be post-processed, and which attribute is to be used as marker (keys DeleteObjects and PostProcessingDMAttribute). Tip: When configuring a pool, the resulting database statement can be checked by calling the method TEST_CreateDBStatement of the CacheManagement interface. This method only returns the string of the database statement it does not execute it. Changes in MAM Desktop s Workspace Modify the configuration of folders in MAM Desktop s Workspace if you change one of the following Cache Management settings: ObjectClasses EvaluationDMAttribute PostProcessingDMAttribute In this case, you must adapt the query that is saved in the following folders to use the changed attributes: Archive candidate Deletion candidate These folders are sub-folders of the Online-Nearline Management folder. For information on how to change and save queries, see the Interplay MAM Desktop User s Guide. Basic Concepts Before changing the Cache Management configuration, consider the following basic concepts. For additional information, see Use Cases on page 29. Evaluation Mode Depending on the configuration, objects are either marked to contain deletable elements ( deletion candidates ) or locations are deleted. If you configure Cache Management to run cleanup in Evaluation mode, files are not deleted; Cache Management only switches the value of the attribute configured by the key EvaluationDMAttribute in each pool to true (default attribute: CACHE_DELETION_CANDIDATE). 21

22 Basic Concepts Deletion candidates are shown in Interplay MAM Desktop s Workspace, in the Deletion candidates folder that is a sub-folder of the Online-Nearline Management folder. You can also search for deletion candidates in MAM Desktop by using the Advanced search, attribute Deletion candidate, as shown in the following illustration. n You can configure Evaluation mode on two levels: Cache Management: Enabling Evaluation mode on Cache Management level overwrites a divergent Evaluation mode configuration on pool level. Conversely, if you disable Evaluation mode on Cache Management level, you can nevertheless enable Evaluation mode on pool level. Note that using Evaluation mode on Cache Management level also requires defining the key EvaluationDMAttribute in each pool. Responsible configuration setting: section CacheManagement, key EvaluateOnly Pool: You can configure Evaluation mode for each pool, independent of other pools and the general Cache Management setting. Note that the general Cache Management configuration might overwrite a pool-specific Evaluation mode configuration. Responsible configuration setting: section CacheManagement/ManagedPools/<Pool name>, keys EvaluateOnly and EvaluationDMAttribute If Cache Management runs in Evaluation mode, setting the configured EvaluationDMAttribute automatically changes the value of the MODIFICATION_DATETIME attribute in all affected media objects. If you want to use the MODIFICATION_DATETIME attribute in Filters, Evaluation mode must not be used. 22

23 Basic Concepts Watermarks The used disk space of the corresponding storage is kept between two configurable levels: High-water mark: If the used disk space exceeds the High-water mark, files are deleted from storage. If the High-water mark is not reached, Cache Management proceeds to the next pool (if several are configured) (if several are configured). Low-water mark: If the process of file deletion has begun as a result of surpassing the High-water mark, the Low-water mark defines the point where deletion halts. Files are deleted from the pool until the Low-water mark is reached. The value for Low-water mark should be as high as possible to keep as many files online as possible, while still ensuring that enough free disk space exists for storing new material. Both water marks are configured as a percentage of total space available. If there is only one pool on the storage, it accounts for 100% of the total space of the storage. Responsible configuration setting: section CacheManagement/ManagedPools/<Pool name>, keys HighWatermark and LowWatermark Example: Total storage: 2,000GB / Pool1: 2,000GB Watermarks: High Watermark = 80% reached when 1,600GB of disc space is full Low Watermark = 65% reached when 1,300GB of disc space is full 23

24 Basic Concepts If several pools on the same physical storage are to be configured as a shared directory not as independent hard drives Cache Management reads the High- and Low-water mark settings to determine the amount of data to be deleted, and then applies the Quota setting to calculate how much data is deleted from each pool. Responsible configuration setting: section CacheManagement/ManagedPools/<Pool name>, key Quota Pools Each pool is associated with a storage device as defined in Essence Management Administrator. The pools to be monitored have to be configured in particular, the PoolGUID of each managed pool has to be mapped to the PoolGUID of the corresponding pool in Essence Management Administrator. The default configuration delivered with the Mam.Kit.TapeArchive comes with a preconfigured Pool1 that is mapped to the HIRES pool in Essence Management. For security reasons, Pool1 is inactive (key Active is set to false). Responsible configuration setting: section CacheManagement/ManagedPools/<Pool name>, key PoolGUID 24

25 Basic Concepts Several pools can be configured independently however, pools are checked and processed serially; only one pool is processed at a time. Serial processing is necessary to avoid interdependencies between different pool configurations. Example: Two pools allocate disk space on the same storage device. When processing begins, the amount of disk space to be deleted is calculated independently for each pool. Parallel action would delete twice as many bytes as configured by the Low-water mark. Each pool is configured with a value for priority. The lower the value the higher the priority. Pools are processed in the order of their given priority. Responsible configuration setting: section CacheManagement/ManagedPools/<Pool name>, key Priority For each pool you can also configure the following: The object classes in the pool that are to be checked. This is a positive list only objects of the classes listed are processed by Cache Management; objects of classes not listed are ignored. Responsible configuration setting: section CacheManagement/ManagedPools/<Pool name>, key ObjectClasses The elements that can be deleted: - Online locations (including the files) - Objects (only marked to be post-processed). The attribute to be used as marker is configured with the key PostProcessingDM. Responsible configuration settings: section CacheManagement/ManagedPools/<Pool name>, keys DeleteOnlineLocations and DeleteObjects. Filter rules based on: - Data Manager attributes - Essence Management attributes - Location attributes Responsible configuration settings: All keys in the sections CacheManagement/ManagedPools/<Pool name>/dmattributes/<rule name>, EMAttributes/<rule name>, and LocationAttributes/<rule name>. Sorting criteria based on: - Data Manager attributes - Essence Management attributes - Location attributes 25

26 Basic Concepts Filter Rules Responsible configuration settings: All keys in the sections CacheManagement/ManagedPools/<Pool name>/sorting/dmattributes/<criterion name>, EMAttributes/<criterion name>, and LocationAttributes/<criterion name>. Define Filter rules to select objects for deletion. A Filter rule selects objects that belong to a configurable set of object classes that share common properties. A Filter rule is defined by configuring a comparison rule that compares a selected attribute against a defined value. If more than one comparison rule is configured, both rules must validate to true to select the corresponding object (AND concatenated). You can use Data Manager attributes, Essence Manager attributes, and Location attributes to configure Filter rules. Within the pool section for each attribute type, a sub-section must be created that has the Filter rule as an additional sub-section. The Mam.Kit.TapeArchive includes a set of preconfigured Filter rules that you can modify or use as template to design your own Filter rules. Responsible configuration settings: Section CacheManagement/ManagedPools/<Pool name>/dmattributes/<rule name>, keys Active, AttributeName, Relation, and Value. Section CacheManagement/ManagedPools/<Pool name>/emattributes/<rule name>, keys Active, AttributeNameInDB, Relation, and Value. Section CacheManagement/ManagedPools/<Pool name>/locationattributes/<rule name>, keys Active, AttributeNameInDB, Relation, and Value. For additional information, see Configuring Filter Rules on page 31. Sorting Criteria Define Sorting criteria with attributes used to initially sort the list of cleanup candidates. There are no restrictions when selecting a sorting attribute they do not have to be included in the Filter rules that are defined in the sections DMAttributes, EMAttributes, and LocationAttributes. You can use Data Manager attributes, Essence Manager attributes, and Location attributes to configure Sorting criteria. Within the pool section for each attribute type, a sub-section must be created that has the Sorting criterion as an additional sub-section. The Mam.Kit.TapeArchive package includes a set of preconfigured Sorting criteria that you can modify or use as a template to design your own Sorting criteria. 26

27 Basic Concepts Responsible configuration settings: Section CacheManagement/ManagedPools/<Pool name>/sorting/dmattributes/<criterion name>, keys Active, AttributeName, Order, and Prio. Section CacheManagement/ManagedPools/<Pool name>/sorting/emattributes/<criterion name>, keys Active, AttributeNameInDB, Order, and Prio. Section CacheManagement/ManagedPools/<Pool name>/sorting/locationattributes/ <criterion name>, keys Active, AttributeNameInDB, Order, and Prio. For additional information, see Configuring Sorting Criteria on page 34. Configuration of Date Fields in Filter Rules and Sorting Criteria In Datamodel Administrator date and date-time fields are configured as type Date or DateTime. Technically, these values are stored as data type string in the database (for example, yyyymmddhhmmss or yyyymmdd), but they must be configured as type integer in the Cache Management service. In contrast, date and date-time attributes in Essence Management tables are stored as such in the database. This influences how date and date-time attributes are configured as filter parameters. Configuration of date and date-time attribute differs between Data Manager and Essence Management/Location attributes: For Data Manager attributes, Replace and Convert commands are needed, as shown in the following example: For Essence Management and Location attributes, only the database function is needed, as shown in the following example: All configured attributes are used to automatically create an SQL statement. Depending on the type (string or int), the service decides whether or not a value has to be enclosed in quotation marks or not. 27

28 Basic Concepts Responsible configuration settings: Section CacheManagement/ManagedPools/<Pool name>/dmattributes/<rule name>, key Value. Section CacheManagement/ManagedPools/<Pool name>/emattributes/<rule name>, key Value. Section CacheManagement/ManagedPools/<Pool name>/locationattributes/<rule name>, key Value. For additional information, see Configuring Filter Rules on page 31. Verification of Nearline Locations Cache Management can be configured so that online locations are only allowed to be deleted if the corresponding file exists on nearline storage. Responsible configuration setting: section CacheManagement/ManagedPools/<Pool name>, key; ForceNearlineLocaltion n If the value is true, Cache Management does not delete online essences if they are not saved on a nearline essence location. For additional information, see Configuring Filter Rules on page 31. Cache Management only checks Essence Management for the nearline location entry it does not validate that the file actually resides in that location. Post-Processing Post-processing is triggered in the following situations: When objects are marked to be post-processed (key DeleteObjects is set to true). The attribute to be used as marker is configured with the key PostProcessingDMAttribute. When an online location is to be deleted but the required nearline location does not exist (keys DeleteOnlineLocation and ForceNearlineLocation are set to true). When the required nearline location does exist but deletion of the online location fails (key PostProcessingRequiredOnFailure is set to true). When an online location is deleted successfully but post-processing is required by configuration (key PostProcessingRequiredOnSuccess is set to true). In these cases Cache Management sets the value of the post-processing attribute configured in the key PostProcessingDMAttribute to true (default attribute: CACHE_ARCHIVE_CANDIDATE). When processing is complete the post-processing workflow begins if it is configured in the key PostProcessingWorkflow, and EvaluationOnly is set to false. 28

29 Use Cases Archive candidates are shown in Interplay MAM Desktop s Workspace, in the Archive candidates folder that is a sub-folder of the Online-Nearline Management folder. You can also search for archive candidates in MAM Desktop by using the Advanced search, attribute Archive candidate, as shown in the following illustration. Responsible configuration settings: section CacheManagement/ManagedPools/<Pool name>, keys PostProcessingRequiredOnFailure, PostProcessingRequiredOnSuccess, PostProcessingDMAttribute, and PostProcessingWorkflow. n For additional information, see Post-Processing When Nearline Location Does Not Exist on page 31 and Forcing Post-Processing with Customized Workflow on page 30. Only one post-processing action can be defined for each pool. If the design requires several post-processing rules for a given pool, the pool must be configured several times. Handling of Cache Management Configuration Errors During the startup of Cache Management the initialization procedure loads the configuration and creates the configured schedules. In case of a misconfiguration, errors are logged and displayed in the Cache Management Administrator Log Information area. There are two error types: Global errors: Any error in the configuration sections CacheManagement, CacheManagement/ExecutionTimes, and CacheManagement/GUI. The operation of Cache Management is not possible at all. The service does not start until the errors are resolved. Pool errors: Any error within a configured pool. The affected pool is not considered during cleanup, but all other pools are still handled. Changes to the configuration during operation of the Cache Management service are not immediately taken into account. To reload the configuration, Cache Management must be reinitialized. For additional information, see Reinitializing Cache Management on page 41. Use Cases The following section describes some typical use cases for Cache Management use and configuration. For additional information, see Cache Management Configuration Options on page 18 and Basic Concepts on page

30 Use Cases Cleaning Up Physical Files From Online Storage In a typical use case Cache Management is configured so that online locations are only allowed to be deleted if the corresponding file exists on nearline storage according to the configuration of the Low- and High-water mark settings. The used disk space of the online storage is kept between these two values, which are represented as percentages. They should be set to keep as many files online as possible, while ensuring enough free disk space for storing new material. To force deletion of online locations, including the physical representation of the according files, disable Evaluation mode. To configure cleanup: 1. Open the System Administrator from within Interplay MAM Administrator. 2. In the Configuration tab, select the profile CacheManagementWS. 3. Select the section CacheManagement/ManagedPools/<Pool name>. 4. Set the value of the key DeleteOnlineLocation to true. 5. Set the value of the key ForceNearlineLocation to true. 6. Set the value of the key EvaluationOnly to false. 7. Enter the name of object classes that are to be included in cleanup in the key ObjectClasses. 8. Enter a number from 1 through 100 for the key HighWatermark. The default value is Enter a number from 1 through 100 for the key LowWatermark. The value must not be higher than the one set for HighWatermark. The default value is 70. Post-processing is triggered if there are deletion errors. For additional information, see Post-Processing When Nearline Location Does Not Exist on page 31. Forcing Post-Processing with Customized Workflow If custom actions need to be performed every time Cache Management cleanup is started, a configured post-processing workflow can be enforced. The execution is performed according to the configured settings HighWatermark, LowWatermark, and ObjectClasses. For each candidate identified by the applied configuration, the PostProcessingDMAttribute is set and can be addressed in the post-processing workflow. To force post-processing: 1. In the Configuration tab, select the profile CacheManagementWS. 2. Select the section CacheManagement/ManagedPools/<Pool name>. 30

31 Use Cases 3. Set the value of the key DeleteObjects to true. This ensures that the configured PostProcessingDMAttribute is set on every identified candidate. 4. Set the value of the key DeleteOnlineLocation to false. 5. Set the value of the key EvaluationOnly to false. 6. Enter the name of the post-processing attribute in the key PostProcessingDMAttribute. The default attribute is CACHE_ARCHIVE_CANDIDATE. This object flag is set to true and can be checked in the post-processing workflow. 7. Enter the name of the post-processing workflow in the key PostProcessingWorkflow. Post-Processing When Nearline Location Does Not Exist Cache Management can be configured so that online locations are only allowed to be deleted if the corresponding file exists on nearline storage. In this case, Cache Management sets the configured PostProcessingDMAttribute for each object where nearline storage does not exist but physical files exist on online storage. The marked objects can then be processed manually. In the default configuration, the objects are shown in Interplay MAM Desktop s Workspace, in the Archive candidates folder that is a sub-folder of the Online-Nearline Management folder. Archiving of marked objects to nearline storage is triggered here. The online locations can be cleaned up manually in another step. To configure post-processing when nearline location is missing: 1. In the Configuration tab, select the profile CacheManagementWS. 2. Select the section CacheManagement/ManagedPools/<Pool name>. 3. Set the value of the key DeleteObjects to false. 4. Set the value of the key DeleteOnlineLocation to true. 5. Set the value of the key ForceNearlineLocation to true. This ensures that post-processing is triggered if the required nearline location exists. 6. Set the value of the key EvaluationOnly to false. 7. Enter the name of the post-processing attribute in the key PostProcessingDMAttribute. The default attribute is CACHE_ARCHIVE_CANDIDATE. Configuring Filter Rules Define Filter rules to select objects for deletion. If you configure more than one comparison rule, all rules must validate to true to select the corresponding object (AND concatenated). 31

32 Use Cases You can use Data Manager attributes, Essence Manager attributes, and Location attributes to configure Filter rules. Within the pool section for each attribute type, a sub-section must be created that has the Filter rule as an additional sub-section. The Mam.Kit.TapeArchive package includes a set of preconfigured Filter rules that you can modify or use as template to design your own Filter rules. Each attribute configuration defines a condition that must be met for a database entry to be part of the deletion candidate result set. Usually, entries with null values for the specific attribute are not part of the result because they do not satisfy the configured condition. To also include such null values, you must add the optional boolean key IncludeNullValues to the attribute configuration and set its value true. If the key is not present or its value is set to false, the null entries are excluded from the result set. To configure a Filter rule using DM attributes: 1. In the section CacheManagement/ManagedPools/<Pool name>, add a section DMAttributes/<attribute name>. The section must contain at least the following settings: Active, AttributeName, Relation, and Value. Tip: Copy one of the sample DMAttributes rules, add it to your CacheManagement/ManagedPools/<Pool name>/dmattributes section, and rename it. 2. Set the value of the key Active to true. 3. Enter the name of the attribute to be used as filter criterion in the key AttributeName. 4. Select the relational operator in the key Relation. Valid operators are: <, >, =,!=, <=, >=, likepre, likepost, likesurround 5. Set the value of the key Value, as needed. If the attribute in the rule is of type date or date-time the value must be defined in a specific manner: REPLACE(REPLACE(REPLACE(CONVERT(nvarchar, (DateAdd(day,-30,Getdate())), 120), '-', ''), ':', ''), ' ', '') A date or date-time value as provided by the configured DM attribute is compared with a given time interval with respect to the actual date (the date at time of execution). Due to the nature of the database type of a date or date-time field in Interplay MAM, the database function dateadd must be configured as an integer in a complex manner however, the example string given above can be copied and only the interval (highlighted in the following quoted text) must be changed in most cases: DateAdd(day,-30,Getdate()). The minus sign denotes that the date that is used for comparison is in the past. This notation returns a date-time value. If only the date is required, the Getdate() part must be modified to (CONVERT(nvarchar, (DateAdd(day,-30,Getdate())), 112) the last parameter of the DateAdd call is modified to

33 Use Cases To configure a Filter rule using EM attributes: 1. In the section CacheManagement/ManagedPools/<Pool name>, add a section EMAttributes/<attribute name>. The section must contain at least the following settings: Active, AttributeNameInDB, Relation, and Value. Tip: Copy one of the sample EMAttributes rules, add it to your CacheManagement/ManagedPools/<Pool name>/emattributes section, and rename it. 2. Set the value of the key Active to true. 3. Enter the name of the attribute to be used as filter criterion in the key AttributeNameInDB. 4. Select the relational operator in the key Relation. Valid operators are: <, >, =,!=, <=, >=, likepre, likepost, likesurround 5. Set the value of the key Value, as needed. If the attribute in the rule is of type date or date-time the value must be defined in a specific manner. In contrast to date or date-time values of DM attributes, EM attributes are real date or date-time database types: A date given as the actual day Getdate() minus an interval given in days. (DateAdd(day,-7,Getdate()) To configure a Filter rule using Location attributes: 1. In the section CacheManagement/ManagedPools/<Pool name>, add a section LocationAttributes/<attribute name>. The section must contain at least the following settings: Active, AttributeNameInDB, Relation, and Value. Tip: Copy one of the sample LocationAttributes rules, add it to your CacheManagement/ManagedPools/<Pool name>/locationattributes section, and rename it. 2. Set the value of the key Active to true. 3. Enter the name of the attribute to be used as filter criterion in the key AttributeNameInDB. 4. Select the relational operator in the key Relation. Valid operators are: <, >, =,!=, <=, >=, likepre, likepost, likesurround 5. Set the value of the key Value, as needed. If the attribute in the rule is of type date or date-time the value must be defined in a specific manner. In contrast to date or date-time values of DM attributes, EM attributes are real date or date-time database types: A date given as the actual day Getdate() minus an interval given in days. (DateAdd(day,-7,Getdate()) 33

34 Use Cases Configuring Sorting Criteria Define Sorting criteria with attributes used to initially sort the list of cleanup candidates. There are no restrictions when selecting a sorting attribute they do not have to be included in the Filter rules that are defined in the sections DMAttributes, EMAttributes, and LocationAttributes. You can use Data Manager attributes, Essence Manager attributes, and Location attributes to configure Sorting criteria. Within the pool section for each attribute type, a sub-section must be created that has the Sorting criterion as an additional sub-section. The Mam.Kit.TapeArchive package includes a set of preconfigured Sorting criteria that you can modify or use as a template to design your own Sorting criteria. To configure sorting criteria using DM attributes: 1. In the section CacheManagement/ManagedPools/<Pool name>, add a section Sorting/DMAttributes/<attribute name>. The section must contain at least the following settings: Active, AttributeName, Order, and Prio. Tip: Copy the sample DMAttributes sorting criterion, add it to your CacheManagement/ManagedPools/<Pool name>/sorting/dmattributes section, and rename it. 2. Set the value of the key Active to true. 3. Enter the name of the attribute to be used as sorting criterion in the key AttributeName. 4. Select the sort order in the key Order. 5. Define the priority of the sorting criterion in the key Prio. The smaller the value the higher the priority. To configure sorting criteria using EM attributes: 1. In the section CacheManagement/ManagedPools/<Pool name>, add a section Sorting/EMAttributes/<attribute name>. The section must contain at least the following settings: Active, AttributeNameInDB, Order, and Prio. Tip: Copy the sample EMAttributes sorting criterion, add it to your CacheManagement/ManagedPools/<Pool name>/sorting/emattributes section, and rename it. 2. Set the value of the key Active to true. 3. Enter the name of the attribute to be used as sorting criterion in the key AttributeNameInDB. 4. Select the sort order in the key Order. 34

35 Use Cases 5. Define the priority of the sorting criterion in the key Prio. The smaller the value the higher the priority. To configure sorting criteria using Location attributes: 1. In the section CacheManagement/ManagedPools/<Pool name>, add a section Sorting/LocationAttributes/<attribute name>. The section must contain at least the following settings: Active, AttributeNameInDB, Order, and Prio. Tip: Copy the sample LocationAttributes sorting criterion, add it to your CacheManagement/ManagedPools/<Pool name>/sorting/locationattributes section, and rename it. 2. Set the value of the key Active to true. 3. Enter the name of the attribute to be used as sorting criterion in the key AttributeNameInDB. 4. Select the sort order in the key Order. 5. Define the priority of the sorting criterion in the key Prio. The smaller the value the higher the priority. 35

36 3 Working with Interplay MAM Cache Management Administrator The following topics provide information about the basic actions that you can perform when working with Cache Management Administrator: Understanding the Cache Management Administrator Layout Monitoring Cleanup Activities Triggering Cleanup Manually Understanding the Cache Management Administrator Layout q w e r Cache Management Administrator includes the following four areas:

37 Understanding the Cache Management Administrator Layout Area Description 1 Toolbar Provides buttons to refresh the GUI, reinitialize Cache Management, and trigger cleanup manually. For additional information, see The Toolbar on page Service Information Displays the current Cache Management execution status and general information that is relevant for all pools. For additional information, see The Service Information Area on page Pool Information Displays pool-specific information, including its current status. For additional information, see The Pool Information Area on page Log Information Displays the tail of the Cache Management log file. For additional information, see The Log Information Area on page 40. The Toolbar The Cache Management Administrator s toolbar provides controls to refresh information in its GUI, refresh the Cache Management configuration, and trigger cleanup. q we Description 1 Refresh Page: Updates information in all areas of the Cache Management Administrator GUI. 2 Reinitialize: Forces Cache Management to refresh its configuration. For additional information, see Monitoring Cleanup Activities on page Start Cleanup: Starts the configured cleanup filters. For additional information, see Triggering Cleanup Manually on page 42. The Service Information Area The Service Information area provides general information on the status of the Cache Management service.the following illustration and table describe the layout of the Service Information area. 37

38 Understanding the Cache Management Administrator Layout q w e r t Description 1 Displays the current runtime status of the Cache Management service. Possible states are: Idle: Cleanup is currently not running. Running/Deleting: Cleanup is running and files are deleted (value of the setting CacheManagement/EvaluationOnly is set to false ). Running/Evaluating: Cleanup is running in Evaluation mode, files are not deleted (value of the setting CacheManagement/EvaluationOnly is set to true ). 2 Displays the current status of the Cache Management service depending on the value of the setting CacheManagement/Active. Displayed states are Active and Inactive. 3 Last starting time: Displays the time when cleanup was last started. 4 Next starting time: Displays the time of the next scheduled cleanup run (set by the value of the setting CacheManagement/ExecutionTimes, key StartTime). 5 Displays the configured execution mode of the Cache Management service set by the value of the setting CacheManagement/EvaluationOnly. Possible modes are: Evaluate only (key EvaluationOnly is set to true ). Evaluation Only is globally valid for all pools and overwrites the EvaluationOnly settings configured for individual pools. Pools configured individually (key EvaluationOnly is set to false ). The Pool Information Area The Pool Information area provides pool-specific information, including its current status. The following illustration and table describe the layout of the Pool Information area. q w e r t ey wu Ei Do Ca Bs Ad Af Ag 38

39 Understanding the Cache Management Administrator Layout Description 1 Displays the status of the pool. Possible states are: Error (red) Info (green) Warning (orange) When you hover the mouse pointer over the status, a message is shown in a tool tip. For additional information, see Monitoring Cleanup Activities on page Config Section: Shows the name of the pool-specific section from which configuration settings are read (CacheManagement/ManagedPools/<Pool name>). 3 Pool GUID: Shows the Pool GUID as configured in the setting PoolGUID. 4 Pool URL: Shows the URL of the pool referenced in the PoolGUID key. 5 Displays the pool-specific execution mode as configured in the section CacheManagement/ManagedPools/<Pool>. Possible modes are: Delete objects: Objects are marked to be deleted during post-processing (setting EvaluationOnly is set to false and setting DeleteObjects is set to true ). Delete locations: The online location is deleted (setting EvaluationOnly is set to false and setting DeleteOnlineLocation is set to true ). Evaluate only: Cleanup is running in Evaluation mode, files are not deleted (setting EvaluationOnly is set to true ). n The pool-specific setting EvaluationOnly can be overwritten by the value of the EvaluationOnly setting in the CacheManagement section: The global EvaluationOnly = true setting of the CacheManagement section overwrites an EvaluationOnly = false setting in the pool section. 6 Low/High-Watermark. Shows the percentage values for Low- and High-water marks as defined in the keys HighWatermark and LowWatermark. 7 Quota: Shows how much capacity of the total storage can be assigned to the pool, as defined in the key Quota. 8 Capacity: Total space of the storage 9 Used: Used storage 10 Free: Free storage 11 To Be Removed: Size of data to be deleted until Low-water mark is reached 39

40 Understanding the Cache Management Administrator Layout Description 12 Displays the current cleanup status of the pool. Possible states are: Running and deleting files: Cleanup is running and files are deleted (value of the setting CacheManagement/EvaluationOnly is set to false ). Running and evaluating: Cleanup is running in Evaluation mode, files are not deleted (value of the setting CacheManagement/EvaluationOnly is set to true ). Configuration error: The pool is misconfigured. Idle (Last run interrupted): Cleanup was canceled (caused by a SOAP call, or because Pool MAM_3100_CacheManagement with the Cache Management service is shut down, or the configuration is initialized). Idle: Indicates any status other than those listed above. 13 Files Deleted: Number of deleted files 14 Space Freed: Size of deleted files The Log Information Area The Log Information area provides the tail of the Cache Management log file; it shows the last 200 log file lines. q w Description 1 Reinitialize information: Shows information logged during the reinitialization of the Cache Management configuration (after start of the Cache Management service or after the Reinitialize button is clicked). For additional information, see Handling of Cache Management Configuration Errors on page 29 and Reinitializing Cache Management on page

41 Reinitializing Cache Management Description 2 Cleanup information: Shows information logged during scheduled or manually triggered cleanup runs. For additional information, see Triggering Cleanup Manually on page 42. Reinitializing Cache Management Cache Management reads its configuration during start but does not periodically update its configuration cache or recreate its schedules. Before changes made to the configuration become effective, Cache Management must be reinitialized. You can enforce this outside Cache Management Administrator by either restarting the Pool MAM_3100_CacheManagement or flushing the Cache Management cache in MAM Control Center. Within Cache Management Administrator you can trigger reinitialization with a single click, as described in the following procedure. To reinitialize Cache Management: t Click the Reinitialize button in the toolbar. Cache Management is reinitialized, the configuration is refreshed, and the configured schedules are created. The Log Information area is cleared and information about the reinitialization phase is show. In case of misconfiguration, errors are logged and displayed in the Log Information area. For additional information, see Handling of Cache Management Configuration Errors on page

42 Triggering Cleanup Manually Triggering Cleanup Manually Cache Management runs cleanup automatically in intervals depending on configuration. Cache Management Administrator allows you to manually trigger the execution of the configured cleanup filters. This executes exactly the same configuration parameters as the standard, scheduled runs. To ensure that the latest configuration is taken into account, reinitialize Cache Management before starting manual cleanup. For additional information, see Reinitializing Cache Management on page 41. To trigger cleanup manually: 1. Click the Reinitialize button in the toolbar. Cache Management is reinitialized, the configuration is refreshed, and the configured schedules are created. 2. Click the Start Cleanup button in the toolbar. Cache Management evaluates the disk space, calculates the disk space to be cleaned up depending on High- and Low-water mark and Quota settings, and runs cleanup if it is necessary and if Cache Management is not running in Evaluation mode. The Log Information area shows information about the cleanup phase. For additional information, see Monitoring Cleanup Activities on page 42. Monitoring Cleanup Activities Use Cache Management Administrator to get an overview of basic Cache Management configuration information and monitor cleanup activities. 42

43 Monitoring Cleanup Activities To monitor Cache Management and cleanup activities: 1. (Option) Click the Refresh Page button to update the Cache Management Administrator information. 2. Check the general Cache Management status and configuration. See The Service Information Area on page Check the general pool information and configuration. See The Pool Information Area on page Hover the mouse pointer over the Status field and check the pool status. The following information is shown in the Status column: Pool Status Info Warning Error Displayed when... Info and tooltip System status nice are shown when the disk space is below Low-water mark and Cache Management is configured properly. Warning and corresponding tool tips are shown when: Disk space is above Low-water mark and the pool runs in Evaluation mode Disk space is above Low-water mark and there are no execution times configured Disk space is above Low-water mark and the pool is inactive Disk space is above High-water mark and the scheduled execution time is not reached Error and corresponding tool tips are shown when: Disk space is above High-water mark and the pool runs in Evaluation mode Disk space is above High-water mark and there are no execution times configured Disk space is above High-water mark and the pool is inactive 5. Check the information in the Log Information area. It shows information about disk space, disk space to be cleaned up depending on High- and Low-water mark and Quota settings, and cleanup information. - Location deleted: For each deleted object two log file lines file <...> deleted successfully and Attribute CACHE_DELETION_CANDIDATE >...> set to false are shown. 43

44 Monitoring Cleanup Activities - Deletion skipped because no nearline location available: If ForceNearlineLocation is set to true but no nearline location is available, deletion is skipped. For each affected object the two log file lines Object <...> Skipped from cleanup and Attribute CACHE_ARCHIVE_CANDIDATE <...> set to true are shown. - Post-processing: If post-processing is required, for each affected object the line Attribute CACHE_ARCHIVE_CANDIDATE <...> set to true is shown. - Evaluation mode: If the pool is configured in Evaluation mode, for each affected object the line Attribute CACHE_DELETION_CANDIDATE <...> set to true is shown. For additional information, see The Log Information Area on page

45 Index A Archive candidate 28 folder 18, 28, 31 Attribute CACHE_ARCHIVE_CANDIDATE 28, 31 CACHE_DELETION_CANDIDATE 21 Avid online support 11 training services 11 B Basic checks 14 Basic concepts 21, 23, 24, 26, 27, 28, 29 Basic features 12 Button Refresh Page 37 Reinitialize 37, 41, 42 Start Cleanup 37, 42 C Cache Management basic checks 14 basic concepts 21, 23, 24, 26, 27, 28, 29 cleaning up files from online storage 30 cleanup 42 configuration options 13, 18 Evaluation mode 21 filter rules 26, 31 forcing post-processing 30 handling of configuration errors 29 mandatory configuration elements 18 pools 24 post-processing 28, 31 reinitializing 41 sorting criteria 26, 34 use cases 30, 31, 31, 34 watermarks 23 Cache Management Administrator basic checks 14 configuration options 13 features 12 layout 36, 37, 38, 40 monitoring cleanup 42 opening 15 overview 12 prerequisites for usage 13 quitting 17 reinitializing Cache Management 41 triggering cleanup 42 view 16 working with 36 Capacity column 38 Cleaning up physical files from online storage 30 Cleanup information 40 Cleanup monitoring 42 Column Capacity 38 Config section 38 Current Cleanup Status 38 Execution mode 37, 38 Execution status 37 Files deleted 38 Free 38 Last starting time 37 Low/High Watermark 38 Next starting time 37 Pool GUID 38 Pool URL 38 Quota 38 Service status 37

46 Index Space freed 38 Status 38 To be removed 38 Used 38 Config section column 38 Configuration errors 29 Configuration options 13 Configuring Cache Management 18 Cache Management (options) 18 Date and Date-Time fields 27, 31, 34 filter rules 31 sorting criteria 34 Current Cleanup Status column 38 D Data Manager attributes 31, 34 Deletion candidate 21 folder 18 E Essence Manager attributes 31, 34 Evaluation mode 21 Execution mode column 37, 38 F Files deleted column 38 Filter rules 26 configuration 31 configuration options 18 configuring Date and Date-Time fields 27 Forcing post-processing 30 Free column 38 G Group rights 13 H Handling of configuration errors 29 High Watermark 23 I Information logged during cleanup 40, 42 logged during reinitialization 40, 41 Interplay MAM Administrator 15 Cache Management Administrator 12 Desktop 18, 28 System Administrator 13, 14, 18 User Manager 13 L Last starting time column 37 Location attributes 31, 34 Locations Nearline 28, 30, 31 Online 28, 30, 31 Log Information area 16, 36, 40 Low Watermark 23 Low/High Watermark column 38 M Mam.Kit.TapeArchive package 14, 31, 34 Mandatory settings 18 Monitoring cleanup activities 42 N Nearline Locations 28, 30, 31 Next starting time column 37 O Object classes 24 Online Locations 28, 30, 31 Online support 11 Opening Cache Management Administrator 15 Overview, Cache Management Administrator 12 P Pool configuration options 18 Evaluation mode 21 46

47 Index filter rules 26, 31 GUID 24 monitoring status 42 Nearline location 28 object classes 24 Online location 28, 30 priority 24 sorting criteria 26, 34 watermarks 23 Pool GUID 24 Pool GUID column 38 Pool Information area 16, 36, 38 Pool URL column 38 Post-Processing 28, 30, 31 forcing 30 missing nearline location 31 workflow 30 Prerequisites 13 Priority 24 Profile CacheManagementWS 18 T To be removed column 38 Toolbar 16, 36, 37 Training services 11 Triggering cleanup 42 Troubleshooting 11 U Used column 38 W Watermarks 23, 24 Workflow 30 Working with Cache Management Administrator 36 Workspace folders 18, 28 Q Quitting Cache Management Administrator 17 Quota column 38 R Refresh Page button 37 Reinitialize button 37, 41, 42 Reinitialize information 40 Reinitializing Cache Management 41 S Service Information area 16, 36, 37 Service status column 37 Sorting criteria 26 configuration 34 configuration options 18 Space freed column 38 Start Cleanup button 37, 42 Starting Cache Management Administrator 15 Status column 38 47

48 Avid 75 Network Drive Burlington, MA USA Technical Support (USA) Visit the Online Support Center at Product Information For company and product information, visit us on the web at