Interplay MAM Workflow Monitor. User s Guide Version 5

Transcription

1 Interplay MAM Workflow Monitor 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 guide is protected by copyright. This guide is for your personal use and may not be reproduced or distributed, in whole or in part, without permission of Avid. Reasonable care has been taken in preparing this guide; however, it may contain omissions, technical inaccuracies, or typographical errors. Avid Technology, Inc. disclaims liability for all losses incurred through the use of this document. Product specifications are subject to change without notice. Copyright 2016 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. The following disclaimer is required by DirectShowLib: Copyright (C) distributed under the terms of LGPL V2.1 ( lgpl-2.1.html) 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 ( 2

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

4 The following disclaimer is required by jquery.jqmodal: Copyright 2007,2008 Brice Burgess 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. 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 4

5 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 All Rights Reserved ScintillaNET bindings are Copyright by Garrett Serack All Rights Reserved 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 Avid, the Avid Logo, Avid Everywhere, Avid DNXHD, Avid DNXHR, Avid Nexis, AirSpeed, Eleven, EUCON, Interplay, inews, ISIS, Mbox, MediaCentral, Media Composer, NewsCutter, Pro Tools, ProSet and RealSet, Maestro, PlayMaker, Sibelius, Symphony, and all related product names and logos, are registered or unregistered trademarks of Avid Technology, Inc. in the United States and/or other countries. The Interplay name is used with the permission of the Interplay Entertainment Corp. which bears no responsibility for Avid products. All other trademarks are the property of their respective owners. For a full list of Avid trademarks, see: legal-notices/trademarks. Avid Interplay MAM Workflow Monitor User s Guide v5.7 Created 10/10/2016 This document is distributed by Avid in online (electronic) form only, and is not available for purchase in printed form. 5

6 Contents Symbols and Conventions If You Need Help Avid Training Services Chapter 1 Getting Started with Interplay MAM Workflow Monitor Workflow Monitor Overview Prerequisites for Using Workflow Monitor Workflow Monitor Configuration Options Basic Concepts Starting Workflow Monitor Quitting Workflow Monitor Chapter 2 Layout of the Views Layout of the Processes View Layout of the Search Pane Layout of the Hit List Pane Layout of the Workflows View Layout of the Control Pane Layout of the Hit List Pane Layout of the Details View Layout of the Work Pane Elements of the Details Pane Layout of the Start View Elements of the Control Pane Elements of the Variables Pane Layout of the Upload View Layout of the History View Elements of the History Pane Elements of the Attic Pane Navigating the Views Chapter 3 Searching for Processes Searching for Processes of a Specific Class Searching for Processes of a Specific Lifecycle Searching for Processes within a Time Interval Searching for a Process Using its Title Searching for Processes with Workflows Accessing Detailed Information for a Process and its Workflows

7 Chapter 4 Working With the Graphical Process Visualization Viewing the Graphical Model of a Process Layout of the Visualization Pane Navigating Through the Process History Displaying a Sub-Process Checking and Refreshing Process and Activity Data Copying Process and Activity Data Chapter 5 Searching for Workflow Scripts Searching for Workflow Scripts of a Specific Type Searching for Workflow Scripts of a Specific Status Searching for Workflow Scripts of a Specific Tenant Searching for Workflow Scripts within a Time Interval Searching for a Workflow Script Using its ID Chapter 6 Displaying Detailed Information Displaying the Details of Workflow Scripts Displaying SWoDL Text Chapter 7 Editing Workflow Scripts Editing the Values of Workflow Script Variables Editing Workflow Script Priorities Chapter 8 Starting, Suspending, and Restarting Workflow Scripts Starting Workflow Scripts Suspending the Processing of Workflow Scripts Resuming the Processing of Workflow Scripts Restarting Workflow Scripts Setting the State of a Workflow Script to Error Chapter 9 Deleting and Hiding Workflow Scripts Deleting an Individual Workflow Script Deleting Several Workflow Scripts at Once Hiding a Workflow Template Chapter 10 Uploading and Downloading Data Uploading Template Files Downloading SWoDL Templates Index

8 Using This Guide n 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 Workflow Monitor, a dedicated management interface for Interplay MAM Workflow Engine. This guide provides system administrators with the information needed to search for, start, restart, and edit workflows. Interplay MAM Workflow Monitor displays a view of all workflows known to Workflow Engine s database, and system administrators can select any workflow to review its details. This guide contains all the task-oriented instructions and conceptual information you need to work with Workflow Monitor. 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 g s 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. A user tip provides a helpful hint that can aid users in getting the most from their system. A shortcut shows the user keyboard or mouse shortcuts for a procedure or command. > 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 Courier Bold font Ctrl+key or mouse action 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. 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.

9 Symbol or Convention Meaning or Action (pipe character) The pipe character is used in some Avid product names, such as Interplay MAM. In this document, the pipe is used in product names when they are in headings or at their first use in text. 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 release notes or ReadMe because the online version is updated whenever new information becomes available. To view these online versions, select ReadMe from the Help menu, or visit the Knowledge Base at 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 ( ). 9

10 1 Getting Started with Interplay MAM Workflow Monitor The following topics provide basic information to help you get started using Avid Interplay MAM Workflow Monitor: Workflow Monitor Overview Starting Workflow Monitor Quitting Workflow Monitor Workflow Monitor Overview Interplay MAM Workflow Monitor is a dedicated management interface for Interplay MAM Workflow Engine, the service that processes script tasks and is responsible for the automation of all tasks that interact with MAM services' back-end or third-party systems. Workflow Monitor enables administrators to use filter criteria to search for workflow scripts, either processed or being processed. The resulting list displays all workflow scripts within the database of Workflow Engine and can be customized to show a choice of characteristics. From the list, administrators can restart or delete workflow scripts, and review their details and edit values. Workflow Monitor also provides access to the workflow script and a history of the steps taken in the script, so that administrators can review these steps to identify the cause of incorrect behavior. From the user interface, administrators can manually start any workflow script, upload new workflow scripts or new versions of workflow scripts, and delete one or more workflow scripts at once. Administrators can filter criteria to search for processes. Processes contain script tasks that start workflow scripts in the Workflow Engine. The resulting list displays all processes within the database of Data Manager, and can be customized to show a number of characteristics. From the list, you can access workflow scripts, review their details, and edit values; additionally, you can display a graphical representation of a process model and step through its execution history. Prerequisites for Using Workflow Monitor To use Workflow Monitor, you need to be a member of an administrator group that has the following group rights: Administration/Platform_Administration Administration/Use_WorkflowMonitor

11 To use the Graphic view (Process Visualizer) for processes, the following right is required: Administration/Use_StateMachineMonitor As an administrator, you can review and assign these group rights with User Manager. The default MAM system administrator account is already configured accordingly. For additional information, see Avid Interplay MAM User Manager User s Guide, which was delivered with your product To use the Graphic view (Process Visualizer), Microsoft Silverlight must be installed on your workstation. Workflow Monitor Configuration Options Some of the GUI elements of Workflow Monitor are subject to configuration. The default MAM installation comes with a full set of default configuration settings for Workflow Monitor. As an administrator, you can review and adapt these configuration settings in the following Interplay MAM System Administrator profiles: Profile Section Affected Workflow Monitor Views WorkflowEngineWSAdmin DisplayColumns Workflows WorkflowEngineWSAdmin GUI Workflows, Details, Start, History WorkflowEngineWS_1 WorkflowEngine Workflows For additional information, see the Interplay MAM Configuration Settings Reference, which was delivered with your product. 2

12 Basic Concepts When working with Workflow Monitor, consider the following basic concepts: Workflow Scripts A workflow script is a task executed by Interplay MAM Workflow Engine on the request of a system service or user action. Workflow Engine executes workflow scripts on the request of users or system services. Workflow Engine also manages all workflow descriptions in the workflow repository. Workflow scripts can be automated or started manually in Workflow Monitor, which also allows the monitoring of the execution of workflow scripts. Workflow Templates All workflow scripts in Interplay MAM are based on workflow templates, which are registered in Workflow Engine. Simple Workflow Definition Language Interplay MAM workflow scripts are written in Simple Workflow Definition Language (SWoDL). For additional information, see Avid Interplay MAM SWoDL Reference, which was delivered with your product. Processes In Interplay MAM, a defined set of automated workflow scripts and manual activities to achieve a specific goal is called a process. A process defines the states, tasks, and control flow used to achieve the goal. Each process has exactly one start point and one end point. Within a process, workflow scripts are started by scripted tasks. For additional information, see the Avid Interplay MAM Process Modeler User s Guide and Avid Interplay MAM Process Administrator User s Guide, which were delivered with your product. Watch Service Watch Service is a generic service that starts workflow scripts upon the appearance of certain events. The service includes watch folders. A watch folder is a directory in a file system, monitored by the watch service. When new files appear in the directory, Watch Service recognizes the event, analyzes the file, and starts the appropriate workflow script. For example, Watch Service may start a workflow script that imports the file as a new essence file. 3

13 Starting Workflow Monitor Workflow Monitor is started from within Interplay MAM Control Center. To start Workflow Monitor: 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. Interplay MAM Administrator opens. 5. Click the Workflow Monitor link on the Overview page of Interplay MAM Administrator. Workflow Monitor opens in a new tab. Quitting Workflow Monitor When you are finished using Workflow Monitor, quit the application. To quit the application: t Click X in the Workflow Monitor tab. Workflow Monitor is closed but both Interplay MAM Control Center and Interplay MAM Administrator remain open. You can resume working in both applications or quit. 4

14 2 Layout of the Views Processes view is the default view in Workflow Monitor. With its search and filter functionality, it can serve as the starting point for actions performed in the Details view and Start view. The following topics provide information about the views: Layout of the Processes View Layout of the Workflows View Layout of the Details View Layout of the Start View Layout of the Upload View Layout of the History View Layout of the Processes View The Processes view is arranged in two panes. The Search pane at the top of the view includes areas with a variety of functions. It contains tools to customize the Hit List pane at the bottom of the view, and search and filter functionality to manage entries in the Hit List pane. The following illustrations and tables describe the layout of the Processes view. Pane Description 1 Search Provides controls to search for processes and customize the Hit list pane. For additional information, see Layout of the Search Pane on page 2 and Searching for Processes on page Hit list Shows the results of a search defined in the Search pane. For additional information, see Layout of the Hit List Pane on page 3.

15 Layout of the Search Pane See the following illustration and table for an overview of the Search pane: Element Description 1 Process class List for selecting a process class. The list displays all process definitions registered in Interplay MAM State Machine. For additional information, see Searching for Processes of a Specific Class on page Lifecycle List for selecting a lifecycle the technical status of a process. The possible values are defined by the legal list P_PROCESS_LIFECYCLE. These are: Pending Running Finished Error For additional information, see Searching for Processes of a Specific Lifecycle on page Process title Text field used to search for a process title. For additional information, see Searching for a Process Using its Title on page Startup time Defines the time frame during which a processes started. For additional information, see Searching for Processes within a Time Interval on page Max. hits Limits the number of matching processes to be displayed in the hit list. 6 Process properties Customizes the Hit list pane. Lets you show and hide process property columns. 7 Workflow properties Customizes the Hit list pane. Lets you show and hide workflow property columns. The initial check marks can be defined in the DisplayColumns section of the WorkflowEngineWSAdmin configuration profile. For additional information, see Interplay MAM System Administrator and Interplay MAM Configuration Settings Reference, which were delivered with your product. 8 Hits Displays the number of processes that match the search criteria. Before you have submitted a search for the first time Your search has not yet been submitted is displayed. As long as your search is processed Search is in progress... is shown. 9 Show only Processes with Workflows Shows only processes that have workflows in the hit list. For additional information, see Searching for Processes with Workflows on page Updates the Hit list pane. 2

16 Layout of the Hit List Pane The display of the Hit list pane can be customized in the Search pane. The following illustration and table provide an overview of the Hit list pane. Both reflect the preferences set in the Search pane, as displayed in the preceding layout. The rows of the table form hyperlinks: Clicking a process opens its graphical visualization in the Process Visualizer; clicking a workflow opens the workflow script in the Details view. Description 1 Toggle to display or hide the workflow scripts that were started by the script tasks. 2 Displays the process class. Clicking it opens its graphical visualization in the Process Visualizer. For additional information, see Working With the Graphical Process Visualization on page Displays the title of the process. 4 Displays the process lifecycle. 5 Displays the timestamp when the process was started. 6 Displays the timestamp when the process ended. 7 Displays the elapsed running time of the process. 8 Displays an error message (where applicable). 9 Displays information on the workflow scripts that were started by script tasks. Clicking an entry opens the workflow script in the Details view. For additional information, see Layout of the Details View on page 7 and Displaying Detailed Information on page 33. Different font colors indicate process lifecycles and workflow script states: Font Color Process Lifecycle Workflow State Green Running Ready Blue Pending Suspended Red Error Error Black Finished Finished 3

17 Layout of the Workflows View The Workflows view is arranged in two panes. The Control pane at the top of the view includes areas with a variety of functions. Apart from tools that serve to customize the Hit List pane at the bottom of the view, it also contains search and filter functionality to fill the Hit List pane with entries. The following illustrations and tables describe the layout of the Workflows view. Pane Description 1 Control Provides controls to search for workflow scripts and to customize the Hit list pane. For additional information, see Layout of the Control Pane on page 4 and Searching for Workflow Scripts on page Hit list Shows the results of a search defined in the Control pane. For additional information, see Searching for Workflow Scripts on page 29. Layout of the Control Pane See the following illustration and table for an overview on the Control pane: 4

18 Element Description 1 Type List for selecting a type of workflow script. The list displays all workflow templates registered in Workflow Engine. For additional information, see Workflow Template Types Reference on page Status List for selecting the status of a workflow script. The list displays all statuses registered in Workflow Engine. These are: Ready ReadyForRunning Finished Suspended Error ReadyWithProblems 3 Tenant List for selecting a tenant. The list displays all tenants that are registered in User Management. For additional information, see Searching for Workflow Scripts of a Specific Tenant on page Startup time Controls used to define a time frame during which the workflow scripts were originally started. 5 Max. hits Limits the number of matching workflow scripts to be displayed in the hit list. 6 All Selects all or no workflow scripts in the hit list. 7 Opens a new window displaying the SWoDL text of the workflow script currently being displayed in the Details view. For additional information, see Interplay MAM SWoDL Reference, which was delivered with your product, and Displaying SWoDL Text on page Hit list columns Customizes the Hit list pane. The initial check marks can be defined in the DisplayColumns section of the WorkflowEngineWSAdmin configuration profile. For additional information, see Interplay MAM System Administrator and Interplay MAM Configuration Settings Reference, which were delivered with your product. 9 Select workflow action List for selecting a workflow script action. The list displays all actions registered in Workflow Engine. These are: Suspend selected workflow scripts. Wakeup selected workflow scripts. Set selected workflow scripts to ERROR. Delete selected workflow scripts. 10 Sub-workflows Hides or shows sub-workflow scripts in the Hit list pane as separate entries. A workflow script is considered a sub-workflow script if it is started by another workflow script. 11 Starts the action selected in the Select workflow action list. 12 Hits Displays the number of workflow scripts that match the search criteria. 13 Updates the Hit list pane. 5

19 Layout of the Hit List Pane The display of the Hit list pane can be customized in the Control pane. The following illustration and table provide an overview of the Hit list pane. Both reflect the preferences set in the Control pane, as displayed in the preceeding layout. The rows of the table form hyperlinks: Clicking an entry opens the workflow script in the Details view. Description 1 Selects the workflow scripts. 2 Toggle to display or hide a sub-workflow script (where applicable). 3 (Optional) Displays the ID of the workflow script. 4 Displays the type of the workflow script. 5 Displays the state of the workflow script. 6 (Optional) Displays the elapsed running time of the workflow scripts. Workflow scripts that are running or have been running for a long time are highlighted. There are two levels that can be defined in the GUI section of the WorkflowEngineWSAdmin profile. Long-running workflow scripts (Key: LongElapsedTimeInHours ) are highlighted in yellow. The initial value for the key is 3 (hours). Very long-running workflow scripts (Key: VeryLongElapsedTimeInHours ). The initial value for the key is 12 (hours). 7 Displays an error message (where applicable). 8 (Optional) Displays information on sub-workflow scripts. Depending on the configuration of the WorkflowEngineWSAdmin profile, other columns can be displayed. By default, these are: Startup time End time Owner User GUID Workflow status 6

20 Depending on their state, workflow scripts are displayed in different colors: Green font: State Ready Blue font: State Suspended Red font: State Error Black font: State Finished Layout of the Details View The Details view displays details of the workflow script selected in the Workflows view and is arranged in two panes. The Work pane at the top of the view allows you to edit the workflow script. The Details pane at the bottom of the view displays detailed information about the workflow script and allows you to edit values and variables. The following illustration and table describe the layout of the Details view. Pane Description 1 Work Displays general information about the selected workflow script. Provides controls to edit the values of variables. 2 Details Displays a specific set of information, depending on the type of workflow script opened in the Details view. 7

21 Layout of the Work Pane The Work pane enables you to edit the workflow script you selected. For additional information on how to select a workflow script for editing, see Searching for Workflow Scripts on page 29. For information on how to edit a workflow script, see Editing Workflow Scripts on page 36. See the following illustration and table for an overview of the Work pane: Element Description 1 Workflow ID Displays the ID of the workflow script. 2 Type Displays the type of the workflow script. 3 State Displays the state of the workflow script. 4 SWoDL line Displays the SWoDL line that is currently being processed for workflow scripts that are still being processed. Displays the last processed SWoDL line for workflow scripts with the state Finished or Errors. For additional information, see Interplay MAM SWoDL Reference, which was delivered with your product. 5 Delay Delay before processing the SWoDL line (if applicable). The value of the delay can be configured in the Configuration settings. 6 Variable Displays the workflow script variable selected in the Details pane. 7 Deletes the workflow script displayed in the Details view. 8 Wakes up a suspended workflow script. Only visible when the workflow script is in Suspended state. Button toggles to Suspend while the workflow script is running. 9 Debug mode Check to automatically switch the workflow script to the state Suspended after the first activity step. For additional information, see Starting, Suspending, and Restarting Workflow Scripts on page 38. 8

22 Element Description 10 Startup time Displays the time and date when the workflow script was started. 11 Server time Displays the current time on Workflow Engine WS Server. 12 Opens the Start view, displaying the selected workflow script. 13 Updates the view, reflecting the values of the workflow script. 14 Opens a new window displaying the SWoDL text of the template that the workflow script is based upon and that is currently being displayed in the Details view. The window also displays line numbers and an execution history. For additional information, see Displaying SWoDL Text on page Value Displays the value of the selected workflow script variable. 16 Applies a value to the corresponding variable. Elements of the Details Pane The Details pane displays workflow script variables and the values assigned to these variables. The variables are arranged in four groups that you can individually expand and collapse: System Variables Input Variables Constants Other Variables In each group, the variables and their values are shown in alphabetical order. Information is displayed in a table that includes Variable name and Value. Each group has a different font style: system variables have a gray font, input variables bold black font, constants are green, and other variables are shown with normal black font. The rows of the table form hyperlinks: Clicking an entry inserts the attribute and value entries into the corresponding text boxes in the Work pane. Layout of the Start View The Start view is arranged in two panes. In a specific set of values pertaining to the workflow script, it allows you to enter information for the workflow script you want to start. The following illustration and table describe the layout of the Start view. 9

23 Pane Description 1 Control Provides controls to select a workflow template and start a workflow script in two different modes. For additional information, see Starting, Suspending, and Restarting Workflow Scripts on page Variables Tables for assigning values to variables. The variables displayed are specific to the type of the selected workflow script. Elements of the Control Pane See the following table for an overview of the elements of the Control pane: Element Workflow type Description List for selecting a type of workflow template. The list displays all types of workflow templates registered in Workflow Engine. For additional information, see Workflow Template Types Reference on page 75. Starts the processing of the workflow script. Start in debug mode Check to automatically switch the workflow script to the state Suspended after the first activity step. For additional information, see Starting, Suspending, and Restarting Workflow Scripts on page

24 Element Description Updates the Workflow type list. Resets the Workflow type list. _OriginalID Displays the original ID of a workflow script that has been restarted. Elements of the Variables Pane The Variables pane includes two tables that serve to assign values to variables. See the following table for more detailed information: Table Input variables Other variables Description Table for assigning values to input input variables for example, variables defined by in and not by var. For most types of workflow templates, the input table is displayed after selecting the type from the Workflow type list. For some types of workflow templates, there is no Input variables input table. Table for assigning values to other variables. There is a specific input table for each type of workflow template. The input table is displayed after selecting the type from the Workflow type list. For additional information, see Editing Workflow Scripts on page 36. Layout of the Upload View The Upload view allows you to upload the workflow template files. For additional information, see Uploading Template Files on page 46. See the following illustration and table for an overview of the Upload view: Element Description 1 Workflow file Allows you to manually enter the name and path of the workflow template file you want to upload. 11

25 Element Description 2 Description Allows you to enter a description of the workflow template file that you selected for upload. 3 Status Displays the workflow template file upload status. 4 Opens the Choose File to Upload dialog. 5 Starts the Upload process. Layout of the History View The History view is arranged in two panes that provide information about the upload history of workflow templates and hidden workflow templates. The following illustration and table describe the layout of the History view. Pane Description 1 History Displays the upload date and time of a selected workflow template file and provides controls to hide workflows based on that template. For additional information, see Hiding a Workflow Template on page Attic Displays types of workflow templates that are hidden from Workflow type lists and provides controls to reactivate workflow scripts based on that template. The Attic pane is only visible if at least one type is hidden. For additional information, see Hiding a Workflow Template on page 44. Elements of the History Pane See the following illustration and table for an overview of the control elements of the History pane: 12

26 Element Description 1 Workflow List for selecting a type of workflow template. The list displays all types registered in Workflow Engine. For additional information, see Workflow Template Types Reference on page Upload History Displays a complete history of the templates uploaded under the name selected in the Workflow list. 3 Hides the selected type of workflow template from all Workflow type lists in Workflow Monitor. Close and reopen Workflow Monitor to view the changes. For additional information, see Hiding a Workflow Template on page Updates the Workflow list. 5 Show Opens a new window displaying the SWoDL text of the specific version of the workflow template. For additional information, see Displaying SWoDL Text on page 34. Elements of the Attic Pane See the following table for an overview of the control elements of the Attic pane: Element Hidden workflows Description List for selecting a type of workflow template. The list displays all types hidden from the Workflow lists, Type lists, and Workflow type lists in all views of Workflow Monitor. Reactivates the selected type of workflow template in the Workflow lists, Type lists, and Workflow type lists in Workflow Monitor. 13

27 Navigating the Views To navigate between and within views, consider the following options: Click the according tabs to navigate among views. Click a process in the Hit list pane of the Processes view to jump to the Process Visualizer. The Process Visualizer displays the graphical visualization of the process you selected in the Processes view and lets you step through the history of the process. Click a workflow in the Hit list pane of the Processes view to jump to the Details view. The Details view displays information on the workflow script selected in the Processes view. Click an entry in the Hit list pane of the Workflows view to jump to the Details view. The Details view displays the information on the workflow script you selected in the Workflows view. Click Restart Workflow in the Details view to jump to the Start view. The Start view displays the information on the workflow script you selected. 14

28 3 Searching for Processes n Interplay MAM Workflow Monitor provides a number of options to search for processes and filter the results of queries. The following topics provide information about the search options available in Workflow Monitor: Searching for Processes of a Specific Class Searching for Processes of a Specific Lifecycle Searching for Processes within a Time Interval Searching for a Process Using its Title Searching for Processes with Workflows Accessing Detailed Information for a Process and its Workflows All search options in the Control pane of the Processes view are combined with an invisible AND operator. For a process to show in the Hit list, it must match all search criteria. Searching for Processes of a Specific Class Searching for all processes of a specific class is the most common filter criterion provided by the Processes view. To search for processes of a specific class: 1. In the Process class list, select the class of the process for which you are looking. 2. (Option) Select the asterisk to search with no specified class. 3. Click Submit or press Enter. The Hit list pane displays the result of your search.

29 Searching for Processes of a Specific Lifecycle If you want to see all processes that are pending, running, have finished successfully, or have errors, set up a search using the Lifecycle parameter. The process lifecycle is an attribute of a process class that represents the technical status of a process. The status can be Pending, Running, Finished, or Error. To search for processes of a specific lifecycle: 1. In the Lifecycle drop-down list, select the liefcycle of the process for which you are looking. 2. (Option) Select the asterisk to search with no specified lifecycle. 3. Click Submit or press Enter. The Hit list pane displays the result of your search. Searching for Processes within a Time Interval You can search for processes that were started during a specific time interval and define the interval to the exact second by using the Startup time control elements. When searching within a time interval, the REGISTRATION_DATETIME attribute is used as a value this is the timestamp when a process object is created in Data Management. To search for processes that were started within a specific time interval: 1. Click the Select start date icon. The calendar control opens. 16

30 2. Navigate to the date you want to use as the start of your interval. Use the list to define the year, and the forward and backward icons to move forward and backward through the months. 3. Click the date. The calendar control closes and the date you selected is displayed in the date box. If you reopen the control, you will see that the current date is marked blue, and the date you selected is marked yellow with a red frame. 4. Enter the start time of the interval in the text box beside the Select start date icon, using the HH:MM:SS format. 5. Repeat steps 1 through 3 using the Select end date calendar control and the corresponding end time text box to define the end time and date for the interval. 6. (Option) Use the list to the right of the end time text box to select a predefined time interval. - This hour - This day - Since yesterday - Since last week - Since last year The date boxes are adapted to the predefined interval you selected. 7. Click Submit or press Enter to apply the changes. The Hit list displays the processes that were started within the defined time interval. Searching for a Process Using its Title If you know the process' title, you can use it to search for a specific process instance. You can also combine your text input with search operators. 17

31 To search for a specific process using its title: 1. In the Process title text box, enter the title of the process. You can use the search options that are supported for text attributes in Interplay MAM attribute searches. The most common options are: wildcards * and?, quotation marks ( ), Boolean operators (AND, OR, NOT), and brackets (). For additional information, see the topic Search Synopsis in the Interplay MAM Desktop User s Guide. 2. Click Submit or press Enter. The Hit list pane displays the result of your search. Searching for Processes with Workflows Starting with Interplay MAM version 5.7, you can decide if you want to search for all processes or only processes that have workflows. If you enable the Show only Processes with Workflows check box and do not change search parameters others than the ones in the Startup time row, the search should be processed faster. Note that the first search you submit with enabled Show only Processes with Workflows check box can take longer, because the workflows-processes index initially needs to be built. To search for process with workflows: 1. Do one of the following: t To search only for processes that have workflows, select the Show only Processes with Workflows check box. t To disable the check for workflows, deselect the Show only Processes with Workflows check box. 2. Click Submit or press Enter. The Hit list pane displays the result of your search. 18

32 If the check box is disabled, the same search shows more hits in the hit list but can take longer, as shown in the following illustration. Accessing Detailed Information for a Process and its Workflows After you perform a search, the Hit List pane shows all processes that match your query. Use the hits to access additional information, as described in the following procedure. To access detailed information: 1. In the Hit List pane, click the toggle icon in front of a process. The display expands and all workflow scripts that are started by script tasks of the selected process are shown. In rare cases you may find workflow scripts that have sub-workflow scripts as shown in the following illustration. Sub-workflow scripts are displayed directly and cannot be hidden by a toggle icon. 19

33 2. Do one of the following: t t Click the Process class of a process to open its graphical visualization in the Process Visualizer. For additional information, see Working With the Graphical Process Visualization on page 21. Click a workflow script to open its details in the Details view. For additional information, see Displaying Detailed Information on page

34 4 Working With the Graphical Process Visualization The Process Visualizer provides a graphical illustration of the XPDL model behind the process that is selected in the Processes view. Additionally, it offers you controls to navigate step-by-step through the process history. The following topics provide information about the basic actions you can perform on the graphical illustration of a process: Viewing the Graphical Model of a Process Layout of the Visualization Pane Navigating Through the Process History Displaying a Sub-Process Checking and Refreshing Process and Activity Data Copying Process and Activity Data Viewing the Graphical Model of a Process You cannot open a graphical process illustration directly in Workflow Monitor. The Process Visualizer is hidden by default. Process illustrations can only be opened via the Processes view. To open a graphical process model: 1. Open the Processes view. 2. Run a search for processes. 3. Click a process in the Hit List. The Process Visualizer opens in a separate window or tab (depending on your browser settings) displaying the graphical illustration of the process and textual information about the process data.

35 Layout of the Visualization Pane The Process Visualizer s Visualization pane shows the graphical model of the process. The elements used for the visualization are determined by the business language used for modelling the process. All formattings, sizes, paths, and locations are read from the process model itself. Thus, the layout of the symbols shown below are examples for the graphical elements, and should not differ from the ones used in your installation. Symbol Description Indicates the start point of the process. Indicates the end point of the process. Delay Event: An event that waits for a specified amount of time or point in time. Indicates a transition that connects model elements and represents the sequence flow. In the process model a transition can represent the normal sequence flow, conditional sequence flow or default sequence flow. Indicates a decision - an operation that switches the control flow. Each decision has at least two outgoing transitions. 22

36 Symbol Description Indicates a fork or a join operation: Fork: This is a point in the process where a non-exclusive conditional decision is made in order to fork the control flow. Each fork has at least two outgoing transitions. Join: This is a point in the process where threads of execution are synchronized. A join operation acts as a closing bracket to a fork operation. State Task and Error State Task: A point in the process where a new state or progress can be explicitly set within the process model, and is immediately executed by the Interplay MAM State Machine. User Task: A task that requires a user action and is completed by a user action. Script Task: A task that starts a workflow in the Interplay MAM Workflow Engine for synchronous execution. Sub-Process: A placeholder for a more complex structural element of the process. A sub-process has no process instance of its own, and therefore has no local variables. Sequential Loop: A sub-process that is executed in a loop, one iteration at a time. Parallel Loop: A sub-process that is executed in a loop, <n> iterations at a time. The following graphical elements are also present in the default process visualization: Symbol Description If the frame color matches the task color, that task is currently selected in the process visualization. If the task has not been completed yet, the name is displayed with normal font. An additional red frame highlights the element representing the currently active task when navigating through the process history. Additionally, the name is also displayed in bold font. 23

37 Symbol Description The check mark on a symbol indicates a completed task. Additionally, the name is also displayed in italic font. Navigating Through the Process History When the graphical visualization of the process is displayed in the Process Visualizer, all elements of the process are shown in normal display mode. The Visualization pane allows you to switch to a History mode and navigate step-by-step through the process. In History mode you can track the activity flow, to see which tasks have been processed and in which sequence. To navigate through the history: 1. Open the desired process via the Processes view. 2. Click History in the History Slider pane. In the Visualization pane you see the following: - The pane switches to History mode, indicated by the orange frame around the pane. - The currently active task, or the task that was last active (for a finished process), is highlighted by two frames: one in red, the second in the color of the task. In the History Slider pane you see the following: - The color of the History button changes to orange. - The name of the active task and its consecutive number is displayed. In the Process Data pane you see the following: - All data that refers to the process is displayed. The data is arranged in two groups: Xpdl properties and Process instance properties. 24

38 In the Activity Data pane you see the following: - All data that is available for the active task is displayed. The data is arranged in four groups: Xpdl properties, Extended attributes, Instance properties, and Localizations. 3. In the History Slider pane, do one of the following: t Click the back arrow or drag the history slider to the left to step back one task in the process. t Click the forward arrow or drag the history slider to the right to step forward one task in the process. In either case, the previous or the following task is highlighted in the Visualization pane, and the name of the task is shown in the History Slider pane. In the Activity Data pane the data for the new task is displayed. When stepping forward through the history, all completed tasks are highlighted with a check mark; when stepping back through the history, already-set check marks are removed from the task symbols. 4. Repeat step 3 as often as necessary. 5. Click History to leave History mode and switch back to normal display mode. 25

39 Displaying a Sub-Process If your process contains a sub-process, you can display it in the Process Visualizer in a separate tab and step through its history as if in a normal process. To display a sub-process: 1. Open the desired process via the Processes view. 2. Select the sub-process in the Visualization pane, open its context menu, and select Open in New Tab. The graphical visualization of the sub-process opens in a new tab. 3. Click History to switch to the History mode of the sub-process. 4. Use the history slider or the navigation arrows of the History Slider pane to step through the history of the sub-process. All information displayed in the History Slider and Activity Data pane refers to the active task of the sub-process. 5. To leave the sub-process, do one of the following: 26

40 t t Click the X icon in the sub-process tab to close the sub-process visualization. Click Refresh in the Zoom pane or click on the tab of the process to switch to the visualization of the process without closing the sub-process tab. Checking and Refreshing Process and Activity Data When you open the graphical visualization of a process, the two panes on the right side of the Process Visualizer display information about the data of the process (Process Data pane), as well as the data of the currently selected task (Activity Data pane). In both panes the data is arranged in a grid where the individual attributes may have sub-attributes. To check and refresh the data: 1. Select a task in the Visualization pane. 2. Go to the Process Data or Activity Data pane. 3. Scroll through the data grid to check the displayed data. 4. (Option) Click the arrow in front of an attribute to display its sub-attributes. n 5. (Option) Open the context menu anywhere in the data grid and do one of the following: t Select Expand all to expand all sub-attributes on all levels and display all data in the grid. t Select Collapse all to hide all sub-attributes and show only the top-level attributes in the grid. 6. Click Refresh in the Zoom pane to update the information in the Process Data and Activity Data panes. When you open the visualization of a running process and click Refresh, the display in the Visualization pane is also updated. As a result, another task may now be active, and its data may be displayed in the Activity Data pane. While data is being retrieved, a spinning refresh symbol is displayed on the left side of the Process Data and Activity Data headers. 7. To display the data of another task, do one of the following: t Click another task in the Visualization pane. t Switch to History mode and navigate through the history of the process. Copying Process and Activity Data You can select and copy data from the data grids of the Process Data and Activity Data panes. This allows you to copy and insert data into a third-party program such as Microsoft Excel. 27

41 To mark and copy data: 1. Select a task in the Visualization pane. 2. Go to the Process Data or the Activity Data pane. 3. Click the topmost entry in the data grid. 4. Scroll down to the end of the data grid, and press Shift+click on the lowermost entry in the data grid. All entries in the grid are selected and highlighted in orange. 5. Press Ctrl+C. Depending on the security settings of your workstation, a Microsoft Silverlight security prompt may open, asking if you want to allow the application to access your clipboard. 6. Confirm with OK. The data is copied to the clipboard and can then be pasted, for example, into Microsoft Excel. 28

42 5 Searching for Workflow Scripts Interplay MAM Workflow Monitor provides a number of options to search for workflow scripts and filter the results of queries. n The following topics provide information about the search options available in Workflow Monitor: Searching for Workflow Scripts of a Specific Type Searching for Workflow Scripts of a Specific Status Searching for Workflow Scripts of a Specific Tenant Searching for Workflow Scripts within a Time Interval Searching for a Workflow Script Using its ID All search options in the Control pane of the Workflows view are combined with an invisible AND operator. For a workflow script to show in the Hit list, it must match all search criteria. Searching for Workflow Scripts of a Specific Type Searching for a workflow script of a specific type is a feature of the Workflows view, which provides most of the search options available in Workflow Monitor. To search for workflow scripts of a specific type: 1. In the Type list, select the type of the workflow script for which you are looking. The Hit list pane displays the result of your search as soon as you click the desired type of workflow script. 2. (Option) Select the asterisk to search with no specified type.

43 Searching for Workflow Scripts of a Specific Status Searching for a workflow script of a specific status is a feature of the Workflows view, which provides most of the search options available in Workflow Monitor. To search for workflow scripts of a specific status: 1. In the Status drop-down list, select the status of the workflow script you are looking. The Hit list pane displays the result of your search as soon as you click the desired status of workflow script. 2. (Option) Select the asterisk to search with no specified status. Searching for Workflow Scripts of a Specific Tenant If the multi-tenancy feature is available in your environment, you can search for the workflow scripts of a specific tenant in the Workflows view. In practice, you display the workflow scripts initiated by the users assigned to the selected tenant. The tenant is stored in the _Tenant system variable of the workflow script. To search for workflow scripts of a specific tenant: 1. In the Tenant list, select the tenant of the workflow script for which you are looking. If multitenancy is not supported in your environment, the list only shows the DEFAULT and * entries. The Hit list pane displays the result of your search as soon as you click the desired tenant. 2. (Option) Select the asterisk to search with no specified tenant. 30

44 Searching for Workflow Scripts within a Time Interval Searching for a workflow script that was processed during a specific time interval is a feature of the Workflows view, which provides most of the search options available in Workflow Monitor. You can define the interval to the exact second using the Startup time control elements. To search for workflow scripts that were processed within a specific time interval: 1. Click the Select start date icon. The calendar control opens. 2. Navigate to the date you want to use as the start of your interval. Use the list to define the year, and the forward and backward icons to skip a month forward or backward. 3. Click the date. The calendar control closes and the date you selected is displayed in the date box. If you reopen the control, you will see that the current date is marked blue, and the date you selected is marked yellow with a red frame. 4. Enter the start time of the interval in the text box beside the Select start date icon, using the HH:MM:SS format. 5. Repeat steps 1 through 3 using the Select end date calendar control and the corresponding end time text box to define the end time and date for the interval. 6. (Option) Use the list to the right of the end time text box to select a predefined time interval. - This hour - This day - Since yesterday - Since last week - Since last year The date boxes are adapted to the predefined interval you selected. 7. Click Refresh to apply the changes. The Hit list displays the workflow scripts that were processed within the time interval you defined. 31

45 Searching for a Workflow Script Using its ID If you know its ID, you can recall a workflow script in the Details view. To recall a workflow script using its ID: 1. In the Workflow ID text box of the Details view s Work pane, enter the ID of the workflow script. 2. Click Refresh. The Work pane and the Details pane display all available detailed information on the workflow script. 32

46 6 Displaying Detailed Information Interplay MAM Workflow Monitor provides access to detailed information on workflow scripts in two different ways. Displaying the Details of Workflow Scripts Displaying SWoDL Text Displaying the Details of Workflow Scripts In the Details view, the Details pane shows all available information on the workflow script. The set of information it displays is specific to the type of workflow script selected. There are three ways to access detailed information about a workflow script in the Details view: Using the Processes or Workflows view or directly using the Details view. To access information in the Details view using the Processes view: 1. Perform a search as described in Searching for Processes on page In the Hit list pane, show the workflow scripts of the processes. 3. In the Hit list pane, click the workflow script you want to display. To access information in the Details view using the Workflows view: 1. Perform a search as described in Searching for Workflow Scripts on page In the Hit list pane, click the workflow script you want to display. To access information directly in the Details view: 1. Enter the ID of the workflow script in the Workflow ID text box. 2. Click Refresh. The Work pane and the Details pane display all available detailed information on the workflow script. The variables are arranged in four groups that you can individually expand and collapse. In each group, the variables and their values are shown in alphabetical order. Information is displayed in a table that includes Variable name and Value. The rows of the table form hyperlinks: Clicking an entry inserts the attribute and value entries into the corresponding text boxes in the Work pane. For additional information on editing workflow scripts, see Editing Workflow Scripts on page 36.

47 Displaying SWoDL Text All workflow templates in Interplay MAM are written in Simple Workflow Definition Language (SWoDL). For additional information, see Interplay MAM SWoDL Reference, which was delivered with the software. You can display the SWoDL text for all workflow templates registered in Workflow Engine and for all workflow scripts that have already been processed or are still being processed. To display the SWoDL text of a workflow template: 1. Do one of the following: t In the Workflows view, select the workflow type you want to display in the Type list and click Show workflow. t In the History view, select the workflow type you want to display in the Workflow list, click Refresh and then click Show in the Information table. The Workflow <template name> window opens, displaying the SWoDL text of the selected workflow template. To display the SWoDL text of a specific workflow script: 1. Select the workflow script with the SWoDL text you want to display in the Details view. For additional information, see Displaying the Details of Workflow Scripts on page Click Show Workflow in the Work pane. The Workflow <template name> window opens, displaying the SWoDL text of the selected workflow script. 34

48 The Workflow <template name> window comprises the following elements and controls: Element Description 1 Updates the Current line and History entries while a workflow script is running. 2 Current line SWoDL line that is currently being processed. 3 History Includes the Step and Line columns. Entries in the Line column are linked to the corresponding lines in the SWoDL text. 4 Tooltip Toggle to turn the ToolTip off or on. If activated, the ToolTip displays the value when hovering the pointer over a variable. 5 SWoDL text Displays the SWoDL text of the workflow script and line numbering. 6 Opens the File Download dialog. For additional information, see Downloading SWoDL Templates on page (Option) To navigate the workflow script, do one of the following: t t Click a step or a line in the History element to jump to the corresponding line in the SWoDL text. Scroll the SWoDL text. 35

49 7 Editing Workflow Scripts Workflow Monitor provides the following options to edit workflow scripts: Editing the Values of Workflow Script Variables Editing Workflow Script Priorities Editing the Values of Workflow Script Variables c You can edit the values of workflow variables and constants in the Details view. Setting an incorrect value may lead to errors during the processing of the workflow script or may terminate the processing of the workflow script altogether. Editing the value of a system variable can result in serious system damage. To change the value of a workflow script variable: 1. Open the workflow script you want to edit in the Details view. For additional information on how to find a specific workflow script, see Displaying Detailed Information on page Click the variable you want to edit in the Details pane. The Variable text box and the Value text box of the Work pane display the corresponding information. 3. Edit the value. 4. Click Set. A security prompt opens. 5. Click OK. The security prompt closes. The changed value is applied to the variable.

50 Editing Workflow Script Priorities The processing of workflow scripts is scheduled according to each individual workflow script s priority. This priority is determined by the variable _Priority. The higher the value of _Priority, the higher the workflow script s priority. If several workflow scripts are available for processing, the workflow script with the highest priority value will be processed first. Per default, the value is set at 100. You can assign a higher priority to a workflow script for example, to force faster processing. To change the priority of a workflow script: 1. Open the workflow script you want to edit in the Details view. For additional information on how to find a specific workflow script, see Searching for Workflow Scripts on page 29. The view changes to the Details view. 2. Click the _Priority entry in the Details pane. The Variable text box and the Value text box of the Work pane display the corresponding information. 3. Edit the value. 4. Click Set. A security prompt opens. 5. Click OK. The security prompt closes. The changed value is applied to the variable. 37

51 8 Starting, Suspending, and Restarting Workflow Scripts Interplay MAM Workflow Monitor provides options to start, suspend, and restart workflow scripts manually. This may become necessary for maintenance or testing purposes, or to reduce server load. The following topics provide information about the options available in Workflow Monitor: Starting Workflow Scripts Suspending the Processing of Workflow Scripts Resuming the Processing of Workflow Scripts Restarting Workflow Scripts Starting Workflow Scripts You can start a workflow script in the Start view and process it in the Details view of Workflow Monitor. c To start a workflow script: 1. Open the Start view and select the workflow template of the script you want to start from the Workflow type list. The Variables pane displays a specific set of variables that corresponds with the type of the workflow template. 2. (Option) Check the Start in debug mode check box to process the workflow script manually and step by step. The workflow script automatically switches to the status Suspended after completing the first step of the processing. For additional information, see Restarting Workflow Scripts on page (Option) Set specific values for variables by entering them in the corresponding text boxes. This may become necessary to analyze a specific object, or for debugging purposes. Setting an incorrect value may lead to errors during the processing of the workflow script or may terminate the processing of the workflow script altogether. 4. (Option) Click Reset to remove all entries in the Value text boxes. 5. Click Start Workflow. The processing of the workflow script starts and the Details view is displayed. 6. Do one of the following: t Click Suspend to halt the processing. t Click Wake up to continue the processing. t Click Refresh to monitor the processing.

52 7. (Option) Uncheck the Debug mode check box and click Wake up to cancel the debug mode processing. Suspending the Processing of Workflow Scripts If you suspend a workflow script, Workflow Engine halts processing, and the state of the workflow script is saved in the database. You can do this, for example, to reduce server load. There are two ways to suspend the processing of workflow scripts in Workflow Monitor. You can suspend the processing of one or more workflow scripts simultaneously. To suspend the processing of a single workflow script: 1. In the Hit list pane of the Workflows view, click the workflow script you wish to suspend. The view changes to the Details view. 2. Click Suspend. The processing of the workflow script stops. To suspend the processing of one or more workflow scripts simultaneously: 1. In the Hit list pane of the Workflows view, select the workflow scripts you want to suspend. 2. In the select action list, select Suspend selected workflows and click Go! The processing of the selected workflow scripts stops. Resuming the Processing of Workflow Scripts There are two ways to resume the processing of workflow scripts in Workflow Monitor. You can resume the processing of one or more workflow scripts simultaneously. To resume the processing of a single workflow script: 1. In the Hit list pane of the Workflows view, click the workflow script you wish to resume processing. The view changes to the Details view. 2. Click Wake up. The processing of the workflow script resumes. To resume the processing of one or more workflow scripts simultaneously: 1. In the Hit list pane of the Workflows view, select the workflow scripts you want to resume processing. 2. In the select action list, select Wake up selected workflow scripts and click Go! The processing of the selected workflow scripts resumes. Restarting Workflow Scripts You can restart a workflow script, for example, to repeat a failed processing. 39

53 c To restart a workflow script: 1. Do one of the following: t t Click the workflow script you want to restart in the Hit list pane of the Workflows view. The view changes to the Details view. Enter the ID of the workflow script you want to restart into the Workflow ID text box of the Details view. For additional information on how to find a specific workflow script, see Searching for Workflow Scripts on page Click Restart workflow in the Details view. The Start view is displayed. In the Variables pane, the input variables are preset with the corresponding values of the original workflow script, if available. In all cases, the _OriginalID variable is set to the ID of the original workflow script. 3. (Option) Check the Start in debug mode check box to process the workflow script manually and step by step. During processing, the state of the workflow script, displayed in the Workflows view and the Start view, will automatically switch to Suspended after completing the first step. 4. (Option) Enter values in the text boxes of the Input variables or the variables tables. Setting an incorrect value may lead to errors during the processing of the workflow script or may terminate the processing of the workflow script altogether. 5. Click Start workflow. The workflow script starts as a clone of the original workflow script. The Details page is displayed with a new ID in the Workflow ID text box. The ID of the original workflow script is not overwritten. If you have checked the Start in debug mode check box, you can now continue processing the workflow script step by step by clicking Wake up. Uncheck the Start in debug mode check box at any time to resume processing the workflow script without interruptions. 6. Do one of the following: t Click Suspend to halt the processing. t Click Wake up to continue the processing. t Click Refresh to monitor the processing. Setting the State of a Workflow Script to Error You can manually set one or more workflow scripts in Suspended state to Error state for example, if a workflow script is stuck. To set one or more workflow scripts to Error state: 1. In the Hit list of the Workflows view, select the workflow scripts you want to set to Error. 2. In the Select workflow action list, select Set selected workflows to ERROR. 40

54 3. Click Go! A security prompt opens. 4. Click OK. A security prompt opens. 5. Click OK. A confirmation message opens. 41

55 6. Click OK. The message closes. In the hit list, the workflow script is displayed in red font. The entry in the Error message column reads: #99 workflow stopped manually. 42

56 9 Deleting and Hiding Workflow Scripts c Interplay MAM Workflow Monitor provides options to delete and hide workflow scripts. There is no Undo function for the delete process. Workflow scripts should only be deleted in emergencies, because rollback actions which may become necessary are not triggered by the delete process. Deleting a workflow script also removes it from the database. The following topics provide information about the delete options available: Deleting an Individual Workflow Script Deleting Several Workflow Scripts at Once Hiding a Workflow Template Deleting an Individual Workflow Script The Details view provides the necessary control elements to delete an individual workflow script. To delete an individual workflow script: 1. Do one of the following: t t Click the workflow script you want to delete in the Hit list pane of the Workflows view. The view changes to the Details view. Enter the ID of the workflow script you want to delete into the Workflow ID text box of the Details view. 2. Click Delete workflow. The Delete workflow <Workflow ID> security prompt opens. 3. Click OK. The security prompt closes. The workflow script is deleted and removed from the Details view.

57 Deleting Several Workflow Scripts at Once c The Workflows view provides the necessary control elements to delete one or more workflow scripts at the same time. There is no Undo function for the delete process. Workflow scripts should only be deleted in emergencies, because rollback actions which may become necessary are not triggered by the delete process. To delete one or more workflow scripts: 1. Select the workflow scripts you want to delete in the Hit list. 2. (Option) Select the All checkbox. All workflow scripts displayed in the Hit list are selected. 3. Select Delete selected workflows in the Select workflow action list. 4. Click Go! A security prompt opens. 5. Click OK. A security prompt opens. 6. Click OK. The security prompt closes and the selected workflow scripts are deleted and removed from the Workflows view. Hiding a Workflow Template The History view provides the necessary control elements to hide or reactivate a workflow template. 44

58 To hide a workflow template: 1. Select the workflow template you want to hide in the Workflow list. 2. Click Hide. A security prompt opens. 3. Click OK. The security prompt closes. The Attic pane is displayed in the History view. The workflow template is no longer displayed in the Workflow lists, Type lists, and Workflow type lists in all views of Workflow Monitor. To reactivate a workflow template: 1. In the Workflow list of the Attic pane, select the workflow template you want to reactivate. 2. Click Reactivate. A security prompt opens. 3. Click OK to reactivate the Workflow template. The security prompt closes. The Attic pane is no longer displayed. The workflow template is again displayed in the Workflow lists, Type lists, and Workflow type lists in all views of Workflow Monitor. 45

59 10 Uploading and Downloading Data c Interplay MAM Workflow Monitor provides controls to upload and download data. There is no security prompt when you overwrite a registered workflow template file by uploading a new workflow template file with the same name. The following topics provide information about the options available to upload and download data: Uploading Template Files Downloading SWoDL Templates Uploading Template Files The Upload view of Interplay MAM Workflow Monitor provides options to upload, register, and use a new workflow template file (*.wf) in your installation of Interplay MAM. Alternatively, you can overwrite an existing workflow template file. To upload a workflow template file: 1. Click Browse. The Choose File to Upload dialog opens. 2. Select the workflow template file (*.wf) you want to upload and click Open. The Choose File to Upload dialog closes. The name and location of the file you selected are displayed in the Workflow file text box. 3. (Option) Enter a description of the file in the Description text box. 4. Click Upload. A security prompt opens. 5. Click OK. The security prompt closes. A consistency check is performed during the upload, checking the syntax of the SWoDL text. Errors in the syntax are shown and the upload may be refused.

60 If the syntax is correct, the uploaded workflow template is activated and ready for use in your Interplay MAM installation. 6. (Option) If you uploaded a new workflow template, go to the Start view and click Refresh list. The new workflow template is available in the Workflow type list. Downloading SWoDL Templates You can download SWoDL information for a workflow template or for an individual workflow script for example, to save it as a backup or use it in an another Interplay MAM system. To download the SWoDL text of a workflow template: 1. Do one of the following: t In the Type list of the Workflows view, select the type of workflow template you want to download and click Show workflow. t In the Workflow list of the History view, select the workflow template you want to download and click Show. The Workflow <template name> window opens, displaying the SWoDL text of the selected workflow template. 2. Click Download to download the workflow template as a text file. The File Download dialog opens. 3. Click Save As. The Save As dialog opens. 4. Select the save directory and click Save. 47

61 The Save As dialog closes. The template is saved to the directory as a text file and the Download complete message is displayed. 5. Close the Workflow <template name> window. n To download the SWoDL text of an individual workflow script: 1. In the Details view, select the workflow script with the SWoDL text you want to download. For additional information, see Uploading Template Files on page Click Show Workflow in the Work pane. The Workflow <template name> window opens, displaying the SWoDL text of the selected workflow script. 3. Click Download to download the workflow script as a text file. The File Download dialog opens. 4. Click Save As. The Save As dialog opens. 5. Select the save directory. Although not necessary at this stage, Avid recommends use of the *.wf filename extension during the download process. 6. Click Save. The Save As dialog closes. The workflow script is saved to the directory and the Download complete message is displayed. 7. Close the Workflow <template name> window. 48

62 Index A Active task 24 Activity Data area 24, 26, 27, 27 Attic pane, elements 13 Attribute search options 17 Avid online support 9 training services 9 B Basic concepts processes 3 Simple Workflow Definition Language 3 SWoDL 3 watch service 3 workflow scripts 3 workflow templates 3 Business language 22 Button Browse 11 Delete workflow 8 Download 34 Go! 4 Hide 12 History 24, 26 Reactivate 13 Refresh 4, 8, 12, 26, 27, 34 Refresh list 10 Reset 10 Restart workflow 8 Set 8 Show workflow 4, 8 Start workflow 10 Submit 2 Upload 11 C Checking process and activity data 27 Class, searching for processes 15 Clipboard 27 Closing sub-process 26 Collapse all 27 Configuration, Workflow Monitor 2 Control flow 22 Control pane elements 10 illustration 4 layout 4 table 4 Copying data 27 D Data grid 27, 27 Default transition 22 Default, priority value 37 Deleting several workflow scripts 44 Deleting several workflows Workflows view 44 Deleting workflow scripts 43 Deleting workflows Details view 43 individual 43 Details pane, elements 9 Details view deleting workflow scripts 43 layout 7 via Processes view 33 via Workflows view 33 workflow ID 33 workflow scripts 33 Displaying graphical visualization of process 21 sub-process 26 sub-workflow scripts 19 workflow scripts of process 19 Displaying information Details view 33 Simple Workflow Definition Language 33 SWoDL 33 Download SWoDL 47 workflow template 47 E Editing values of workflow variables 36 workflow priorities 37 workflow scripts 36 49

63 Index Expand all 27 H Hidden workflow script, Attic pane 13 Hiding a workflow template, History view 44 History button 24 History pane, control elements 12 History slider 24, 26 History Slider area 24, 26 History view Attic pane 12 Cleanup pane 12 hiding workflow templates 44 History pane 12 layout 12 Hit list pane customizing 2, 3, 4, 6 illustration 3, 6 layout 3, 6 table 3, 6 I ID, searching for workflow scripts 32 Input variables 11 Interplay MAM Control Center 4 L Layout Control pane 4 Details view 7 History view 12 Hit list pane 3, 6 Processes view 1 Search pane 2 Start view 9 Upload view 11 Visualization area 22 Work pane 8 Workflows view 4 Lifecycle, searching for processes 16 M Microsoft Silverlight 1, 27 N Navigating through process history 24 Navigating, views 14 O Online support 9 Open in New Tab 26 Opening graphical process visualization 19, 21 workflow script details in Details view 19 Overview Details view 7 History view 12 Processes view 1 Start view 9 Upload view 11 Workflow Monitor 1 Workflows view 4 P Prerequisites 1 Priority value, default 37 Process basic concept 3 checking and refreshing data 27 copying data 27 displaying graphical visualization 21 displaying sub-process 26 end 22 history 24 navigating through history 24 searching 15 start 22 working with graphical visualization 22 Process Data area 24, 27, 27 Process Visualizer 21 opening 21 viewing graphical model of process 21 Visualization area 22, 24, 26, 27, 27 working with 21 Processes view accessing details for process 19 displaying workflow scripts of process 19 layout 1 searching for process class 15 searching for process lifecycle 16 searching for process time interval 16 searching for process title 17 searching for process with workflows 18 Q Quitting Interplay MAM Workflow Monitor 4 R Refreshing process and activity data 27 Restart workflow scripts 39 Resume workflow scripts 39 50

64 Index S Scheduling workflow scripts 37 Search operators 17 Search pane illustration 2 layout 2 table 2 Searching for processes 15 only with workflows 18 specific class 15 specific lifecycle 16 time interval 16 title 17 Searching for workflow scripts ID 32 specific status 30 specific tenant 30 specific type 29 started by processes 18 time interval 31 Show only Processes with Workflows check box 18 Show workflow 12, 13 Simple Workflow Definition Language basic concept 3 Specific workflow scripts, SWoDL 34 Start view, layout 9 Starting Workflow Monitor 4 workflow scripts 38 Status, searching for workflow scripts 30 Sub-Process 22 closing 26 displaying 26 history 26 Sub-workflow scripts 19 Suspend workflow 39 Suspend workflow scripts 38 SWoDL basic concept 3 displaying information 33 download 47 specific workflow scripts 34 workflow template 34 T Task Type 22 Tasks active 24 checking and refreshing data 27 completed 22 copying data 27 Decision 22 Delay 22 Script 22 State 22 symbols for 22 User 22 Template files, uploading 46 Tenant, searching for workflow scripts 30 Time interval, searching for processes 16 Time interval, searching for workflow scripts 31 Title, searching for processes 17, 19 Training services 9 Troubleshooting 9 Type, searching for workflow scripts 29 U Upload view layout 11 upload workflow template 46 Uploading template files 46 V Values details pane 9 editing 36 Variables details pane 9 input 11 other 11 Variables pane, elements 11 Views navigating 14 overview 1 Visualization area 22, 24, 26, 27 W Watch service basic concept 3 Work pane illustration 8 layout 8 table 8 Workflow Details view 34 Workflow ID, Details view 33 Workflow Monitor basic concepts 3 configuration options 2 features 1 Layout of the Views 1 overview 1 prerequisites for usage 1 quitting 4 starting 4 views 1 Workflow script basic concept 3 51

65 Index deleting individual 43 deleting several 44 editing 36 editing priority 37 hide 12 restart 39 resume 39 scheduling 37 searching 29 set state to error 40 start 38 suspend 39 Workflow script state, set to error 40 Workflow template basic concept 3 download 47 SWoDL 34 upload 46 Workflows view deleting several workflow scripts 44 layout 4 searching for workflow script ID 32 searching for workflow script status 30 searching for workflow script tenant 30 searching for workflow script time interval 31 searching for workflow script type 29 Working with graphical visualization 21 Z Zoom area 26, 27 52

66 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