Tibcoâ® Openspace User's Guide

Transcript

TIBCO® Openspace User's Guide Software Release 4.0 November 2015 Two-Second Advantage® 2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BPM, TIBCO Administrator, TIBCO Business Studio, TIBCO Enterprise Message Service, TIBCO General Interface, TIBCO Hawk, TIBCO iProcess, TIBCO JasperReports, TIBCO Spotfire, TIBCO Spotfire Server, and TIBCO Spotfire Web Player are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE), and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation in the U.S. and other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright © 2005-2015 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information TIBCO® Openspace User's Guide 3 Contents Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 TIBCO Documentation and Support Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13 Openspace Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Openspace and TIBCO ActiveMatrix BPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 User Access in Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Personas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Configuring the Standard Persona . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Resetting Persona Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 The Openspace Login URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Adding a Locale Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Adding a Login and Username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 Logging into Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Login Session Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Logging out of Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Welcome Page Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Localization Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Localizing Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 Localizing Gadgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Localizing Work Item Attribute Display Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 Tabs Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Creating Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Renaming Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Deleting Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Selecting Themes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Layouts Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Selecting Layouts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Gadgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Common Openspace Gadget Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Openspace Gadget Store . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 Adding Gadgets to a Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Adding New Gadgets to Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Deleting a Gadget From a Tab Using User Preferences Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Deleting Gadgets from Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 Work Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Public Work Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Work Views for an Organizational Entity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 Temporary Work Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Work View Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 TIBCO® Openspace User's Guide 4 Accessing Your Editable Work Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Creating Work Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Enter Work View Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Configure the Organizational Recipient . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Configure the Work View Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Configure Sorting Order for the Work View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Specify the Work Item Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Specify the Recipients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Specify the Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Editing Work Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Deleting Work Views from Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Removing Work Views from Your Work View List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Work Item Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Work Item State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Changing Work Item Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Refreshing Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Configuring Work Item Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Setting the Number of Work Items Displayed . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Searching for Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Displaying Visible Hidden Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Displaying Work Item Attribute Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Filter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Value Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 DateTime Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Filtering on Special Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Sort Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Specifying the Sort Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Specifying a Sort Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Allocating Work Items Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Allocating Work Items To Yourself . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Re-Offering Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Allocating Work Items to Another User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Allocate Work Items to Offer Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Allocating Work Items to the World . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Find a Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58 Processing Work Items Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Opening Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Opening a Work Item Using the Openspace URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 TIBCO® Openspace User's Guide 5 Auto-Repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Piling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Filling in a Work Item Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Work Item Data Modified By Other Users or System Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Progressing Stale Case References . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Saving Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Submitting Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Pending Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Unpending Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Skipping Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Canceling Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65 Executing Manual Ad-Hoc Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Process Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Process Template List Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Process Instance State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 Refreshing the Process Template List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Configuring Process View Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Increasing Page Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73 Searching for Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Starting a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Suspending a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Resuming a Suspended Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Canceling a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Purging Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Process Instance Migration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Migration Points . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Migration Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Determining if Migration is Valid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Process Migration Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 How to Migrate a Process Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Administering Halted Process Instances Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Viewing Halted Process Instances . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Progressing Halted Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Auditing Instances of Process Templates Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Displaying an Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Audit Trail Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Event Attributes in an Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Event Attribute Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Customizing Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Replaying the Graphical Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 TIBCO® Openspace User's Guide 6 Process Templates and Process Instances Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Process Template Filter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Process Instance Filter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Value Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Wild Card Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Specifying a Filter Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Sorting Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Sort Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Specifying the Sort Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Specifying a Sort Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Applying the Sort Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Business Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Business Services Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Business Service List Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Configuring Business Service Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Customizing Split . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Refreshing the Business Service List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Searching for Business Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Viewing Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Adding Categories as Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Removing Categories as Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Starting a Business Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Event Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Event Views Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Saving Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Creating Event Views Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Creating a Temporary Event List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Creating a List of Events Using the Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Editing an Existing Event List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Deleting Event Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Event Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Selecting Items and Event Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Event Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Filtering and Event Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Pre-defined Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Sorting and Event Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Event List Columns Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Specifying the Columns to Display in Event Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Specifying the Attributes to Display in Event Attribute Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114 TIBCO® Openspace User's Guide 7 Sub-Process Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Filtering Event Lists Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Base Filters and Refined Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Defining a Base Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Defining a Refined Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Accessing the Filter Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Filter Expression Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Specifying a Filter Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 Choosing a Filter Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Default Filter Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Modifying the Filter Grouping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Combining “All Of” and “Any Of” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 Selecting Filter Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123 Value Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 DateTime Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Dynamic Time-Period Point-in-Time Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 DataTime Ranges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Using Wild Card Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Applying the Filter Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Modifying an Existing Filter Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130 Viewing the Filter Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Sorting Lists in Event Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Accessing the Sort Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Selecting Sort Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Specifying Sort Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Specifying a Sort Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Applying the Sort Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 Sorting a List Using Column Headers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Auditing Process Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Base Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138 Overlay Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Calendar Aliases (References) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Calendar Time Zones . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Exclusions in Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 How Calendars are Resolved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Required System Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Calendar Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Displaying the Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Specifying Working Days Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 TIBCO® Openspace User's Guide 8 Editing/Deleting Working Hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Creating System Calendar Exclusions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Editing/Deleting Exclusions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Viewing Your Working Hours . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Creating Base Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 Creating Overlay Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Assigning Calendars to Organizational Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Opening Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Copying Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152 Editing Base Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Calendar Aliases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Adding a Calendar Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 Mapping a Calendar Alias to a new Calendar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Deleting a Calendar Alias . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Deleting Calendars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 Openspace and TIBCO Spotfire . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 The Spotfire Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Accessing the TIBCO Spotfire BPM Visualizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Reporting Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Selecting Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Viewing Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Adding Process Templates as Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Specifying a Date Range . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159 Specifying the Time Period . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Displaying the Current Status of Process Instances for Selected Process Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160 Displaying the Current Status of Work Items for selected Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Displaying the Average Duration of Work Items and Process Instances for Selected Process Templates . . . . . . . . . . . . . . 162 Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Logger Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .166 Displaying Messages in the Logger Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Setting the Message Level . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Turning Off Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Clearing the Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Copying the Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Saving the Logs to the Openspace Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Setting Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Webviews . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Rendering a Specific URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 Dynamically Rendering a URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171 TIBCO® Openspace User's Guide 9 Data Admin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Guidelines When Editing Case Model Database Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Retrieving CREATE Case Data Database Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Retrieving UPDATE Case Data Database Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180 Retrieving DROP Case Data Database Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Comparing Case Data Database Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Freezing Case Data Models . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 Case Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Using Case Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Performing an Advanced Case Data Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 Enter Advanced Search Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Configuring the Advanced Search Filter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Filtering Array Attributes in Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187 Configuring Sort Order for Advanced Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188 Performing an Ad-hoc Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Searching Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Editing Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Deleting Searches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Performing Case Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Managing Work Lists Associated With Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 Configuring Columns in Case Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Managing Processes Associated With Case Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194 Viewing Event Information Associated with Case Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Managing Case Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Managed Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Contributing a Gadget to the Hub Policy Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Using the Hub Policy Administrator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 Developing Managed Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Sample HubPolicy File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200 Openspace Managed Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201 Managed Events Topic Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Demo Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Accessing Crossframe Gadget Demo Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 GWT Application - Summary Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 JavaScript Application - Summary Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 JSON Message Format . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 Openspace - Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Accessing Openspace - Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Logging into Openspace - Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Using Gadgets in Openspace - Mobile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 TIBCO® Openspace User's Guide 10 Using To Do List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Work Item Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Processing Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 214 Allocating Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Using Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Viewing the Status of Selected Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 Using Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218 User Access in Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 System Actions Mapping to Openspace Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Accessiblility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 About User Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Navigating Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228 Login Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Business Services Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Work Views Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Process Views Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231 Datagrid Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 Datagrid Toolbar Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 Configuring Text Size . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 The Openspace Login URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234 Adding a Locale Code to the Openspace URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Logging into Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235 Login Session Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Logging out of Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Business Services Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 Business Service Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Customizing Business Service Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Sorting Business Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Viewing Business Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 Adding Categories as Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 238 Removing Categories as Favorites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 Searching for Business Service Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 239 Searching for Business Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 Refreshing the Business Service List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 Starting a Business Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 Work Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241 Work Item Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242 Customizing Work Item Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243 Searching for Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Refreshing Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 TIBCO® Openspace User's Guide 11 Displaying Work Item Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Displaying Visible Hidden Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Changing Work Item Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245 Allocating Work Items To Yourself . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 Allocate Work Items to Offer Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246 Re-Offering Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 Opening Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247 Auto-Repeat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 Piling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 Filling in a Work Item Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Submitting Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 Saving Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 Pending Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 Skipping Work Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 Canceling Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 Work Item Filter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 Specifying a Work Item Filter Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Wild Card Characters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Work Item Filter Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Value Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 DateTime Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254 Process Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 Process Views Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255 Process Instance State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Refreshing the Process Template List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Searching for Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Customizing Process Instance Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Auditing Instances of Process Templates Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Displaying an Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 259 Audit Trail Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Process Templates Filters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 Process Template Filter Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 Specifying a Filter Expression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261 Configuring Sort Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 Specifying a Sort Direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 TIBCO® Openspace User's Guide 12 Figures Graphical Audit Trail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .136 Event Viewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136 TIBCO® Openspace User's Guide 13 TIBCO Documentation and Support Services Documentation for this and other TIBCO products is available on the TIBCO Documentation site: https://docs.tibco.com Documentation on the TIBCO Documentation site is updated more frequently than any documentation that might be included with the product. To ensure that you are accessing the latest available help topics, please visit https://docs.tibco.com. Product-Specific Documentation Documentation for TIBCO products is not bundled with the software. Instead, it is available on the TIBCO Documentation site. To directly access documentation for this product, double-click the following file: TIBCO_HOME/release_notes/TIB_amx-bpm_version_docinfo.html where TIBCO_HOME is the top-level directory in which TIBCO products are installed. On Windows, the default TIBCO_HOME is C:\tibco. On UNIX systems, the default TIBCO_HOME is /opt/tibco. The following documents for this product can be found on the TIBCO Documentation site: ● TIBCO ActiveMatrix BPM SOA Concepts ● TIBCO ActiveMatrix BPM Concepts ● TIBCO ActiveMatrix BPM Developer's Guide ● TIBCO ActiveMatrix BPM Web Client Developer's Guide ● TIBCO ActiveMatrix BPM Tutorials ● TIBCO ActiveMatrix BPM Business Data Services Developer Guide ● TIBCO ActiveMatrix BPM Case Data User Guide ● TIBCO ActiveMatrix BPM Event Collector Schema Reference ● TIBCO ActiveMatrix BPM - Integration with Content Management Systems ● TIBCO ActiveMatrix BPM SOA Composite Development ● TIBCO ActiveMatrix BPM Java Component Development ● TIBCO ActiveMatrix BPM Mediation Component Development ● TIBCO ActiveMatrix BPM Mediation API Reference ● TIBCO ActiveMatrix BPM WebApp Component Development ● TIBCO ActiveMatrix BPM Administration ● TIBCO ActiveMatrix BPM Performance Tuning Guide ● TIBCO ActiveMatrix BPM SOA Administration ● TIBCO ActiveMatrix BPM SOA Administration Tutorials ● TIBCO ActiveMatrix BPM SOA Development Tutorials ● TIBCO ActiveMatrix BPM Application Management Guide ● TIBCO ActiveMatrix BPM Client Application Developer's Guide ● TIBCO Openspace User's Guide ● TIBCO Openspace Customization Guide ● TIBCO ActiveMatrix BPM Organization Browser User's Guide (Openspace) TIBCO® Openspace User's Guide 14 ● TIBCO ActiveMatrix BPM Organization Browser User's Guide (Workspace) ● TIBCO ActiveMatrix BPM Spotfire Visualizations ● TIBCO Workspace User's Guide ● TIBCO Workspace Configuration and Customization ● TIBCO Workspace Components Developer Guide ● TIBCO ActiveMatrix BPM Troubleshooting Guide ● TIBCO ActiveMatrix BPM Deployment ● TIBCO ActiveMatrix BPM Hawk Plug-in User's Guide ● TIBCO ActiveMatrix BPM Installation: Developer Server ● TIBCO ActiveMatrix BPM Installation and Configuration ● TIBCO ActiveMatrix BPM Log Viewer ● TIBCO ActiveMatrix BPM Single Sign-On ● Using TIBCO JasperReports for ActiveMatrix BPM How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, contact TIBCO Support: ● For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: http://www.tibco.com/services/support ● If you already have a valid maintenance or support contract, visit this site: https://support.tibco.com Entry to this site requires a user name and password. If you do not have a user name, you can request one. How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to the following web address: https://www.tibcommunity.com TIBCO® Openspace User's Guide 15 Openspace Overview Openspace is a web application that enables you to host gadgets and widgets. Gadgets and widgets are self-contained blocks of dynamic web content. The term widget means a standalone block of web content. A gadget typically comprises one or more widgets. Here, the term gadget is used to describe web content that can be hosted in the Openspace environment. Google also uses the term gadget. However, we are referring to gadgets developed specifically for use with Openspace. Using Openspace, you can add web content from different sources as gadgets and customize how they are displayed. Openspace provides a unified view of all your gadgets and acts as a gateway to your frequently used services. Openspace allows you to: ● add built-in gadgets that are developed, contributed and published by TIBCO developers, for example the Work Views and Business Services gadgets. ● add third party gadgets that are published as social gadgets, for example Google Maps. Using Openspace, you can select which gadgets you want to display and customize how they are displayed by choosing different layouts and themes. For example, you could choose to display native gadgets that have been developed by TIBCO, for example, the Work Views gadget and add them to Openspace alongside social gadgets like Google Maps. Openspace and TIBCO ActiveMatrix BPM Openspace provides an interface that allows you to connect to BPM runtime. Using Openspace, you can access and perform the functions you need to complete your daily tasks. For example, you can: ● view the work items in your work list. ● create work views so that only the desired work items are displayed. ● open work items and complete and submit the forms that are displayed. ● start process instances and business services. ● access the Openspace Gadget Store to add and remove gadgets. User Access in Openspace Openspace displays all functions, and shows all buttons and menu selections that are available, even though you may not be able to use those functions because of your access privileges. Access to functions in Openspace is controlled by system actions. System actions are modeled in the organization model that is built in TIBCO Business Studio. See TIBCO Business Studio Modeling User’s Guide for more information. Some Openspace functions are controlled by a single system action, some are controlled by multiple system actions, whereas some are not controlled by system actions at all. You must be logged in as a user that has privileges with the correct system actions assigned to them. If you do not have the correct privileges to use a particular function, an exception is displayed that includes an Authorization Failed message. See About User Access for a list of the functions and the system actions you need to access them. Personas Openspace uses personas to determine what layouts, themes and gadgets are displayed when you log in. You can create different personas that display different combinations of layouts, themes and gadgets TIBCO® Openspace User's Guide 16 according to the requirements of your users. This is useful because it means that users do not have to define these themselves when they first log in. To configure personas you must log in as a user that has a privilege with the Application Configuration system action assigned to it. System actions are configured in the Organization Modeler in TIBCO Business Studio, see TIBCO Business Studio Process Modeling User’s Guide for information. By default, Openspace provides two personas: ● Default. The default persona provides the following gadgets: — Business Services — WorkViews — Process Views — Reporting — Event Views — Organization — Calendar After the first log in, any user is free to change any of the settings as they wish. However, if the Openspace Administrator reapplies the settings, any changes that users have made to their settings are lost when the settings are reapplied. ● Standard. The Standard persona is initially blank. You can use the Standard persona to configure which themes and gadgets are displayed when users log in, depending on your requirements. If no Standard persona has been defined, the first time you log in to Openspace, the Default persona is used. Configuring the Standard Persona If you want to configure the layouts, themes and gadgets that are displayed when your users log in to Openspace, then you can define them using the Standard persona. When configuring layouts, you must be aware that: ● After the first log in, any user is free to change any of the settings as they wish. ● Users must log out and log in again for the new settings to take effect. ● Any changes that users have made to their settings are lost when the new settings are applied. Procedure 1. Log into Openspace as a user with a privilege that has the Application Configuration system action assigned to it. System actions are configured in the Organization Modeler in TIBCO Business Studio, see TIBCO Business Studio Modeling User's Guide for information. 2. From within Openspace, select the layouts, themes and gadgets you require. 3. Click Manage Settings. 4. From the Persona box, click the down arrow and select the Standard persona. 5. Click Save settings to save your new settings. If you want to apply the new layout to all users of Openspace, click Apply persona to all users, otherwise the new settings will only apply to new users logging into Openspace. 6. To clear the current settings and start again, click Delete Persona. TIBCO® Openspace User's Guide 17 ● If you delete the Standard Persona, it does not affect the settings of the users who have already logged into Openspace. It only affects new Openspace users who are logging in for the first time. If the Standard persona has been deleted, then new users logging in for the first time will use the Default persona. ● You cannot delete the Default persona. 7. Click OK. Resetting Persona Settings If you have changed your settings for a persona, you can return to the latest settings. Procedure ● To return to the latest settings, as defined by the Openspace Administrator, click Reset Settings from the main menu. The Openspace Login URL To access Openspace, you need to use the Openspace login URL. Procedure 1. Type the Openspace login URL into your browser. The URL is protocol://host:port/openspace where: is the communications protocol being used by Openspace, either http or https. This was determined at installation. ● protocol ● host ● port is the DNS name or IP address of the server hosting the BPM runtime. is the port being used by Openspace. The default value is 8080. After the browser connects, the Login screen displays. 2. Log in to Openspace with a valid BPM username and password. See About User Access. Adding a Locale Code You can enter a locale code as part of an extended URL in Openspace. For example: https://localhost:8080/openspace/openspace/?locale=en_GB If no locale is specified, Openspace uses the locale that your web browser is configured to use. See Localization Overview for more information about localizing Openspace. Adding a Login and Username You can enter a username and password as part of the extended URL. The username and password must be a valid BPM username and password. Due to the security implications of adding a username and password to the Openspace Login URL, TIBCO recommends only doing this if you are part of a corporate network. This method should not be used over an internet connection. To do this, add the following: TIBCO® Openspace User's Guide 18 ● username, in the format username=username where username is your BPM runtime login name. ● a password in the format of either, — auth0=password where password is the password of your BPM runtime login. The password must be supplied as plain text. — auth1=password where password is the password of your BPM runtime login. This password must be supplied as a Base64 encoded string. Note that you will need a Base64 encoder to encode your BPM runtime login password. For example: https://localhost:8080/openspace/?username=chill&auth1=cGFzc3dvcmQ You can create a desktop shortcut using the url to conveniently login to Openspace. For example: You can also create a desktop shortcut for another user, drag this into your browser and use it to conveniently login to Openspace as a different user. Refer to the documentation supplied with your operating system for information on how to create a shortcut. If the username and password is successfully authenticated by the BPM runtime, then the Login screen is not displayed. If the username and password fails to authenticate, the Login screen is displayed. TIBCO® Openspace User's Guide 19 Logging into Openspace Login to Openspace using your username and password. Out-of-the-box, Openspace recognizes the user name “tibco-admin” with a password of “secret”. This is the only user authorized to log in until another user is configured using the Organization Browser. By default, the tibco-admin resource is located in the System Resources container. Note that: ● you can configure this name using the AdminLdapName property in the de.properties file. See TIBCO ActiveMatrix BPM Administration guide for more information. ● you can configure the password in the LDAP directory, whether you are using either the internal BPM LDAP directory or an external LDAP directory. ● If you are running Openspace in an IPV6 environment, you must enter a resolved host name when logging in. You cannot log in using an IPV6 IP address. This is not supported and causes a null subscription handler error message to display. Procedure 1. Type your username into the Username field. 2. Press Tab to move to the Password field and type your password. 3. Press Tab to move to the Remember User Name checkbox. Press Spacebar to select it. This is useful if you do not want to type in your username every time you log in to Openspace. 4. If you want Openspace to use a different language from the default (American English or British English, depending on the default language of your browser), press Tab to Change Language and press Enter. A dialog displays the languages that are available. 5. Click the down arrow to select the language you require. Upon selection, the language changes automatically. 6. Press Tab to move to Submit and press Enter. Login Session Timeout If there is no activity in Openspace for 30 minutes, the gadget blanks out with a The browser has expired message. Tab to Reload and press Enter to reload the Openspace Login dialog. session Your system administrator can increase or decrease the session timeout using the sessionTimeout property in the OSProperties.properties file. See TIBCO ActiveMatrix BPM Administration guide for more information. Logging out of Openspace You can log out of Openspace at any time. If your environment is configured to use SiteMinder, and you haven't disabled the Logout button and you haven't configured Openspace to clear the SiteMinder session on logout, then logging out of Openspace by clicking Logout does not log you out of your Openspace session. If you try to access Openspace after clicking Logout, the Login panel displays, even though you are still logged in. The workaround is to click Logout and close your browser session, which clears the SiteMinder session. If you want to access Openspace again, start a new browser session. For more information about using Openspace with SiteMinder, see the TIBCO ActiveMatrix BPM Single Sign-On guide. It is good security practice to close a browser when you have finished as this closes the session to the server. TIBCO® Openspace User's Guide 20 Procedure 1. Close any currently open work items. 2. Click Logout in the upper right-hand corner of the Openspace screen. When you are successfully logged out, the Login window is displayed. You can choose to log in again, go to another web site, or close the browser. Welcome Page Overview The first time you login to Openspace, the welcome page is displayed. The welcome page enables you to quickly start using Openspace, depending on your requirements. It allows you to: ● perform activities, such as starting business services, viewing your work queues, performing administration tasks, or personalizing Openspace. ● find out more information by viewing the help or the most common questions asked about Openspace, for example. Once you have started using Openspace, you can view the welcome page at anytime by either: ● clicking browser window. ● selecting Help > Show Welcome. in the top right hand corner of your Localization Overview If Openspace is available in different languages, you can dynamically change both Openspace and the individual gadgets within Openspace to use different languages, depending on your requirements. You can: ● make the whole of Openspace available in a different language. If Openspace has been configured to use different languages, you can do one of the following: — select a different language when you log in, see Logging into Openspace. — once you have logged in, select a different language for Openspace. See TIBCO Openspace Customization Guide for more information. ● make individual gadgets within Openspace available in different languages, that are different from both Openspace and other gadgets. For example, Openspace may be configured to use French but you want to open a work item in the Work Views gadget that relates to an English speaking customer. From the Work Views gadget, you can select English (United States) from the Locale Selector drop-down list and translate the Work Views List gadget into English (United States) while the rest of Openspace remains in French. See Localizing Gadgets. ● localize the work item attribute display names, see Localizing Work Item Attribute Display Names. Localizing Openspace Once you have logged into Openspace, you can change the language that Openspace is using. Procedure 1. From Openspace, click Language. From the Locale Selector drop-down box, select the new language. TIBCO® Openspace User's Guide 21 2. From the Locale Selector drop-down box, select the new language. The next time you log in, Openspace uses the new language that you selected. Localizing Gadgets Once you have logged into Openspace, you can change the language that a particular gadget is using. Procedure 1. From the gadget whose language you want to change, click the down arrow ( The menu displays. ). 2. From the Locale Selector drop-down box, select the new language. The gadget displays in the new language you have selected. The next time you log in, the gadget uses the new language that you selected, even if Openspace is configured to use a different language. Localizing Work Item Attribute Display Names Work item attribute display names are stored in the TibcoColumnMessages.properties file. You can change display names by editing that file. If you want to change the work item attribute display names for Openspace’s default language (American English or British English, depending on the default language of your browser), do the following: Procedure 1. In a text editor, open the TibcoColumnMessages.properties file in the following location: \ \config_directory\tibco\datan\tibcohost\Admin-environmentname-adminservername \host\plugins\com.tibco.openspace.login_n\resources\locale ● where: config_directory is the Configuration directory that stores the BPM configuration files that you specified when you installed the BPM runtime software. TIBCO® Openspace User's Guide 22 ● datan where n is the version number of your TIBCO Administrator server. ● environmentname is the name of your BPM environment. ● adminservername is the name of your TIBCO Administrator server. ● n is the current version number of the Openspace application files. 2. Depending on your requirements, modify attributes 1-40. For example, attribute1=Customer Name. 3. Save the file. If you reinstall Openspace, the changes you have made will be lost, so either, amend the tibcoColumnMessages.properties file again or keep a back up copy of the file with your changes. Tabs Overview Tabs are a useful way of organizing your gadgets. You can create tabs and name them, depending on your requirements. You may want your TIBCO gadgets to be added to a tab called TIBCO and your social gadgets added to a tab called Social, for example. If you have logged in using the Default persona, several tabs are created for you automatically; see Personas for more information. Creating Tabs You can create a new tab at any time in Openspace. Procedure ● To create a tab, click beside the Business Services tab. A new tab is created. You can add a maximum of 9 tabs. Renaming Tabs You can rename tabs from the User Preferences area. Procedure 1. Select the tab you want to rename. 2. Click the tab name to display the User Preferences area. 3. From the User Preferences area, click Edit. The tab name is displayed. TIBCO® Openspace User's Guide 23 4. In the box, type the new name. 5. Press Return. TIBCO recommends that tab names are no longer than 12 characters as longer tab names may be truncated, depending on how many tabs you have. Deleting Tabs Tabs are deleted in the order they are added. This means you can only delete the last tab that you added. You must remove all gadgets from the tab you want to delete. Openspace does not allow you to delete all tabs. You must keep a minimum of one tab. Procedure 1. Select the last tab that you added. 2. Click the tab name to display the User Preferences area. 3. Remove all gadgets from the tab, see Common Openspace Gadget Functions. If you have not saved your data before removing a gadget then any unsaved data will be lost. Therefore, TIBCO recommends that you remove all gadgets from a tab before trying to delete it. 4. From the User Preferences area, click Delete. If you have not removed all the gadgets from your tab, the following message is displayed: TIBCO® Openspace User's Guide 24 5. Click OK to allow Openspace to remove the gadgets from the tab, or Cancel to remove the gadgets yourself. 6. If you click OK, Openspace displays a Remove this gadget? dialog for each gadget added to the tab. 7. Click OK to each of these dialogs. Finally, Openspace prompts you to delete the tab. 8. Click OK again to delete the tab. Selecting Themes Themes apply to the title bar of Openspace and to the gadget windows. Selecting different themes for different gadgets is a useful way of distinguishing between them. Procedure 1. Click the gadget whose theme you want to change: . 2. Click the gadget to display the User Preferences area. 3. From the Themes Gallery, select the theme you want to use. The gadget is automatically updated to use the new theme. 4. Repeat these steps for each gadget whose theme you want to change. Layouts Overview The Layout Gallery displays the layouts you can choose. When choosing a new layout you need to decide whether to divide your tab into 1, 2 or 3 boxes, then select the layout that you require. If you select 1 or 2 boxes, only one layout is available for each of these box choices. If you choose to divide your tab into 3 boxes, then there are two layouts you can choose from. TIBCO® Openspace User's Guide 25 In the Layout Gallery, once you select the number of boxes you require, the layouts available for that number of boxes are displayed. Each layout is displayed with its boxes numbered. If you apply a layout to a tab that has no gadgets added, then as you add gadgets to the tab, they are added to box 1 in the tab. You should then drag the gadgets into the other boxes, depending on your requirements. TIBCO recommend that you minimize all your gadgets as it makes them easier to drag to the new boxes. If you change an existing layout on a tab that already has gadgets added, then: ● If you select a layout that has the same number of boxes as the existing layout, the gadgets are automatically redisplayed according to the new layout you have selected. ● If you select a layout that has fewer boxes than the existing layout, the gadgets from the abandoned box are added to box 1. ● If you select a layout that has more boxes than the existing layout, then the tab is divided using the layout selected. The gadgets are automatically redisplayed according to the new layout you have selected. However, to populate the new boxes, you must drag the required gadgets into place. Selecting Layouts Use the Layout Gallery in the User Preferences area to change the layout of your gadgets. Procedure 1. Click the tab whose layout you want to change. 2. Click the tab name to display the Layout Gallery in the User Preferences area. 3. Click the box that contains the number of boxes you want the tab to be divided into. You can select 1, 2 or 3 boxes. The Layout Gallery displays only one layout for 1 and 2 boxes. For 3 boxes, two different layouts are provided. 4. Click the layout you require. The tab is automatically updated to use the new layout. TIBCO recommend that you minimize all your gadgets to make it easier to drag and drop them into the new layout. 5. Drag and drop the gadgets into the new layout, depending on your requirements. TIBCO® Openspace User's Guide 26 6. Repeat these steps for each tab whose layout you want to change. TIBCO® Openspace User's Guide 27 Gadgets There are a number of gadgets that are provided with Openspace but you can also add new gadgets. Gadgets are stored in the Openspace Gadget Store and are added to Openspace from there. You can remove a gadget from Openspace but, if it is still in the Gadget Store, it can be added again to Openspace at any time. You can delete gadgets from the Openspace Gadget Store completely. Once a gadget has been deleted from the Openspace Gadget Store it is no longer available for use in Openspace. Common Openspace Gadget Functions There are a number of functions that are common to all Openspace gadgets. On each individual gadget you can: ● Refresh. Select on the gadget to reflect any changes you have made or click menu and select Refresh from the drop-down list. ● Minimize/Restore. You can: to display the — on the gadget to minimize or click minimize or restore individual gadgets. Select display the menu and select Minimize/Restore from the drop-down list. — minimize or restore all the gadgets. Select to from the main menu to minimize and restore. ● Maximize. Select on the gadget to maximise or click from the drop-down list. ● Remove. Click ● Edit gadget properties. Click to display the menu and select Maximize to display the menu and select Remove from the drop-down list. to display the properties for the gadget. The type of properties you can set for the gadget are specific to the individual gadgets, although some gadgets do not have this option. See the relevant chapters for the preferences you can set for individual gadgets. ● Edit/Save. Click to display the menu and select Edit/Save from the drop-down list. Edit/Save is only displayed on the menu when some work has been performed in the gadget (if you have opened a work item and entered some data, for example). Each gadget has a status bar that displays the current status of the gadget, as shown below: The status bar shows information like whether there is a filter or sort criteria set for the gadget, for example. Openspace Gadget Store The Openspace Gadget Store divides the gadgets into different categories. When you click on a category, it displays the gadgets within that category. The number of gadgets in each category is displayed alongside the category name. For example All(n) where n is the total number of gadgets available in the Openspace Gadget Store. The following table describes the gadget categories. TIBCO® Openspace User's Guide 28 Category Description All(n) All the gadgets available within the Openspace Gadget Store. TIBCO(n) The TIBCO gadgets. For example, Work Views gadget, Business Services gadget and so on. From within the Openspace Gadget Store, you can: ● make gadgets available to Openspace, see Adding Gadgets to a Tab. ● add new gadgets to Openspace, see Adding New Gadgets to Openspace. ● delete gadgets from Openspace, see Deleting Gadgets from Openspace. Adding Gadgets to a Tab To display a gadget in Openspace, you must first add the gadget to a tab. You can only add a gadget to one tab at a time. You cannot add one gadget to two tabs at the same time. Procedure 1. Click the tab where you want to add the gadget . 2. Click the arrow next to the tab name to display the User Preferences area. The gadgets that are available to the tabs are shown in the User Preferences area. If a gadget has a white box around it, it has already been added to a tab. If it does not, it has not yet been added to any tabs. 3. If the gadget you want to add is shown in the User Preferences area, click it to add it to the tab. If the gadget you want is not shown, you must add the gadget to the User Preferences area from the Openspace Gadget Store. If the gadget is not shown in the User Preferences area, click Openspace Gadget Store displays. next to Get More Gadgets. The 4. In the left-hand pane, click on the category that contains the gadget that you want to add. The gadgets that are contained within that category are displayed. The gadget is added to the User Preferences area. 5. Click on the gadget you want to add, and then on . The gadget is added to the User Preferences area. Once the gadget has been added, is displayed in the Openspace Gadget Store. 6. Click to close the Openspace Gadget Store. 7. Click on the gadget to add it to the tab. The gadget is added and the User Preferences area of the tab now displays the gadget with a white box around it. Adding New Gadgets to Openspace You can add new gadgets to Openspace. You can do this in one of three ways. You can import an arbitrary web page and use it as a gadget in Openspace, import a gadget spec (in other words, a URL that ends with a filename with a .xml extension), import a gadget spec from a web site where no file .xml is specified (this relies on the web pages’ default document being a gadget spec). TIBCO® Openspace User's Guide 29 You must be logged in as a user that has privileges with the ContributeGadget system action assigned to it. To do this, you must specify the URL of the web page you want to add. The URL must point to an OpenSocial gadget that complies with OpenSocial Specification V0.8/V0.9. An OpenSocial gadget is hosted in a server infrastructure to provide its data. OpenSocial gadgets are part of the OpenSocial initiative. OpenSocial gadgets are web based UI components. A gadget is defined via an XML file which contains a header with definitions of the gadget and an embedded content payload. This payload is a combination of HTML and JavaScript which defines the gadget’s look and behavior. A very simple gadget looks like this: A gadget always has the root tag . This root tag contains a and a section. The contains information about which OpenSocial features are required by the module and information about the author. The content section contains the actual HTML and JavaScript. When adding a gadget to Openspace, note the following: ● ● When specifying a thumbnail or screenshot URL in : — If you do not specify a thumbnail or screenshot URL that is a publicly accessible URL, the gadget is displayed in Openspace as shown below: — If you do not specify any thumbnail or screenshot URL, then Openspace uses its default thumbnail or screenshot and the gadget is displayed in Openspace as shown below: If you do not specify a description in , Openspace defaults to Contributed Gadget[n] where n is an incremental number for each gadget you add that has no description. For more information: ● On the OpenSocial Initiative, see http://opensocial.org. ● On the OpenSocial Gadgets API Specification, see http://opensocial.org. Procedure 1. Click the down arrow of a tab to display the User Preferences area . TIBCO® Openspace User's Guide 30 2. Click next to Get More Gadgets. The Openspace Gadget Store displays. 3. Click next to Contribute Gadget. The Contribute Gadget dialog displays. 4. In the Gadget Spec URL box, type the URL of the gadget you want to add. Your system administrator can configure Openspace to display a specific Gadget Spec URL by specifying the path to the gadget server using the useConfiguredServerUrl property in the OSProperties.properties file. See TIBCO ActiveMatrix BPM Administration guide for more information. You can specify one of the following: ● a gadget spec (that is, a URL that ends with a filename with a .xml extension). See TIBCO ActiveMatrix Web Client Developer API Guide for more information. ● an arbitrary web page instead of a gadget spec (and use it as a gadget). In this case, select the URL is not a Gadget Spec - it is a web site. See below. ● a gadget spec from a web site where no file .xml is specified (this relies on the web pages’ default document being a gadget spec). 5. In the Hub Policy URL: box, type the URL of the Hub Policy for the Openspace Sample Gadget. The first part of the URL is always http://amxbpmhost:8080/openspace where amxbpmhost is the IP address of the machine hosting TIBCO Openspace. The rest of the URL is the location you specified in your HubPolicy xml. Once you have typed in the URL of your Hub Policy, the Hub Policy Administrator dialog displays. You can close this dialog as it is for informational purposes only. 6. In the Category of Gadget: box, type the name of the category where you want the gadget to be stored in the Openspace Gadget Store. If the category does not already exist, it is created automatically. If you do not specify a category, the gadget is stored in the UNCATEGORIZED category. 7. Ensure that the URL is not a Gadget Spec - it is a web site check box is selected. The URL is not a gadget spec - it is a website checkbox is automatically selected when you start to type in the Gadget Spec URL box. You can then configure the following: ● (optional) Select a checkbox to allow a user to edit the preference. If this checkbox is selected, it means that you can amend the URL of the gadget spec at a later date, if required. ● Add your own name and description for the gadget. ● (optional) Adjust the gadget height. ● (optional) Add URLs for Thumbnail image and Screenshot image of the gadget. 8. Click Import Gadget. The new gadget is added to the Openspace Gadget Store to the category you specified and is available to be added to a tab, see Adding Gadgets to a Tab. The content of gadgets within Openspace may change dynamically. You can specify whether the Openspace user should be able to edit dynamic content, by setting the isDynamicGadgetEditable property in the OSProperties.properties file. By default, this is set to false. To enable editing, it should be set to true. See TIBCO ActiveMatrix BPM Administration guide for more information. TIBCO® Openspace User's Guide 31 Deleting a Gadget From a Tab Using User Preferences Area Procedure 1. Click the tab that contains the gadget you want to remove: . 2. Open the Gadget Store. 3. Click the down arrow next to the name of the tab to display the User Preferences area. The User Preferences area displays the gadgets that are currently added to the tab with a white box around them. 4. To remove a gadget from the tab, hover your cursor over the gadget and click dialog is displayed: . The following 5. Click OK. The gadget is removed from the tab. The gadget is still in the User Preferences area and can be readded at anytime. To delete a gadget from the Openspace Gadget Store, see Deleting Gadgets from Openspace. Deleting Gadgets from Openspace If you no longer want a gadget to be available for use in Openspace, you can delete it completely. Once a gadget has been deleted from Openspace, you can add it again. See Adding New Gadgets to Openspace. Built-in TIBCO gadgets cannot be deleted from Openspace. Procedure 1. Click the down arrow of a tab to display the User Preferences area 2. Click . next to Get More Gadgets. The Openspace Gadget Store is displayed. 3. Click next to Manage Gadgets. The Manage Gadgets dialog lists the gadgets that are available in Openspace. It is divided into three columns: TIBCO® Openspace User's Guide 32 ● Preferred. This column shows the gadgets that have been added to a tab within Openspace. If the gadget has beside it, it has been added to the your User Preferences area. If a gadget is listed in the Preferred list, you cannot delete it from the Openspace Gadget Store. You must remove the gadget from your User Preferences area before you can delete it from the Openspace Gadget Store, see Deleting Gadgets from Openspace. ● Built-In. This column shows the gadgets that were provided with Openspace. If the gadget has beside it, it has been provided by Openspace and if it has nothing beside it, it has been provided by a third party. ● Delete. The Delete column shows which gadgets can be deleted from Openspace. If the gadget has beside it, it can be deleted. 4. To delete a gadget, click displayed. beside the gadget you want to delete. The following dialog is 5. To delete the gadget from Openspace, click OK. The gadget is deleted. 6. Click to close the Manage Gadgets dialog. TIBCO® Openspace User's Guide 33 Work Views Gadget The Work Views gadget displays your work lists and work views. The Work Views gadget displays: ● Work List - Your work list displays all the work items that you can work on. See Work Items for more information. ● Work Views - Work views are displayed below your work list and allow you to apply filter and/or sort parameters so that only the desired work items are listed in the work view. When you first login to Openspace, your work list is displayed and no work views are defined. When you click on a work item, its details display in the bottom pane. If you double-click on it, its form is displayed. The icons in the Work Views gadget are enabled or disabled depending on the context you are in. Public Work Views Work views can be either public or private. Private work views can only be viewed by you or others you specify. Public work views can be viewed by every Openspace user. If the public work view contains a work view and you have the view WorkList system action for the work list in the work view, you can load and view that work view. However, you cannot edit the work view unless you are an Owner or Author of the work view. See Accessing Your Editable Work Views for more information about assigning permissions to work views. You can specify whether or not a work view is public when you create it using the work view wizard. See Creating Work Views. By default, public work views are not displayed in your work view list in the Work Views gadget. You must load them. Procedure 1. Click . The Load existing view: Public views dialog is displayed. 2. Select the public views you want to load. You can select multiple public views. 3. Click Load selected view(s). The public work views display in your Work View list. If you have already added the view or you do not have permission to view the work view then an error message is displayed and the view is not added. Work Views for an Organizational Entity You can automatically create different work views of your own work list. However, if you want to create a work view of a work list belonging to an entity in an organization model, you must have the viewWorkList system action for the work list you require. Similarly, if you want to grant another user access to a work view of a work list belonging to an entity in an organization model, then that user must have the viewWorkList system action for the work list you require them to have access to. See Work View Permissions for more information about granting permissions to work views. You can create work views for: TIBCO® Openspace User's Guide 34 ● an individual resource ● an organizational entity such as an organization unit, group or position. Note that: ● When creating a work view of another organizational entity, only offered work items are displayed. These are work items that were offered to the selected organizational entity, and that still have a state of Offered. ● When viewing a work view for an organizational entity, you will only be able to see work items that are offered directly to that entity. You cannot see the work items for other entities in that organizational entity. For example, if you have created a work view for Group1 and Group1A is also a member of Group1, you must create a separate work view for Group1A. (You must also have the viewWorkList system action for Group1A). ● If a work view is for another organizational entity’s work list and not your own work list, then you cannot open or complete work items in that view. This is because TIBCO ActiveMatrix BPM always requires a user to process work items in their own work list. If you accessed a work item from your work view and then allocated (or pended) it to a user, it would move from your work list to the user’s own work list. This is confusing because it means a user could open a work item, only for it to disappear because it has been updated by another user. It could also be the case that you can view a work list but are not a member of the organizational entity whose work list you are viewing. In this case, you cannot open work items in that view. For example, if you have the viewWorkList system action for a group called Group1, and you create a work view for Group1, you will be able to see the work items in Group1’s work list but you will not be able to open them. System actions are modeled in the organization model that is built in TIBCO Business Studio. See TIBCO Business Studio Process Modeling Guide. Temporary Work Views A temporary work view is created when you perform a search in the Work Views gadget. For example, searching for id=123 would create a temporary view called id=123 to allow the search results to be viewed. Temporary views are automatically deleted once you log out of TIBCO Openspace. See Searching for Work Items. If you do not want to lose the temporary work view, create it using the Create new view wizard. See Creating Work Views. Temporary views cannot be edited but can be removed from your work view list. See Removing Work Views from Your Work View List. Work View Permissions You can assign permissions to your work view when you create it using the work view wizard. You can make your work views available to, either: ● individual users ● specific organizational recipients. If you assign an organizational recipient permission to a work view, all the child organizational recipients in the parent recipient inherit that permission, but the individual user must have the viewWorkList system action for the child organizational recipients. See Creating Work Views. Depending on how permissions have been assigned, a user can have the following access to a work view: TIBCO® Openspace User's Guide 35 Description Permissions Owner The user who created the work view. The Owner can view, edit and delete a work view from TIBCO Openspace. The Owner can specify authors and users of the work view. Note that if you are an Owner of a work view, you cannot remove it from your work view list. You always see work views that you are an Owner of. To remove a work view from your work view list, you must delete it from Openspace completely. See Deleting Work Views from Openspace. Authors Authors can view, edit and delete the work view. Authors can also specify users of the work view. If you have been specified as an Author of a work view, the work view is not displayed in your work view list by default. You must load the work view using Load an existing View. See Accessing Your Editable Work Views. Users Users can only view the work view. A user cannot specify any access to the work view. If you have been specified as a User of a work view, the work view is automatically displayed in your Work View list. If you are a user of a work view, you cannot remove it from your work view list. Only an Owner or Author can amend access to the work view or delete it from Openspace. Accessing Your Editable Work Views Work views that you have been given permission to edit (in other words, you have been made an Author of) are not displayed in your work view list by default. If you have been specified as a User of a work view, the work view is automatically displayed in your Work View list. You do not have to load it. To display a work view that you have been given permission to access, you must load the work view into your work view list. Procedure 1. Click . The Load existing view: Public views dialog is displayed. 2. Select Show editable views. A list of work views that you have permission to edit is displayed. 3. Select the work views you want to add to your work view list. You can select multiple work views. 4. Click Load selected view(s). The work views display in your Work View list. Creating Work Views The Create new view wizard enables you to create work views. The wizard enables you to: ● (Required) Enter the details for your work view, for example, the work view name and, optionally, its description. ● (Optional) Select the organizational entity whose work items you want to view. ● (Optional) Configure any filter criteria, depending on your requirements. ● (Optional) Configure any sort criteria, depending on you requirements. TIBCO® Openspace User's Guide 36 ● (Optional) Select the work item columns you want to display. See Work Item Columns for more information. ● (Optional) Configure the Recipients of the work view. ● (Optional) Configure the Authors of the work view. Note that: ● At any time while using the wizard, you can click on an item in the list on the right of the pane to go back and review/edit any of the information you have entered. Alternatively, you can use Previous and Next to scroll through the wizard. Some pages of the wizard have validation rules that must be satisfied before a different page can be selected. If a validation rule fails, a message displays showing the cause of the failure. ● Once you have clicked Finish, the work view is created. If you want to amend any of this to edit the work view. information at that point you must select ● To exit the work view without saving any changes, click ● Once you have entered the work view details, you can click Finish at any time to complete the wizard, for example, if you wish to specify sort/filter criteria but you want to display the default work item columns. Procedure ● Click the Create new view icon ( ) The Create new view wizard displays. Enter Work View Details The Details screen in the Create new view wizard allows you to enter the details for your work view, the work view name and, optionally, its description. Procedure 1. (Required) In the Name field, type a name for your work view. 2. (Optional) In the Description field, type a description of your work view. 3. (Optional) Select the Make this view public if you want to make the work view public. See Creating Work Views. 4. Click Next to continue. Configure the Organizational Recipient The Target screen allows you to configure the organizational recipient whose work items you want to view, for example, if you want to see all the work items for a particular organizational unit or location. Procedure 1. From the Type of View drop-down list, select one of the following: ● View is of user's own work list. Select this if this is a work view you are creating for other users to apply to their own work lists. ● View is of an entity in the organization model. Select this if you are creating a work view for a particular organizational entity. For example, an organization unit or location. TIBCO® Openspace User's Guide 37 This option is only available if you have the browseModel and resourceAdmin system actions. Openspace checks to ensure each entity you select when creating the work view can view the work list. Each entity must have the correct viewWorkList system action. If any entities to do not have this permission, the view is not created. A list of entities that do not have the required permissions are shown when attempting to complete the step. See Work View Permissions for more information. Organizations are modeled in TIBCO Business Studio Organization Modeler. See TIBCO Business Studio Process Modeling User’s Guide for more information. View is of all work items. Select this if you are creating a work view to view all work items in the system. You must have the viewGlobalWorkList system action for this option to be available. ● If you select this, Openspace checks to ensure you have the viewGlobalWorkList system action. If you do not have permission, the view is not created. If you selected View is of a user's own work list or View is of all work items, click Next to continue. If you selected View is of an entity in the organization model, go to step 2. 2. If you selected View is of an entity in the organization model, the Target screen displays. 3. From the Type of work items to show drop-down list, select either: ● View is of OFFERED work items. Select this if you want to see work items that are offered. ● View is of ALLOCATED work items. Select this if you want to see work items that are allocated. If a resource is selected this option is disabled as a view for a resource always shows both OFFERED and ALLOCATED work items. See Work Item State for more information. 4. From the Version drop-down list, select the version number of the organization model where the organizational entity resides. 5. You can either: ● Use the graphical display of the organization model in the left hand pane to drill down to the organizational entity you want to select. Clicking an organizational entity or an LDAP container in the left pane causes the resource list to be displayed in the right pane. If you select an organizational entity like a group or location, the work view displays the work items for all the child organizational entities in the parent entity. ● Use the Search function. a) To use the Search function, from the Criteria drop-down list, select the type of entity you require. This list contains the following: ● Resource - searches for a resource by name. ● Group - searches for a resource by group. ● Position - searches for a resource by position. ● Location - searches for a resource by location. rql - allows you to enter a string using rql to find resource. See the TIBCO Organization Browser User’s Guide for more information. b) In the Search box, type the search criteria you want to search for. You can use wild card characters, see Using Wild Card Characters for more information. You can use multiple wild card characters. ● c) Click . TIBCO® Openspace User's Guide 38 6. Click Show entity names if you want Openspace to display the internal name of the organizational entity, rather than its label. By default, Openspace displays the organizational entity’s label. Configure the Work View Filter The Filter screen in the Create new view wizard allows you to optionally specify filter criteria for the work view. If you do not want to specify any filter criteria, you can click Next to continue to the next screen in the Create new view wizard. Procedure 1. From the Filter on: drop-down list, select the work item column you want to filter on. See Work Item Columns for more information. 2. Click to display a dialog that allows you to configure your filter information for that particular work item column. The dialog allows you to select a logical operator. Logical operators allow you to choose how the specified value is to be compared to the actual values in the column. You can specify equal to, not equal to, less than, etc. The default is "equal to". 3. For each column indicator, use the value field to enter the value for the items you want returned. The way in which you enter a value depends on the data type for the column indicator you have selected. For example, to display all work items whose start date is prior to Oct. 1, 2010, select the Start Date column indicator, choose the “LessThan” logical operator, then choose Oct. 1, 2010 from the value field date picker. See Work Items for information on how to configure filters for each work item column. Once you have created your filter, the Server Filter String at the bottom of the dialog displays the actual filter string that is passed to the TIBCO ActiveMatrix BPM server. TIBCO® Openspace User's Guide 39 The Server Filter String always displays the default names for the filter criteria. For example, work item attributes always display as Attribute 1, Attribute 2 and so on. 4. (Optional) Define filter grouping. See Grouping for more information about defining groups. To do this: a) Select the filter criteria you want to group. Choose one of the following: ● No group - No filter grouping is configured. This is the default setting. ● New group - Add the currently selected filter criteria to a new group. Previous group - Add the currently selected filter criteria to a previous group. b) Click AND or OR, depending on your requirements. ● You can use the filter string at the bottom of the dialog to view your filter expression. 5. (Optional) Select Only show hidden items if you want to display hidden work items. 6. Repeat these steps for each item that you want to set filter criteria for. 7. To remove the filters, click ( ) beside the filter you want to remove. Configure Sorting Order for the Work View The Sort dialog in the Create new view wizard allows you to optionally specify sort criteria for the work view. If you click Next without specifying any sort criteria, the data is returned in an arbitrary order from the TIBCO ActiveMatrix BPM node. Procedure 1. From the left hand column in the pane, select the criteria to sort on. You can select multiple criteria. Click to move it to the right-hand column. 2. For the individual items, select the sort direction by clicking on the individual item, see Specifying the Sort Direction. 3. If you have multiple items in the list, specify the sort order of the items by clicking on or , see Specifying a Sort Order. Specify the Work Item Columns The Columns dialog in the Create new view wizard allows you to specify which work item columns to display. See Work Item Columns for more information. If you click Next without specifying any columns, the default work item columns are displayed. The default work item columns that will be displayed are shown in the Summary page of the wizard. Procedure 1. From the left hand column in the pane, select the columns you want to display. You can select multiple columns. 2. Click to move it to the right-hand column. For the individual columns, select the order in which you want them displayed by clicking on or . The top column in the list is shown on the left of the work list table, the other columns are then shown in order from left to right. TIBCO® Openspace User's Guide 40 Specify the Recipients The Recipients dialog in the Create new view wizard allows you to optionally specify the organizational entities who should be recipients of the work view. See Work View Permissions for more information. If you click Next without specifying any recipients, then no recipients are defined. On completion of this page, Openspace checks to ensure each recipient you have selected can view the work list. Each recipient must have the correct viewWorkList system action. If any recipients to do not have this permission, the view is not created. A list of recipients that do not have the required permissions are shown when attempting to complete the page. Procedure 1. From the Version drop-down list, select the version number of the organization model where the organizational entity resides. 2. You can either: ● Use the graphical display of the organization model in the left hand pane to drill down to the organizational entity you want to select. Clicking an organizational entity or an LDAP container in the left pane causes the resource list to be displayed in the right pane. If you select an organizational entity like a group or location, the work view displays the work items for all the child organizational entities in the parent entity. ● use the Search function. a) To use the Search function, from the Criteria drop-down list, select the type of entity you require. This list contains the following: ● Resource - searches for a resource by name. ● Group - searches for a resource by group. ● Position - searches for a resource by position. ● Location - searches for a resource by location. rql - allows you to enter a string using rql to find resource. See the TIBCO Organization Browser User’s Guide for more information. b) In the Search box, type the search criteria you want to search for. You can use wild card characters, see Using Wild Card Characters for more information. You can use multiple wild card characters. ● c) Click . 3. Click Show entity names if you want Openspace to display the internal name of the organizational entity, rather than it’s label. By default, Openspace displays the organizational entity’s label. Specify the Authors The Authors dialog in the Create new view wizard allows you to specify the organizational entities who should be authors of the work view. See Work View Permissions for more information. If you click Next without specifying any authors, then no authors are defined. TIBCO® Openspace User's Guide 41 Procedure 1. From the Version drop-down list, select the version number of the organization model where the organizational entity resides. 2. You can either: ● Use the graphical display of the organization model in the left hand pane to drill down to the organizational entity you want to select. Clicking an organizational entity or an LDAP container in the left pane causes the resource list to be displayed in the right pane. If you select an organizational entity like a group or location, the work view displays the work items for all the child organizational entities in the parent entity. ● Use the Search function. a) To use the Search function, from the Criteria drop-down list, select the type of entity you require. This list contains the following: ● Resource - searches for a resource by name. ● Group - searches for a resource by group. ● Position - searches for a resource by position. ● Location - searches for a resource by location. rql - allows you to enter a string using rql to find resource. See the TIBCO Organization Browser User’s Guide for more information. b) In the Search box, type the search criteria you want to search for. You can use wild card characters, see Using Wild Card Characters for more information. You can use multiple wild card characters. ● c) Click . 3. Click Show entity names if you want Openspace to display the internal name of the organizational entity, rather than its label. By default, Openspace displays the organizational entity’s label. Editing Work Views You can edit your work views at any time. Procedure 1. From the Work View pane, select the work view you want to edit. Click . The Work View wizard displays. 2. Follow the steps described in Creating Work Views to complete the wizard. Deleting Work Views from Openspace You can delete your work views from Openspace at any time. ● You must be an Owner or Author of a work view to be able to delete it. ● This deletes the work view from TIBCO ActiveMatrix BPM completely. If you only want to remove a work view from your work view list, see Removing Work Views from Your Work View List. TIBCO® Openspace User's Guide 42 Procedure 1. From the Work View pane, select the work view you want to delete. 2. Click . The following dialog displays. 3. Click OK to delete the work view or Cancel to return to the Work Views gadget. Any users who are accessing the work view lose access to the view and a message displays when they next try to access the view. Removing Work Views from Your Work View List You can only remove certain types of work views from your work view list. You can remove: ● all public views ● private views that are assigned to you can only be removed if you are the author ● temporary views If you are an owner of a work view, you cannot remove it from your work view list, you must delete it from Openspace. See Deleting Work Views from Openspace. Procedure ● Select a work view and click ( ). This does not delete the work view from TIBCO ActiveMatrix BPM altogether, it just removes it from your work view list. Work Items A work item represents an action item. It relates to a task in an active process instance. A user manages the work items in their work list by performing some sort of action upon them, such as entering data on a form, forwarding the item to another user or group, saving it and placing it back in the work list for further action at a later time, or by “submitting” it (completing the required action and sending it on to the next task in the process). Work Item Columns Work item columns show you information about the work items in your list. Not all columns are displayed by default. You can select which columns are displayed, either by using the Column Selector dialog (see Configuring Work Item Columns) or when creating a work view (see Creating Work Views) TIBCO® Openspace User's Guide 43 Column Name Description Name The name of the user task associated with the work item. This is specified in TIBCO Business Studio at design-time. Process ID A unique alphanumeric value identifying the process which is generated when a process is created. Process Name The name of the process from which the work item was created. Process Instance ID A unique alphanumeric value identifying the process instance from which the work item was created. Process Description A description of the process from which the work item was created. This is specified in TIBCO Business Studio by defining a data field called AMX_PROCESSDESC and adding it to the process at design-time. Activity ID Identifies the user activity within the process that generated the work item. This number can be used in Event Views to identify the work item across all components. Activity Name The name of the user activity within the process that generated the work item. Description The label of the user task associated with the work item. This is specified in TIBCO Business Studio at design-time. State The work item’s current state. See Work Item State. ID A unique number identifying the work item. Priority A numeric value indicating the relative importance of the work item. For more information, see Changing Work Item Priority. Start Date The scheduled date and time specified for the work item. Example: 2008-08-30 15:00:00. If no scheduled date and time has been specified for the work item, the column is empty. Deadline Contains a clock icon if the work item has a deadline by which the work item must be worked on and submitted. ● the work item has not missed the deadline. ● the work item has missed the deadline. Note that: Target Date ● Deadline is not displayed by default. You must select it from the column selector dialog. See Configuring Work Item Columns. ● Openspace compares the target date and time of the work item with the TIBCO ActiveMatrix BPM server’s date and time, not the date and time of your client machine. The date and time the work item is scheduled to be completed. Example: 2012-08-30 15:00:00 TIBCO® Openspace User's Guide 44 Column Name Description Visible Indicates whether or not the work item is visible. For information, see Displaying Visible Hidden Work Items. Group ID This identifies a number of work items that are grouped together in the process definition for some purpose. Distribution Strategy Describes the method used to distribute the work item when it was originally created, either offered or allocated. Schedule Status The schedule status indicates where the work item is within its schedule period. The schedule period is from the start date/time (shown in the Start Date column) to the target date/time (shown in the Target Date column). The schedule states are: Attribute 1 Attribute 40 ● BEFORE - The work item schedule period has not started yet. ● DURING - The work item is within the schedule period. When the schedule status is DURING, you cannot open the work item. ● AFTER - The scheduler period has completed. ● NO_SCHEDULE - No schedule period has been defined for the work item. These fields are used to contain data that is associated with a work item. They are specified in TIBCO Business Studio. Once these fields are specified they can be used to filter the work items in your work item list. See: ● See "Setting the Display Label for Work Item Attributes" in TIBCO Business Studio Modeling User's Guide. ● Localizing Work Item Attribute Display Names for information about localizing work item attributes. Work Type ID A unique alphanumeric value identifying the work type when the work type is generated. Work types are created in TIBCO Business Studio. Work Type Name The name of the work type. Work types are created in TIBCO Business Studio. Work Type Description The description of the work type. This is specified in TIBCO Business Studio when the work type is created. You can customize the columns that are displayed by using the Column Selector, see Configuring Work Item Columns. Work Item State The status of a work item determines what stage it has reached in the process. A work item can have various states. The State column in the Work Views gadget indicates the work item’s current state. The following table describes the possible states and their meanings: TIBCO® Openspace User's Guide 45 State Description OFFERED The work item is being offered to you to work on. When a work item is in an OFFERED state, you can: ALLOCATED ● open and work on the work item (while it is open, its state changes to OPENED), ● allocate the work item to yourself, causing it to be removed from all other user’s work lists, ● allocate the work item to another user, causing it to be removed from all work lists other than the user’s to which it was allocated, or ● skip the work item, causing it to be submitted and the process to advance to the next task (all required fields must be filled in). A work item with an allocated state appears only in your work list. Work items can be allocated to a specific user in the following ways: ● by the system when it is initially distributed, ● you can allocate a work item to yourself, ● you can allocate a work item to another user. CREATED The work item has been created, but not yet enabled. The functionality needed to get a work item to this state has not been implemented. OPENED The work item is currently opened and allocated to the user who opened it. The work item is removed from the work item lists of other users to whom the work item had been offered PENDED This occurs when you open a work item, perform some work on it, then close it without submitting it. Once it is in this state, the work item appears only in your list. Note that a work item does not go into a PENDED state if Re-offer work item strategy is set in the process template. If this is set then, if you close a work item without submitting it, the work item is reoffered to the offer set. See TIBCO Business Studio Modeling Guide for more information. PEND HIDDEN The filter criteria can be changed to view this state. See Displaying Visible Hidden Work Items. SUSPENDED The process template that these work items are associated with has been suspended. The work items will only be processed with the process template is resumed. Changing Work Item Priority All work items have a priority. Setting the work item priority enables you to sort your work list by priority. Also, scripts and processes can check the priority value and therefore perform actions based on a work item’s priority. The priority is a numeric value indicating the relative importance of the work item. By default, the work item priority is 50. You can change the priority of an individual work item or multiple work items, depending on your requirements. The valid range for work item priority is 1 - 100. You must enter a value in this range or an error is displayed. TIBCO® Openspace User's Guide 46 To change the priority of a work item, you must log in as a user that has a privilege with one or all of the following system actions assigned to it. ● changeAllocatedWorkItemPriority-This system action enables a user to change priority on work items with a status of Allocated and that is allocated to you. ● changeAnyWorkItemPriority-This system action enables a user to change the priority on all work items. This means if you want to change the priority of a work item in your work list whose status is Allocated, but it is not allocated to you, then you must also have authorization for the changeAnyWorkItemPriority system action. System actions are configured in the Organization Modeler in TIBCO Business Studio, see TIBCO Business Studio Modeling User’s Guide for information. Procedure 1. From the Work Views gadget, select the work item or multiple work items whose priority you want to change. 2. Click ( ). The Change priority of selected work items dialog displays. 3. Select one of the following: For each of these options you must set the priority to a numeric value within the valid range for work item priority. The valid range is 0 - 100. ● Default priority. If no priority has been specified, the work item priority is automatically set to 50. Select this if you want to reset the priority of the work item to the default. ● Average priority. If you have selected more than one work item, Openspace calculates the average priority of the selected work items and sets the priority of the work items to the average. ● Custom priority. Select Custom priority to enter a specific work item priority. You can: — Select Absolute and enter a specific numeric value in the box. — Select Relative priority. Enter a specific numeric value in the box and then use the arrows to offset a work item priority by a specific numeric value. For example, an employee is away on holiday and you want to offset the priority on all their work items by 20. 4. Either click OK to save your changes or click Cancel to exit the dialog without saving your changes. TIBCO® Openspace User's Guide 47 Refreshing Work Items Your work views that are initially displayed are a snapshot of the work items at that point in time. You can refresh the work view to get the most recent list of work items. You can refresh work items by using the gadget, or set up a custom refresh interval. from the Work Views gadget and Openspace automatically refreshes, ● Click ● Configure the Work Views gadget to automatically refresh the list at specified intervals. By default this is set to 0 which means auto-refresh is turned off. a) From the Work Views gadget, click . The configure auto refresh dialog is displayed. b) In the auto refresh interval (seconds) box, type the number of seconds you would like between refreshes (the minimum you can specify is 30 seconds), or 0 to turn off auto refresh. c) Click OK. Configuring Work Item Columns You may want to configure your work item list so that only certain columns are displayed. Procedure 1. Click ( ) and select the columns you want to display from the drop-down list. 2. Click away from the list to save your changes. The work item list is now displayed based on the columns you chose. Setting the Number of Work Items Displayed You can configure the number of work items that are not displayed in the Work Views gadget. Procedure 1. Click 2. In the Page Size box, type the number of work items you want to be displayed. By default, this is 8. The maximum page size you can set is 99. 3. Click away from the dialog to close it. TIBCO® Openspace User's Guide 48 Searching for Work Items If you have a large number of work items in your work item list, you can use the search feature to search for a specific work item. For example, you could select a column indicator of State and enter OPENED to search for all work items in your list with a status of OPENED. Procedure 1. In the Search box, click the down arrow. 2. Select a column indicator to search on from the drop-down list. You can search on Category, Name, Description, State or Priority. See Work Items for more information. 3. In the Search box, type the search criteria you want to search for. You can use wild card characters, see Using Wild Card Characters for more information. You can use multiple wild card characters. 4. Click . A temporary view is created. For example, searching for id=123 would create a temporary view called id=123 to allow the search results to be viewed. Temporary views are automatically deleted once you log out of TIBCO Openspace. If you do not want to lose the temporary work view, create it using the Create new view wizard. See Creating Work Views. Displaying Visible Hidden Work Items You can display hidden items by using the Configure Filter dialog. There are two reasons why work items in your work item list may be hidden. ● They are work items that are associated with a process instance that has been suspended (see Suspending a Process Instance). ● They are work items that have been pended, that is, a timer has been set to make them hidden until a specified date/time, or for a specified period of time (see Pending Work Items). You can display hidden work items in your work item list by configuring a filter expression. Procedure ● From the Configure Filter dialog, select Only show hidden items. TIBCO® Openspace User's Guide 49 Displaying Work Item Attribute Names TIBCO ActiveMatrix BPM allows you to define work item attributes and work item attribute facades at design-time in TIBCO Business Studio. Work item attributes can be populated by a script in a process. They can be used to contain data associated with a work item. Work item facades allow you to define different display names for your work item attributes. You can configure how Openspace displays the work item attribute names in Work Views. By default, the default work item attribute names display, for example, Attribute 1, Attribute 2 and so on. Procedure 1. From Work Views, click . 2. From use attribute display names, click one of the following, depending on your requirements. ● use system default (the default). The system default displays the default work item attribute names, for example, Attribute 1, Attribute 2 and so on. ● true. Select this if you want to override the system default and display the work item attribute facade names. ● false. Select this if your system default has been set to true and you want to override the system default and display the default work item attribute names, for example, Attribute 1, Attribute 2 and so on. See TIBCO Openspace Customization Guide for information on the config.properties file and how to use it. 3. Click anywhere in the Work Views gadget to close the dialog. Filter Criteria Openspace allows you to configure filter criteria for either/or work items in your work list or work views. This allows you to filter the list of work items in your work list or work view so that only some of the work items are shown, rather than all of them. Filtering allows you to display only the work items you are interested in. For example, you may only be interested in work items that arrived in the work item list after Dec. 15, 2007. You can filter the list so that only those work items are shown. TIBCO® Openspace User's Guide 50 You can filter on all the available work item columns and their data types. See Work Item Columns for more information. You cannot use wild card characters when specifying filter criteria in the Work View gadget. You can configure filter criteria in two ways: ● To configure filter criteria for your work list, click information on how to complete the dialog. ● To configure filter criteria for a work view, use the Filter dialog in the Create new view wizard to build a filter expression that is applied to all work items in the work view. See Configure the Work View Filter for more information. . See Configure the Work View Filter for Value Data Types When configuring filter criteria, the value entered in the Value field must match the data type for the attribute selected. The following describes the valid data types: Data Type Description Number Consists of one or more of the numbers 0-9. Used for things like work item ID and priority. The data entry field for numeric values will not allow you to enter any characters other than numbers. String Consists of any number of letters, numbers, or special characters (for example, #, $, etc.). Used for things like process instance ID and work item description. Filtering on text is case sensitive. If you are filtering on text that contains any of the four special characters (*, ?, ‘, or \), they must be “escaped”. For information, see Filtering on Special Characters. Date Dates can be entered by using the “date picker” on the filter data-entry dialog. Times, if specified, must be entered manually. If you enter a date, but not a time, it assumes “all times” for the specified date. All times use the 24-hour clock. There is also a special "Today" entry that can be used when filtering on DateTime attributes. This entry always represents the current date. For more information about entering dates and times in the Filter data entry dialog, see DateTime Data Types. Enumeration Select a valid entry from the drop-down list. DateTime Data Types When configuring filter criteria for dates and times attributes, they must be specified a certain way. ● Dates can be entered using the date picker, which is the Calendar icon to the right of the date field. Clicking on the Calendar icon displays a calendar from which you can choose the desired date — the selected date is automatically entered in the date field. ● Times are optional. If entered, they must be entered manually, in the following format: hh:mm:ss.nnn where: TIBCO® Openspace User's Guide 51 ● hh = hour (using the 24-hour clock) ● mm= minute ● ss = second For example: 15:30:00 If the time is not specified, Openspace assumes “all times” for the specified date. For example, if you specified “Start Date = 2008-10-04”, with no time, it will return all work items that were started on Oct. 4, 2008, regardless of the time they were started. If desired, you can enter just a portion of the time, starting from the left. For instance, you can enter just "10" in the first of the time fields — this means "all times that begin with 10 o’clock". Filtering on Special Characters When building a filter expression that is filtering text, there are four special characters that must be "escaped" in the filter expression. To “escape” a character means to precede that character with another character in the filter expression so that the system knows that you are filtering on the literal character, rather than intending that the character take on its special meaning. the following four special characters, the special character must be “escaped” in the filter expression: ● * (asterisk) ● ? (question mark) ● ‘ (single quote) ● \ (back slash) For example, if you just included an asterisk or question mark, it would take on its special meaning as a wild card character. See Using Wild Card Characters. The character that you precede the special character with depends on what you are filtering (work items, process instances, or events), as shown in the table below (although it is most often a back slash). Character to match literally Events * \* ? \? ' \' \ \ Note that for the back slash character when filtering work items or process instances, a single back slash is shown in the table, which means no escape character is needed in those situations. As an example, if you are filtering for events for a resource (Principal name) by the name “Jon O’Reilly”, you would need to escape the single quote in the name with a back slash character. TIBCO® Openspace User's Guide 52 Grouping You can group filter criteria together to create more complex expressions. When combining filter criteria, you are essentially combining logical ANDs and ORs in a single expression. A filter grouping that is added subordinate to another filter grouping is enclosed in parentheses when the system builds the filter syntax; this means that the subordinate grouping is evaluated separately, then its result is used to evaluate the parent grouping. To view work items that have a start date equal to October 1, 2010, and have a priority of 1 or 2, build the following filter expression: To view work items that have been cancelled, or that have been suspended and has a priority of 1, build the following filter expression: TIBCO® Openspace User's Guide 53 Sort Criteria Openspace allows you to configure sort criteria for either/or work items in your work list or for work views. This allows you to list the work items in your work list or work view in a desired order. For example, you may want to list all work items by priority number, then sort those by start date, from oldest to most recent. Applying sort criteria allows you to choose which columns in the work item list to sort on. You can sort on all the available work item columns. You can configure sort criteria in two ways: ● To configure sort criteria for your work list, click . See Configure Sorting Order for the Work View for information on how to complete the dialog. ● To configure sort criteria for a work view, use the Sort dialog in the Create new view wizard to specify the sort order of work items in the work view. See Configure Sorting Order for the Work View for more information. Specifying the Sort Direction Individual sort criteria can be sorted in ascending or descending order. They are set to ascending order by default when you add them to the list. You can specify the sort direction of the individual criteria by clicking on the item. For example: TIBCO® Openspace User's Guide 54 Specifying a Sort Order Sort order is applicable only if you have specified multiple sort attributes. It allows you to specify that the list be sorted first on one attribute, then on another attribute, and so on. In this example, all work items with a priority of 1 are listed first — those work items are then sorted by start date. Then all of the work items with a priority of 2 are listed — those work items are then sorted by start date, and so on. (Note that for this example both attributes are sorted in "ascending" order). Allocating Work Items Overview A work item can be allocated to a specific user. This means that the work item is supposed to be worked on by that specific user - the work item only appears in your list with a state of ALLOCATED. A work item can be allocated to a specific user by BPM when the work item is created. When a process is being defined in TIBCO Business Studio, a distribution strategy is specified for each user task (each work item results from a user task in a business process). The distribution strategy specifies how to distribute, at runtime, a work item that is generated from the user task. The distribution strategy will be one of the following: ● Offer - This means the work item is being offered to you to work on. Note that depending on how the user task that resulted in the work item was defined, the work item may be offered exclusively to you, or it may be offered to a group of users, any of whom can open and work on it. If a work item is offered to a group of users, and you open and work on it (for example, you enter or change some data in the work item), the work item is removed from the work list of all other users. ● Allocate - This means the work item was given only to you to work on. There are also functions available from the Work Views gadget that allow you to allocate a work item to yourself or to another user. You can also change a work item that is allocated to you back to an OFFERED state, so that other users can work on it. Allocating Work Items To Yourself This function allows you to allocate one or more work items to yourself. It changes the work item’s state to ALLOCATED so that only you can work on them. The work items are removed from the lists of all other users. This function can only be used if the work items are currently being offered to you; that is, their state is OFFERED. Procedure 1. Select one or more work items in the work item list that currently have a state of OFFERED. from the Work Views gadget. 2. Click The work items are now allocated only to you, and are removed from all other user’s work item lists. TIBCO® Openspace User's Guide 55 Re-Offering Work Items This function allows you to change work items that are currently allocated to you (state = ALLOCATED) or that you have modified (state = PENDED), back to an OFFERED state. They are offered to the users to whom they were originally offered. Procedure 1. Select one or more work items in the work item list that currently have a state of ALLOCATED or PENDED. 2. Click from the Work Views gadget. The work item’s state changes to OFFER, and it reappears in the work item list of the users to whom it was originally offered. If the work item’s state is PENDED, and data had been added/changed on the form when it was open, that data is retained in the work item when it is re-offered. Allocating Work Items to Another User This function allows you to allocate work items to another user. It removes the work items from your work item list, then adds them to the Inbox of the user to whom you have allocated them, with a state of ALLOCATED. You can choose the user to whom you want the work items to be allocated either from: ● the original "offer set", that is, the group of users to whom the work item was originally offered, or ● the "world", that is, all available users. Allocate Work Items to Offer Set The Allocate selected work items to offer set function allows you to allocate one or more work items to a user from the original offer set, that is, the group of users to which the work items were originally offered. Work items allocated to the original offer set can have a state of OFFERED, ALLOCATED, or PENDED. Procedure 1. Select one or more work items in your work item list. 2. Click from the Work Views gadget. The Allocate Work Item to Offer Set dialog is displayed. TIBCO® Openspace User's Guide 56 This dialog allows you to choose the user to whom you would like to allocate the work items. If you have selected multiple work items to allocate, the list of users displayed only includes the users that are in the offer sets of all of the work items you selected. This could possibly include zero users. 3. Select the user you want to allocate the work item to. 4. Click OK. Result The work items appear in the work item list of the user that you selected, with a state of ALLOCATED. Allocating Work Items to the World This function allows you to allocate one or more work items to any available user. You can only select this function when work items have a state of ALLOCATED or PENDED. To use the Allocate work item to world tool, you must be logged in as a user with a privilege that has both the reallocateWorkItemToWorld and resourceAdmin system actions assigned to it. Procedure 1. Select one or more work items in the work item list that currently have a state of PENDED or ALLOCATED. 2. Click from the Work Views gadget. The Allocate Work Item to world dialog is displayed. TIBCO® Openspace User's Guide 57 This dialog allows you to choose the user to whom you would like to allocate the work items. You may not be able to see all resources mapped to a particular position because there may be resources mapped to a position that were created in an LDAP container for which you don’t have visibility, (because of an organization relationship). In these cases, you will not see that resource when viewing the position. (This applies only to positions, not to groups.) Note, however, the counts shown to the right of the position name in the left pane is the total count for the resources in the position. From this count, you can determine if there are resources mapped to the position that you cannot see. For more information, see the "Container Organization Relationships" section in the TIBCO Organization Browser User’s Guide. Also, if a resource has been mapped to a position or group with a start date that has not yet occurred or an end date that has passed, that resource will not appear in the resource list. However, the total count of resources shown to the right of the group or position name in the left pane also reflects those resources that are not yet “effective” because their start date has not occurred. 3. From the Version drop-down list, select the version of the organization model that contains the resources you want to allocate the work item to. TIBCO® Openspace User's Guide 58 4. Click on an organizational entity in the left to which the user has been mapped. The users that are mapped to the selected entity are listed in the resource list in the right pane. Optionally, you can use the Search button ( ) to help locate the resource, see Find a Resource. 5. From the resource list, click on the user to whom you would like to allocate the work items. 6. Select Show entity names if you want Openspace to display the internal name of the organizational entity, rather than it’s label. By default, Openspace displays the organizational entity’s label. 7. Click OK. Result The work items will appear in the Inbox of the user that you selected, with a state of ALLOCATED. Find a Resource The Find function allows you to find the desired resources in a list of resources. It is available from the Allocate work items to world dialog. Using the Find function, you can search for any matching text in any of the columns on the list of resources. For example, you can search for all resources who have a resource name containing “Johnson” by searching on the Resource Name column. Procedure 1. On the Allocate work items to world dialog toolbar, click , or select Find Resources from the Tools menu. This causes the criteria fields to be displayed above the list of resources: 2. From the drop-down list, select the criteria you want to search for: This list contains the following: ● Resource - searches for a resource by name. ● Group - searches for a resource by group. ● Position - searches for a resource by position. ● Location - searches for a resource by location. ● rql - allows you to enter a string using rql to find resource. See the TIBCO Organization Browser User’s Guide for more information. . For example, if you select Resource, and enter 3. Enter the text you want to search for, then click John in the Find field, the Find function returns all resources whose Resource Name contains John anywhere in the Resource Name value. TIBCO® Openspace User's Guide 59 4. After finding the desired resource, you can perform any of the available functions as described in this document. The Find function is turned off by clicking . Processing Work Items Overview A work item represents a task in a business service. Typically, a work item has an electronic form associated with it that must be opened and filled out (some forms only display information and do not have fields to fill out). You can save the work item in your work item list so that it can be opened again and completed at a later time. When the form is completed, the work item is submitted so that the business service can progress, possibly resulting in another work item that represents the next task in the process. When you click a work item, an information pane is displayed. The pane contains two tabs, Details and Preview. If you want to hide the information pane, click . ● Click Details to display information about the work item such as, its name, summary, state, version and so on. See Work Item Columns for more information. ● Click Preview to displays the available form fields and any data that they contain. For work items associated with page flows, no preview is displayed. Opening Work Items Opening a work item causes the form associated with that work item to be displayed. You can open work items in the following ways: ● From the work item list, double-click the work item you want to open. ● in the Work Views gadget. This causes the Once you have finished working on the forms, click next available work item to be opened in the work item list, where available means a work item that TIBCO® Openspace User's Guide 60 is not locked or suspended. If there is no work item currently selected, the first available work item in the list is opened. If you select , and there are no available work items, a No message is displayed. available work items to open You cannot open multiple work items in Openspace. Opening a work item causes OPENED to be shown in the State column. The work item is allocated to the user who opened it and is removed from the work item lists of other users to whom the work item had been offered. If you open a work item and receive the following error: it means that the work item has been configured to use a user-defined form. User-defined forms cannot be displayed in Openspace. If you want to use user-defined forms, you must provide your own form identifier and render your own forms. Opening a Work Item Using the Openspace URL TIBCO ActiveMatrix BPM supports a pushed distribution model. In other words, when a work item is generated, an email notification is sent to you. The email contains the URL of the work item, which you can click to open and process the work item. For example, http://10.97.109.132:8080/openspace/ openform/OpenForm.html?id=158&version=0. You are required to authenticate yourself with Openspace before you can open work items. How you are required to do this depends on how the authenticate property has been set in the Openspace config.properties file. See "Configuring Authentication" in the Openspace Customization Guide for more information. Depending on the value of the authenticate property, if you are already logged into Openspace, you may be able to use the authentication provided in the current session. If not, you can add a username and password to the Openspace URL or log in using the Openspace Login panel. See Adding a Login and Username for more information. Prerequisites ● To enable email notification of work items, you must configure the presentation channels for a particular project or entire workspace in TIBCO Business Studio. See "Presentation Channels" in the TIBCO Business Studio Modeling Guide for more information. ● You must specify which organizational entity is going to receive the work items. See "Specify an Organizational Entity Push Destination" in the TIBCO Organization Browser User Guide. ● If, when you installed your BPM runtime you specified localhost in your client properties, the Openspace URL in the email points to localhost rather than the actual address for TIBCO Openspace. As the work item is not on the localhost, the link does not resolve. To change this, you must amend the BaseOSFormAppUrl property in the EmailChannelProperties.properties file. See "Configuring the Email Presentation Channel" in the TIBCO ActiveMatrix BPM Implementation Guide. TIBCO® Openspace User's Guide 61 Procedure 1. When the process is started, the organizational entity receives the email. The email attributes, for example, Subject, Priority, From and so on, are configurable in TIBCO Business Studio when you set up the email task. The email subject is followed by the Id number. The Id number is set up using a token in an email attribute. The Id number is different for each work item. 2. Open the email and click the link provided to open the work item. Auto-Repeat The Work Views gadget provides an auto-repeat feature that causes the next available work item to be automatically opened after you’ve submitted a work item, where “available” means a work item that is not locked or suspended. This allows you to process work items in succession without manually opening each one. Auto repeat is automatically disabled if you are viewing a work list view. It is only available on your default work list. If the Auto-Repeat Open Work Item feature is turned on, both the filter and sort functions on the gadget are disabled. Plus, if you have defined a filter or sort from the gadget (in other words, the Filter or Sort icon currently has a green check), the Auto-Repeat Open Work Item feature is disabled. To turn on the auto-repeat feature, click . The auto-repeat feature works as a toggle — successive clicks of the Auto-Repeat Open Work Item button turns it on and off. When the feature is turned on, the Auto-Repeat Open Work Item button is highlighted . The auto-repeat toggle is persisted. If you log out and log in again, you do not need to reset autorepeat. Piling When a user task is defined in a process template, the designer specifies whether or not work items generated from that user task should be piled. If they are piled, when you cancel, close, or submit a work item generated by that user task, Openspace searches through your work list to see if there are any other work items from that user task. If it finds one, it automatically, opens it. If there are no more work items, you are returned to the Work Views gadget. This feature allows the system to be designed so that if your job entails processing a certain type of work item, Openspace automatically opens work items of that type, without requiring you to continually select work items from your work item list — as if you are working on a pile of work items. Filling in a Work Item Form The form that appears when you open a work item is specific to your Openspace. Each company that uses Openspace creates their own forms that relate to their specific business. Your company will instruct you in properly filling out the forms that they have designed for Openspace. The following is an example of what a form may look like: TIBCO® Openspace User's Guide 62 Press Tab to move from field to field on the form. Some fields may include a drop-down menu from which you can select the valid options—they contain - Select - and an arrow head. Click on the field to display the options you can choose from. A date picker may be available to enter dates in date fields. Click on the calendar icon next to the date field. A calendar is displayed from which you can choose a date; clicking on a date in the calendar causes it to be entered in the field. Work Item Data Modified By Other Users or System Actions It is possible that a work item’s data may be modified in some way, either by the system or another application. The change made by the system or another application can include changes to data in fields, or other aspects of the work item, such as a deadline date. How the work item is modified depends on: ● how you have configured your process definition in TIBCO Business Studio. The modification of work item data is configured using the Overwrite data already modified in work item check box. See TIBCO Business Studio Process Modeling Guide for more information. ● whether the work item form is open or closed when the work item data is modified. If the work item form is closed and you have made one or more changes to one or more fields on the form, then: ● If the Overwrite data already modified in work item check box is selected, when the work item is modified, any data that has been updated by you (and the other fields rescheduled for update) are overwritten with the new data. ● If the Overwrite data already modified in work item check box is not selected then, any changes you have made to a form remain but the other fields are modified. For example, say you have a form that contains two fields (field1 and field2) and you update field1. If the work item is then rescheduled with changes to both field1 and field2, then only field2 is modified. The changes that you have made to field1 remain. If a work item is modified while you have it open, when you click Submit or Close, the following dialog displays: TIBCO® Openspace User's Guide 63 If the Overwrite data already modified in work item check box is not selected, then you have the following options: ● Override. Click this if you want to finish updating the work item. In this case, the changes that you have made to the form remain and the changes that have been made by TIBCO ActiveMatrix BPM are lost. ● Reload. Click this if you want to reload the form with the new changes displayed. In this case, any changes that you have made to the form are lost. You can then decide whether to re-enter the data or submit it as it is, depending on your requirements. ● Cancel. Click this if you want to cancel the changes you have made to the work item form. In this case, all the data you have entered is lost but the changes made by TIBCO ActiveMatrix BPM are retained. If the Overwrite data already modified in work item check box is selected, then the Override button is not displayed. Progressing Stale Case References It is possible to open a work item that contains a case reference that no longer exists (a stale case reference) because the case object has been deleted. The deletion of case objects should be carefully managed and designed into your ActiveMatrix BPM user applications. See TIBCO ActiveMatrix BPM Case Data User's Guide for best practices for deleting case objects. If you open a work item that has a stale case reference, the fields that contain the stale case references are blank and you are not able to enter any data in the fields. There are two different ways to progress a work item that contains a stale case reference, depending on whether the work item form contains a single case object or an array of case objects. If your work item has only one case object and that case reference is stale, then you must select Cancel. At this point, the process instance is in a Started state with the work item opened. In other words, the process instance is effectively halted and cannot be progressed any further. Therefore, you must select Cancel on the work item form and then cancel the process instance. You can still select Close or Submit but if you do, the following error displays: Error in server data: the value for the parameter: parametername contains an invalid global object reference where parametername is the name of the field that contains the stale case reference. Openspace does not allow you to submit or close the work item as this would cause invalid case data. If your work item contains an array of case objects, and one or more of the case references are stale, then you can submit the work item by selecting Submit. However, the case data for the stale case reference is submitted as Null. If there are other tasks in your process that use the invalid case reference, then this could cause the process instance to halt and it could not be progressed any further. In this situation, the process instance must be cancelled. Saving Work Items Saving a work item causes any information you have entered in the form to be saved, then the work item is closed (and unlocked) and placed back in the work item list with a state of PENDED. The work item is then available to be opened and completed at a later time. Procedure ● To save and close a work item form, click . TIBCO® Openspace User's Guide 64 Submitting Work Items Submitting a work item means that you have finished with it. If there are any fields on the form designated as “required” when the form was created, they must be filled in before Openspace allows you to submit the work item. Submitting the work item causes any information you’ve entered to be saved, then the work item is closed (and unlocked) and removed from the work item list. The process instance advances to the next task in the process, possibly resulting in another work item appearing in someone’s work item list. Procedure ● To submit a work item from the work item form, click . Pending Work Items Work items can be pended, which causes them to be hidden in the work item list until a specified date/ time, or period of time has expired. The work item becomes visible again when the date/time occurs, or period of time expires. Work items can be pended only if they have a state of ALLOCATED. Procedure 1. From a work item list, select one or more work items that have a state of ALLOCATED. 2. Click on the button, or select Pend Work Itemsfrom the Tools menu on the work item list. The following dialog is displayed: 3. Select the appropriate radio button, depending on whether you want to specify a specific date and time, or a period of time. 4. Specify the date/time or period of time, then click OK. The pended work items become hidden. There is an option to view the work items in pendhidden state, see Displaying Visible Hidden Work Items. TIBCO® Openspace User's Guide 65 Unpending Work Items You can unpend a work item by selecting Pend work item for a period of time and entering 0. Skipping Work Items You can select one or more work items in your work item list and "skip" them. This marks the work items as complete, removes them from the work item list, and causes the process to advance. It has the same affect as opening the work items and submitting them. To be able to skip a work item, the following must all be true: ● the work item cannot have any required data fields that are not filled in ● the work item’s state must currently be ALLOCATED. Procedure 1. From a work item list, select one or more work items that are skipable. 2. Click . If the task in the process definition is not skipable, or if the work item does not exist any more (in other words, your work item list has not been refreshed since the work item was submitted by someone else), an error message is displayed; Unable to skip all of the selected work items(s). Items may no longer exist or some may not allow skip. Refresh the list to view any changes. When the work item is successfully skipped, it is submitted and removed from your work item list. Canceling Changes Once a work item is opened and data is entered or changed on the work item form, you can cancel those entries/changes and return the work item to the state it was in when the work item was opened. This can be done in two ways: . The work item is closed and returned to the work item ● From the work item form - click list without saving the changes. ● From the work item list - click . The intention of is for an administrator-type user to be able to forcibly close a work item left open by another user. This will cause any data entered or changed by the user who opened the work item to be lost. To close a work item from the work item list, select the work item in the work item list, then click from the To Do List gadget. TIBCO® Openspace User's Guide 66 The work item form that was opened by the user who originally opened the work item is not closed by . The form must be manually closed from the workstation from which it was opened. TIBCO® Openspace User's Guide 67 Executing Manual Ad-Hoc Activities Manual ad-hoc activities can be defined for all processes, including processes that use case data. If there are any manual ad-hoc activities defined in a process, you can execute them in one of three ways; from the Work Views gadget, the Case Management gadget (if the processes are using case data) or from a work item form. A manual ad-hoc activity is a standalone task in a business process. A process can have multiple manual ad-hoc activities. Depending on how the ad-hoc activities have been defined, they can be executed once or multiple times during the lifetime of a process instance. Manual ad-hoc activities either create a work-item or call a sub-process. See TIBCO Business Studio Modelling Guide for more information. In Openspace, the following information may be provided for each ad-hoc activity. Option Description Ad-Hoc Activity Name The name of the ad-hoc activity is defined in the process in TIBCO Business Studio, at design-time. Process Instance Name The name of the process instance from which the ad-hoc activities can be performed. Case ID (applies to the Case Management gadget only). The case ID associated with the ad hoc activities. Process Template Name (applies to the Work View gadget only) The name of the process template from which the ad-hoc activities can be performed. The ad-hoc activity is currently executing. The number of times the ad-hoc activity has been executed. The ad-hoc activity is disabled and cannot be executed. For example, there may be a precondition for this activity that is not satisfied and so the activity cannot be started. Select this to execute the ad-hoc activity. The ad-hoc activity can be started multiple times. Select this to cancel the ad-hoc activity currently in progress. The ad-hoc activity is an automatic ad-hoc activity. Automatic ad-hoc activities cannot be executed manually. TIBCO® Openspace User's Guide 68 Prerequisites ● You must be logged in as a user that has privileges with the startAndCancelAdHocActivity system action assigned to view the ad-hoc windows. There may also be privileges applied to each ad-hoc activity which are required to start an instance. ● The process instance must be started. Procedure 1. There are three ways you can execute manual ad-hoc activities: ● ● From the Work Views gadget. You can either: — Select the work item for the process that has ad-hoc activities defined and select — Open the work item and from the work item form, select . . From the Case Management gadget, perform a search to retrieve a list of cases. See Performing an Ad-hoc Search or Performing an Advanced Search. Once you have selected a case, select Case Navigation > Manage Ad-Hoc Activities. The ad hoc activities for the selected case or process instance displays. 2. Find the ad-hoc activity you want to execute. Note that: ● You can use the Search facility to find the ad-hoc activity you want to execute. This is a text based search and it searches all the text that is currently displayed. The search is dynamic so as you start typing, the ad-hoc activities that match the text you are typing automatically display. ● You can toggle off the automatic and disabled ad-hoc activities by selecting and selecting either Show automatic or Show disabled, depending on your requirements. 3. Select to start the ad-hoc activity. . You can select When an ad-hoc activity is started, it's status changes to time to cancel the ad-hoc activity. at any The page does not automatically refresh. If you try to cancel an ad-hoc activity and you receive an error, it means that the ad-hoc activity has already finished. 4. Process the work item. See Processing Work Items. 5. Once the work item is completed, the ad-hoc activity displays either whether or not the activity can be executed again. 6. You can refresh the page at any time by selecting or , depending on . 7. Select OK to close the ad-hoc activity page. TIBCO® Openspace User's Guide 69 Process Views Gadget The Process Views gadget displays information about the processes in your list, such as their status, priority, duration and so on. You can also perform actions such as suspend, resume or cancel processes and view an audit trail of your processes. Depending on your privileges, you can also migrate processes to different process templates and administer halted processes. The Process Views gadget is divided into two halves. The first half displays columns that show you information about the processes in your list. If you start a process instance from a process template, the details of the process instance you have started are displayed in the second half. The columns shown above are displayed by default, see Process Template List Columns. However, you can customize what columns are displayed, see Customizing Columns. The status of a process determines what stage it has reached in the process. A process can have various states. For example, if a process has been started it will have a status of Active. For an explanation of each of the possible states of a process, see Process Instance State. You can also use the following buttons to display process templates by the status of the process instances started from a process template. Button Description Show active instances for this template. This is selected by default. Show completed instances for this template Show suspended instances for this template Show all halted or failed instances for this template. Show all instances for this template. The process template list that is initially displayed is a snapshot of the process templates available at that point in time. You can refresh the list to get the most recent list of processes from BPM, see Refreshing the Process Template List. If you have a large number of processes in your list, you can use the search feature to search for a specific process, see Searching for Process Templates. Process Template List Columns The process template list is divided into columns that show you information about your process templates. The following table describes the columns that show you information about the process templates in your list: Column Name Description Name The name of the process template. This is defined in TIBCO Business Studio at design-time. TIBCO® Openspace User's Guide 70 Column Name Description Description A description of the process template. This is defined in TIBCO Business Studio at design-time. Version Identifies the version of the process template. Module Identifies the module name. Purge Identifies whether the purging strategy is Immediate or Deferred. See Purging Process Instances. Duration Identifies the amount of time that passes before completed process instances are purged. The duration is set using the Purging Administration Service. See TIBCO ActiveMatrix BPM Administration Guide for more information. ● All users can see the Purge and Duration columns. However, if you want to change the purging strategy for a process template you must be logged in as a user that has the bulkPurgeProcessInstances system action assigned to it. ● You can sort and filter the list of process templates on Name, Description, Version and Module. You cannot sort or filter the process templates using Purge or Duration. See Process Templates and Process Instances Filters and Sorting Process Templates for more information. The following table describes the columns in the bottom pane that show you information about the process instances in your list. Column Name Description Id A unique alphanumeric value identifying this particular process instance. State Indicates the current status of the process instance, see Refreshing the Process Template List . Priority This is a numeric value that has been assigned to the process instance by an administrator. The numeric value assigns a relative importance to the process instance, which allows users to prioritize their work. Starter The username of the Openspace user who started this particular process instance. Start Time The date and time the process instance started. End Time The date and time the process instance ended. Duration The duration of the process instance. Template The name of the process template. This is defined in TIBCO Business Studio at design-time. Error Msg An auditable message that has been generated by TIBCO ActiveMatrix BPM. See the TIBCO ActiveMatrix BPM Administration guide for more information. TIBCO® Openspace User's Guide 71 Column Name Description Failed Activity The name of the task that failed. See Administering Halted Process Instances Overview for more information. Failed Date The date the task failed. See Administering Halted Process Instances Overview for more information. Not all columns are displayed by default. You can select which columns are displayed using the Column Selector dialog. See Customizing Columns for more information. Note that some columns may be empty, depending on the state of your process instances. For example, Error Msg, Failed Activity and Failed Date only contain information if your process instance is halted or failed. Process Instance State The state of a process determines what stage it has reached in the process. A process instance can have various states. The State column in the Process Views gadget indicates the process instance’s current state. The following table describes the possible states and their meanings: State Description pi_started This is a transitory state between the time a process instance start has been initiated and the actual starting of the process instance. The amount of time it takes to start a process instance depends on the amount of system resources available and the current load on the system. pi_completed The process instance has been completed. pi_suspending This is a transitory state between the time a process instance suspension has been initiated and the actual suspension of the process instance. The amount of time it takes to suspend a process instance depends on the amount of system resources available and the current load on the system. pi_suspended The process instance has been suspended. pi_resuming This is a transitory state between the time a process instance resume has been initiated and the actual resumption the process instance. The amount of time it takes to resume a process instance depends on the amount of system resources available and the current load on the system. pi_cancelling This is a transitory state between the time a process instance cancellation has been initiated and the actual cancellation of the process instance. The amount of time it takes to cancel a process instance depends on the amount of system resources available and the current load on the system. This is the state you see when a process instance, or sub-process instance, is being cancelled without the use of a cancellation event handler (see the next three states below). TIBCO® Openspace User's Guide 72 State Description pi_active_while_cancelling* The sub-process instance was active when its cancellation was initiated by a cancellation event handler, and is now waiting for the cancellation to complete. (There may also be compensation handlers that are reversing or undoing previously executed activities before the status can be changed to pi_cancelled.) pi_suspended_while_cancelling* The sub-process instance was suspended while it was being cancelled by a cancellation event handler. Typically, a sub-process instance has a state of pi_active_while_cancelling upon initiation of the cancellation event handler, but at that point you can suspend the sub-process instance with the intention of fixing a possible error before the sub-process instance changes to the pi_halted_while_cancelling state (see below). And of course, if the sub-process instance is suspended (and an issue resolved), it must be resumed so the graceful cancellation of the sub-process can continue to completion. pi_halted_while_cancelling* The sub-process instance was halted due to a failure in the cancellation event handler business logic. Typically, a sub-process instance has a state of pi_active_while_cancelling upon initiation of the cancellation event handler, but then may fail (for example, the handler cannot find an external resource or a dynamic sub-process), at which point its state changes to pi_halted_while_cancelling. If the state changes to pi_halted_while_cancelling, you can use one of the available functions to progress a halted process instance (for information about those functions, see Progressing Halted Processes), and ideally get back to a pi_active_while_cancelling state so that the graceful cancellation of the sub-process can continue to completion. pi_cancelled The process instance has been cancelled. pi_halted The process instance has halted. See Administering Halted Process Instances Overview for more information. pi_failed The process instance has failed. See Administering Halted Process Instances Overview for more information. * Sub-processes instances can be cancelled in a "cascading" fashion, which causes them to be cancelled from the "bottom up". This is done using a "cancellation event handler." When cancelled in this way, the sub-process instances can take on one of the following states as described above. For more information about cancellation event handlers, see the TIBCO Business Studio Modeling User's Guide. ● pi_active_while_cancelling ● pi_suspended_while_cancelling ● pi_halted_while_cancelling TIBCO® Openspace User's Guide 73 Refreshing the Process Template List The Process Template list that is initially displayed is a snap shot of the process templates available at that point in time. You can refresh the list to get the most recent list of process templates from BPM. You can set up the template to refresh automatically, or you can specify the auto refresh interval. from the Process Views gadget and Openspace automatically refreshes, ● Click ● Configure the Process Views gadget to automatically refresh the list at specified intervals. By default this is set to 0 which means auto-refresh is turned off. a) From the Process Views gadget, click . The Configure auto refresh dialog is displayed. b) In the Auto refresh interval (seconds) box, type the number of seconds you would like between refreshes (the minimum you can specify is 30 seconds), then click OK. c) Enter 0 to turn off auto-refresh. Customizing Columns You can customize your process template list so that only certain columns are displayed, or to change the order in which the columns are displayed. Procedure 1. Click . 2. Select the columns you want to display from the drop-down list. 3. Click away from the list to save your changes. The process template list is now displayed based on the columns you chose. Increasing Page Size By default, Openspace displays 8 process templates and process instances per page. Depending on your requirements, you can increase the number of process templates and process instances displayed per page. The maximum number of process templates and process instances that can be displayed per page is 99. Procedure 1. Click on either the process template pane or process instance pane, depending on which page size you want to increase. 2. In the Page Size box, type the number of process templates or process instances you want to display per page. TIBCO® Openspace User's Guide 74 Searching for Process Templates If you have a large number of process templates in your list, you can use the search feature to search for a specific process template instance. Procedure 1. In the Search box, click the down arrow. 2. Select a column indicator to search on from the drop-down list. You can select Template or Description. 3. In the Search box, type the search criteria you want to search for. You can use wild card characters, see Using Wild Card Characters for more information. You can use multiple wild card characters in the Search box. 4. Click . 5. Click the Search tab. The Process Views gadget displays the process templates that match the search criteria you specified. If you click the Templates tab, your original view is still displayed. Starting a Process Instance When you start a process instance, one or more processes may be started by the service, resulting in processes appearing in the list. Starting an instance of a process results in initiating the first task of the process. This typically results in one or more work items being sent to one or more work lists. The process instance is considered complete when the final task in the process is completed. Procedure 1. Click on the process template of which you want to start a process instance. 2. Click . Suspending a Process Instance You can suspend activity in a process instance, which causes all work items that are associated with that process instance to also become suspended, and the process flow is halted at that point. Work TIBCO® Openspace User's Guide 75 items that are suspended cannot be worked on, for example, they cannot be opened, allocated, reoffered, nor cancelled. ● if you have: — work items that have a timer event configured, or — timer events defined within the process and the timer event is reached while the process instance is suspended, then the timer event is still processed. However, you will not see this activity until the process instance has resumed. For example: ● If the process is configured to move to the next task when the timer event has fired, the process moves to the next task when the process resumes. ● ● If the task that has a timer event is set to withdraw on expiry, then the task is withdrawn when the process resumes. work items that are suspended become hidden in the work item list. If a work item is already open when the process instance is suspended, the work item can still be cancelled, closed or submitted: ● If cancelled, any changes made on the work item form are discarded and the work item is returned to the work item list with a SUSPENDED state. ● If closed, any changes made on the work item form are saved, and the work item is returned to the work item list with a state of SUSPENDED. ● If submitted, any new work items that result from the process flow appear in the appropriate work item lists, but they will have a SUSPENDED state. The suspended work items cannot be worked on until the process instance is resumed — see Resuming a Suspended Process Instance. Procedure . 1. From the Process Templates gadget, select one or more process instances and click A dialog is displayed that asks you to confirm that you want to suspend the selected business services. 2. Click OK to confirm. When a process instance is suspended, it’s status changes to pi_suspending. The status of the process instance remains pi_suspending until the gadget is explicitly refreshed or auto-refreshed. Resuming a Suspended Process Instance Resuming a suspended process instance causes the process to flow as usual. Work items that were suspended because their process instance was suspended can now be opened and processed normally. Procedure 1. From the process template list, select one or more suspended process instances that you want to . resume, then click A dialog is displayed that asks you to confirm that you want to resume the suspended process instances. 2. Click OK to confirm. When a process instance is resumed, it’s status changes to pi_resuming. The status of the process instance remains pi_resuming until the gadget is explicitly refreshed or auto-refreshed. TIBCO® Openspace User's Guide 76 Canceling a Process Instance You can cancel a process instance, which stops the process flow and deletes all work items that are associated with that process instance. Work items that are associated with a cancelled process instance are removed from the work item lists of the user to whom the work items were offered/allocated the next time their work item lists are refreshed. If a user has a work item open when its associated process instance is cancelled, a message is displayed when the user attempts to cancel, close, or submit the work item form informing the user that the process instance has been cancelled. Procedure . 1. From the process instance list, select one or more process instances, then click A dialog is displayed that asks you to confirm that you want to cancel the selected process instances. 2. Click OK to confirm. When a process instance is cancelled, its status changes to pi_cancelling. The status of the process instance remains pi_cancelling until the gadget is explicitly refreshed or auto-refreshed. Purging Process Instances By default, all process instances that are completed, cancelled or failed are automatically purged from TIBCO ActiveMatrix BPM. If you want to keep completed process instances for a period of time, for auditing purposes for example, you can configure your process templates in Process Views so that they are not automatically purged. You can do this by configuring a purging strategy for individual, or a group of, process templates. There are two purging strategies: ● Immediate. If you select Immediate, process instances are purged automatically as soon as they are completed, cancelled, or failed. ● Deferred. If you select Deferred, completed and cancelled process instances are not automatically purged from TIBCO ActiveMatrix BPM. You can either specify a duration so that the process instances are purged after the duration you specify or, if you do not specify any duration, you must manually purge. Setting the duration and manually purging process instances must be done using the Purging Administration Service. See TIBCO ActiveMatrix BPM Administration Guide for more information. If you do not configure a purging strategy for your process templates, completed and cancelled process instances continue to be automatically purged. Note that: ● Once you have set a purging strategy, it applies to all versions of that process template. If you deploy a new version of a process template, the new version of the template inherits the purge strategy settings for the previous version. ● If the purge strategy is changed, the new strategy applies to all currently active versions of the template and all process instances executing against these versions. This means, if you have set a process template's purging strategy to Deferred and then decide to reset it to Immediate, completed and cancelled process instances saved at this point are not automatically purged. You must use the Purging Administration Service to manually purge those process instances. ● If a process template is a sub-process, you must still set the purging strategy for the process template. In other words, the sub-process cannot inherit a purging strategy from the main or calling process template. You must configure a purging strategy for each process template. TIBCO® Openspace User's Guide 77 ● When the last version of a process template is un-deployed then, regardless of its purging strategy, all un-purged process instances are scheduled for purging. Prerequisites You must be logged in to TIBCO Openspace as a user who has been assigned the system action, bulkPurgeProcessInstances to configure purging strategies for process templates. Procedure 1. From Process Views, click Templates. 2. Select the process template you want to purge. You can select a single process template or multiple templates, depending on your requirements. 3. Click Purge Immediately or Deferred ( ). 4. From the Select Purging Strategy dialog, select either: ● Immediate. If you have selected Deferred for a process template but then decide to purge the process instances automatically, select Immediate. ● Deferred. Select Deferred if you want completed and cancelled process instances to remain in TIBCO ActiveMatrix BPM. You must manually purge them using the Purging Administration Service. See TIBCO ActiveMatrix BPM Administration Guide for more information 5. Click OK to save your changes or Cancel to exit the dialog without saving your changes. Process Instance Migration Overview Process migration is the ability to migrate a long running process from one version to another version of the same process template. Migration can only occur when the process instance is about to execute a task that has been setup for migration. When you perform process migration, all active instances of the process are migrated (although the point at which they migrate depends on the point they have reached in the process). It is not possible to specify an individual active process instance to migrate. The process of migration is initiated and controlled by setting up migration rules. You must specify the following in Openspace: ● the source and destination process templates to migrate from and to ● the migration points in the process template from which the process instances should migrate ● the migration rules that activate process migration. To perform process migration in Openspace, you must log in as a user with a privilege that has the Handle Process Migration system action assigned to it. This is configured in the Organization Modeler in TIBCO Business Studio, see TIBCO Business Studio Modeling Guide for information. Migration Points Process migration can only occur at specific points in the process template. These points are called migration points. Migration points are automatically identified by TIBCO Business Studio at designtime. Tasks, events and gateways are defined as migration points but not all tasks, events and gateways are eligible to be migration points, see Determining if Migration is Valid. You can only migrate a process instance at the exact same migration point in the earlier or later process template. For example, if you select the Display Message task in the source process template, then the Display Message task is automatically selected in the destination process template. You can specify one, some or all of the migration points in a process template, depending on your requirements. TIBCO® Openspace User's Guide 78 The point at which the active process instances migrate depends on the point they have reached in the process. Migration occurs when the process instance is about to execute a task that has been scheduled for migration. If the task has already been offered to a user or executed, in other words, the work item has already arrived in the work list, it is too late to be migrated and migration will take place at the next migration point specified or, if no other migration points have been specified, carry on with its existing process template version, see Process Migration Example. Migration Rules Once you have specified the migration points, you must define a migration rule. The migration rules specify the source process version and destination process version to migrate to, and the migration point at which to migrate. Note that: ● Any existing data entered in the process instance is retained after migration, along with any new default data resulting from the process template that the process instance has migrated to. ● Any events are carried forward after migration. Determining if Migration is Valid Before performing process migration, you must make sure that process migration to an earlier or later process template is valid. Determining if Process Template Data can be Migrated When migrating a process template with data, note the following: ● The BPM runtime does not perform any data migration from one version of a process template to another. This means that the data for the destination version of the process must be in place, before migration is performed. ● The BPM runtime does not check whether data is valid from the source version to the target version of the process template. Processes may function incorrectly or crash after migration if the data is not valid after migration. Therefore, TIBCO recommends that you do not do the following between source and destination process templates: ● Do not change the types of data objects. ● Do not introduce new fields that do not have default values. Determining Valid Migration Points Openspace only displays the valid migration points for the process templates. If a task or gateway is a valid migration point, its name is displayed. Points in the process template that are not valid migration points are not shown. If you have a process template that contains any tasks or gateways that cannot be migration points then, you can either: ● specify a point in the process template that is a valid migration point, or ● design a valid migration point into your process template based on the rules described below. There is no way at design-time to see what tasks, gateways and events will be valid migration points. Valid migration points are points of the process template where a single process thread executes. If more than one task at a time could be active then those tasks cannot be migration points and will not be displayed as a migration point in Openspace. This is because, as the BPM runtime does not know which task is executing at any time, it is impossible to specify a particular task as a migration point. TIBCO® Openspace User's Guide 79 Therefore, a task that starts a parallel path is a valid migration point but any tasks that follow are not. This means that the following are not valid migration points: ● Tasks that follow these gateways are not valid migration points: — Inclusive — Complex — Parallel ● Tasks following tasks that have Timer events placed on their boundary with Continue Task on Timeout selected are not valid migration points. ● Tasks following tasks with multiple instance loops with ordering set to Parallel and flow conditions that are set to One. This is equivalent to an exclusive gateway, and means that only the completion of the first activity instance causes flow to continue. Any tasks inside embedded sub processes cannot be migration points, but the embedded sub process itself may be a migration point. Migration takes place before starting the sub process. The following events cannot be migration points: ● start events ● events placed on the boundaries of tasks. The task name is used to identify a migration point. This means that: ● all tasks must have names By default, gateways do not have names. This means that you must specify a name for all gateways in your process if you want them to be valid migration points. ● task names must not be duplicated. ● task names in source and destination process templates must be the same. If the task names differ, they will not be listed in Openspace as valid migration points. Migration cannot be performed on pageflow processes. Pageflow processes are short-lived processes whose data is not persisted, therefore migration should not be required. Examples of Processes That are Invalid for Process Migration The example below shows a process that is invalid for migration. In this example, only Task 1 is a valid migration point. This is because Task 2 and Task 3 could be executing at the same time as Task 4. Therefore, as the BPM runtime cannot know which task is TIBCO® Openspace User's Guide 80 executing at any time, a specific migration point cannot be identified. You could make this process valid by amending it as shown below. All tasks in the process are now valid migration points. This is because Task 2 and Task 3 must wait for Task 4 before they can execute. Similarly, the process shown below is also invalid for migration. This is because the BPM runtime cannot determine when the receive task will be received so a specific migration point cannot be identified. Process Migration Example Process migration can only occur at specific points in the process template. These points are called migration points. Migration points are automatically defined by TIBCO Business Studio. Shown below is Version 1 of a process. TIBCO® Openspace User's Guide 81 In this example, the following tasks are displayed in Openspace as migration points: ● Pre-Mortgage Application Check ● Mortgage Application Submitted ● Decide The tasks following the Decide gateway are not valid migration points as more than one task at a time could be active. See Determining if Migration is Valid for more information about invalid migration points. Shown below is version 2 of the process. A new task called Credit Check has been added to the process. The following tasks are now displayed as migration points in Openspace: ● Pre-Mortgage Application Check ● Mortgage Application Submitted ● Credit Check ● Decide To migrate the process instances from Version 1 to Version 2, create a migration rule that specifies the Mortgage Application Submitted task as the migration point. This is because the migration point must exist in both the source and destination process templates and as the new task does not exist in the older version of the template then the new task cannot be the migration point. Note that: ● process instances that have started executing against version 1 will migrate to Version 2 when they have finished executing the Pre-Mortgage Application task but not yet started to execute the Mortgage Application Submitted Task. ● process instances that have already started executing the Mortgage Application Submitted task will continue with Version 1 of the process. This means that all process instances that have started executing against Version 1 of the process template will migrate to Version 2 unless they have reached the Mortgage Application Submitted task. How to Migrate a Process Instance Before migrating a process instance to an earlier or later process template, you must determine that migration is valid. If migration is set on a user task and the user task is OFFERED to the user before the migration rules are set, on completion of the user task, the process instance is not migrated. Instances for which the user task is not yet scheduled /OFFERED follow the migration rule. TIBCO® Openspace User's Guide 82 Procedure 1. From the Process Views gadget, select the process template whose process instances you want to migrate and click . The following dialog displays all the available versions for the process template you selected. 2. From the Source Version panel, select the source process template that the active process instances are executing against. The source migration points are displayed. 3. From the Destination Version panel, select the destination process template that you would like the process instance to migrate to. The destination migration points are displayed. 4. From the Source migration points panel, either select the individual migration points or click All to select all the available migration points, depending on your requirements. The corresponding migration points are automatically selected in the Destination migration points panel. TIBCO® Openspace User's Guide 83 5. Click Add rule. The rules are added to the pane below. There is a migration rule for each migration point that you specify. If you selected All, there is a migration rule for each available migration point in the process template. By default, the name of rule is in the format: Version [versionnumber] to Version [versionnumber]. Point [migrationpoint] where: ● versionnumber is the version number of the process template. ● migrationpoint is the name of the task or gateway. TIBCO® Openspace User's Guide 84 Once a migration rule has been applied, it is displayed with a tick beside it. New rules do not display a tick until they have been applied. This enables you to see the rules that are applied and those that have yet to be applied. 6. You can rename the migration rules. To do this, select the migration rule you want to rename and click Rename rule. The Rename rule dialog displays. 7. In the Enter New Name: box, type a new name for the migration rule and click OK. 8. Click Apply migration rules to apply your migration rules. When prompted, click OK to migrate your process instances or Cancel if you want to cancel. 9. If you click OK, a Migration rules applied message displays if migration was successful. You can view the audit information in Event Views. All audit and statistics information that refers to the current process still apply after migration. 10. You can remove a rule at any time by selecting a rule and clicking Remove rule. To remove all rules, click Clear rules. Administering Halted Process Instances Overview A process instance may fail if an executing activity encounters an unexpected error condition (that is, one that is not caught and handled by the process itself). For example, if a database connection failure occurs while a database service task is performing an update. If a system error causes a process instance activity to throw a Java exception, the process instance may enter a halted state. This allows you to examine the halted process instance to determine the causes of the failure, then take whatever action is required to deal with the error. TIBCO® Openspace User's Guide 85 ● To progress halted processes, you must be logged in as a user that has privileges with the haltedProcessAdministration system action assigned. See Progressing Halted Processes . ● Whether a process instance halts or fails depends on the error handling configuration that has been applied at the activity, process and/or system-wide levels. See "Configuring Error Handling Behavior for Process Instances" in TIBCO ActiveMatrix BPM Administration for more information. Viewing Halted Process Instances Halted process instances can be viewed in the Process Views gadget. Process instances that have failed are also displayed. However, you cannot progress a failed process instance. Procedure 1. From the Process Views gadget, click Template. 2. Select one or more process templates whose halted process instances you want to view. 3. Click . A list of the halted and failed process instances for the process templates you selected is displayed in the bottom pane. You can also click . This displays all process instances. 4. Select the process instance that you want to view and click Audit. The audit trail for the process instance displays. The screenshot below shows a process instance that has halted. Note that: ● a yellow flag indicates the step that has halted. ● The step that has failed is shown as Pending. This is because it is yet to complete. ● If you hover over the yellow flag, information about the error message is displayed. ● You can sort and filter the list of halted process instances using any of the fields listed above. See Process Templates and Process Instances Filters and Sorting Process Templates for more information. 5. Click on the event in the audit trail to display the attributes in the Event Attribute pane for the selected step. TIBCO® Openspace User's Guide 86 The following information displays: Column Description Message Description of the event. principalName Name of the security principal associated with the event. priority Priority of this process instance. managedObjectId A unique alphanumeric value identifying this particular process instance. creationTime The date and time the task was created. messageID An auditable message that has been generated by TIBCO ActiveMatrix BPM. See the TIBCO ActiveMatrix BPM Administration guide for more information on the meaning of the message. componentId Identifier of the component that generated the event. managedObjectNam e The name of the process template that contains the task that halted/ failed. Progressing Halted Processes You can progress halted processes. However, you cannot progress process instances that are in a failed state. Procedure 1. From the Templates tab, select one or more of the halted process instances. 2. Click . Press CTRL + click on and the Examine dialog displays automatically. The Force special action on halted process instance(s) dialog displays. TIBCO® Openspace User's Guide 87 Choose one of the following: ● Retry Retry the task that has failed. For example, you may select this if a database task has failed because the database connection was lost but is now restored. ● Ignore - Cancel the task and continue with the process. This means that the process instance continues processing from the point in the process after the failed activity". This could mean, for example, that a field may not have been set but the process would continue as if the field had been set. It is only advisable to select this if your process is modelled such that it can continue to progress despite the failure of one of its tasks. ● Allow to Error - Select this if you cannot resolve the problem that caused the task to fail. Selecting Allow to Error causes a process to fail and its state to change to pi_failed. Note that: ● — If the task that failed is in a sub-process, either embedded or re-usable, then selecting Allow to Error only fails the sub-process and the main process is only halted. To also fail the main process, you must select the main process and select Allow to Error. — If the main process has halted and you select Allow to Error, its sub-processes are cancelled and their state changes to pi_cancelled. Examine - The Data Related to Halted Process Instance(s) dialog displays. This dialog displays: ● a tree-view of the selected process instances that displays additional details about the process instances. This includes values in custom attributes in the process instance; custom attributes represent customer-specified data fields that are added to a process when it is defined. Those fields can then be added to forms. When a user enters information in the fields on a form (for example, customer name, address, loan amount.) in an instance of the TIBCO® Openspace User's Guide 88 process, that information is stored in the custom attribute for that field, in that process instance. This may help to identify any data that has been entered incorrectly. ● the Activity Fault Data, Activity Fault Name, and Failed Activity Name attributes. The values in these attributes can help determine why a process instance has halted. You could use the XML in this dialog with the ActiveMatrix BPM web service API operation, setAvailableProcessInstanceVariables. The XML can be copied from this dialog and used as input to the setAvailableProcessInstanceVariables operation. This allows you to make changes to the values in the required attributes to try and get the process instance out of a halted state. For information about the setAvailableProcessInstanceVariables operation, see TIBCO ActiveMatrix BPM Developer’s Guide. 3. Click Close to close the dialog. Auditing Instances of Process Templates Overview Events that take place in Openspace are recorded in the audit trail. The audit trail displays a list that contains the events for the currently selected process instance. It allows you to see the events that have taken place for that process instance since it was created. The type of events that are audited are, opening a work item, submitting a work item, suspending a process instance, and so on. Events have attributes that contain information about the event. Some examples are Creation Time and Description. Some attributes are common to all events, and some are unique to a particular type of event. The columns that are shown by default in the audit trail are those attributes that are common to all events. When you select an event in the audit trail, attributes that are applicable to that event are displayed in the event attribute pane below the audit trail. If you have upgraded ActiveMatrix BPM, the audit trail is blank for all process instances. This is because audit data from your previous ActiveMatrix BPM system is unavailable after an upgrade. To make the audit data available, you must migrate your data from your previous ActiveMatrix BPM system to your new ActiveMatrix BPM system, by manually executing a stored procedure. By default, the stored procedure only migrates the latest 20,000 events at a time. For process instances whose events are only partially migrated, the audit trail is blank. Secondly, depending on how you perform the migration, you may have some process instances whose events are only ever partially migrated. In this case, the audit trail for these process instances will always be blank. See "Migrating Data Stored in Event Collector" in TIBCO ActiveMatrix BPM Installation and Configuration. Displaying an Audit Trail When you display the audit trail for a selected process instance, a list of events for the process instance displays. If you hover over the events, detailed information about the events displays. For example, the name, the user ID of the resource who worked on the activity and its duration. If your process template includes any sub-processes, they are displayed within the flow of the main process. However, event sub-processes are displayed below the main process, surrounded by a dotted line, as shown below. There are two types of event sub-process, interrupting and non-interrupting. If an event sub-process is non-interrupting, it's start event is surrounded by a dashed line to distinguish the event sub-process from an interrupting event sub-process. See TIBCO Business Studio Modeling Guide for more information about event sub-processes. TIBCO® Openspace User's Guide 89 If your process template has been interrupted by either a manual or automatic ad-hoc activity, then blue flags in the main process highlight when the process was interrupted and when it resumed. The ad-hoc activity is displayed below the main process that it interrupted. Blue flags can also used as indicators for other activities. To identify which activity the blue flag is an indicator for, hover your cursor over the blue flag to display it's hover text. See TIBCO Business Studio Modeling Guide for more information about ad-hoc activities. TIBCO® Openspace User's Guide 90 Procedure 1. From the Process Views gadget, select the process template whose audit trail you want to display. In the pane below, the process instances for that template are displayed. 2. Click on the process instance whose audit trail you want to view. 3. Double-click the process instance or click Audit. The Audit tab is split into three panes: ● the top pane provides a graphical display of the audit trail, see Displaying an Audit Trail. ● the second pane provides a chronological list of events for the process instance, see Audit Trail Columns. ● (if you select an event in the second pane) the third pane shows the attributes applicable to the selected event, see Event Attribute Columns. 4. From the top pane, you can: ● ● (This only applies to user tasks) hover over a step in the graphical audit trail to display details about the step. Depending on the status of the step, some or all of the following information is displayed: Field Description Type The type of step, for example, user task. User ID The username that opened the step. Duration From the time the step was allocated until the time it was completed. If the step is not completed, then this is set as Pending. Work Time Work time measures the time when the step was opened and closed, but not completed. Work time is the sum of all the times when the step was opened and closed. Wait Time Wait time measures the time when the step was either allocated or closed but not completed. Wait time is the sum of all those times. First Offer Time The time the step was first allocated. First Opened Time The time the step was first opened. Completed Time The time the step was completed. Active Duration The time the step was first allocated until the time the step was completed. Action Duration The time the step was first opened until the time the step was completed. click on a step in the graphical audit trail; the corresponding event is highlighted in the second pane. TIBCO® Openspace User's Guide 91 double-click on a step; all the events from all the components that have affected that step are displayed in the second pane. ● 5. You can toggle between the panes in the Audit tab, using the toggle buttons described below: Button Description Opens or closes the graphical audit trail depending on the context you are in. Opens or closes event list, depending on the context you are in. Opens or closes the event attribute list, depending on the context you are in. You can view the next or previous process instance in the list by using or . Audit Trail Columns The audit trail pane is divided into columns that display information about the events for the selected process instance. The following columns are displayed by default: Column Name Description Creation Time The date and time the event occurred. Description Describes the event that triggered the item. Name The name of the user task. Principal Name The username of the user that carried out the event. Application Instance ID A unique identifier for the event. Severity This is the severity of the event in the audit trail. You can choose to display some or all of the above columns, depending on your requirements. See Customizing Columns for more information. Event Attributes in an Audit Trail Selecting an event causes the attributes associated with that event to be displayed in the Event Attribute pane. The available columns in the audit trail provide information that is common to all events. Whereas, the attributes provide additional information that is specific to the type of event selected. The attribute list is for informational purposes only — there are no functions associated with it. Event Attribute Columns When you select an event in the audit trail, attributes that are applicable to that event are displayed in the Event Attribute pane below the audit trail. The Event Attribute pane is divided into columns that display information about the attributes for the selected event. The following columns are displayed by default: TIBCO® Openspace User's Guide 92 Column Name Description Name The name of the event attribute. Value The value of the event attribute. Type The type of event attribute (for example, string, date, and so on). Component The component where the event was triggered. (for example, process engine or work presentation). You can choose to display some or all of the above columns, depending on your requirements. See Customizing Columns for more information. Customizing Columns You may want to customize your audit trail and event attribute lists so that only certain columns are displayed. Procedure 1. From the pane whose list you want to customize, click . Select the columns you want to display from the drop-down list. See Audit Trail Columns and Event Attribute Columns for more information. 2. Click away from the list to save your changes. The Services tab is now displayed based on the columns you chose. Replaying the Graphical Audit Trail You can replay a graphical audit trail, task by task. The sequence of tasks that make up the audit trail are displayed in the order they were processed in the top pane. At the same time, in the audit trail pane below, the corresponding event is highlighted. Procedure 1. From the Audit tab, click .The audit trail of the process is displayed, step by step. 2. You can pause the display at any time by clicking 3. To resume the display, click . again. 4. If you have any subprocesses in your process template, they are consolidated, as shown below. You can display the audit trail for an individual iteration of the subprocess. Sometimes, due to event types not matching, Openspace will draw the loops as separate instances. The result shows the correct audit but the loop iterations are not consolidated. TIBCO® Openspace User's Guide 93 a) Select the iteration you want to view. b) Click to maximise the subprocess. means that the subprocess is a loop. c) Click to display the audit trail of the first iteration. d) Click to display the audit trail of the last iteration. e) Click or to display the audit trail for the previous or next iteration of the sub-process. Process Templates and Process Instances Filters Filtering a list of process templates and process instances involves entering filter criteria so that only some of the process templates and process instances are shown in the Process Views gadget, rather than all of them. This allows you to display only the process templates and process instances you are interested in. For example, you may only be interested in process templates with a version number later than 2.0 whose process instances were started on or before a certain date. You can filter the list so that only those are shown. You can configure a filter for just process templates or just process instances or for both, depending on your requirements. The Configure Filter dialog allows you to build a “filter expression” that is applied to all process templates and instances. If the process template/process instance satisfies the filter expression (for example, the process template has a version number of 2.5 and the instance was started after 12th July), it is shown in the process template/process instance list; if it does not satisfy the filter expression, it is not shown in the list (and is not downloaded from the server). The left hand side of the Configure Filter dialog displays the column indicators you can filter on. Each column indicator has a drop-down list that allows you to select a logical operator. Logical operators allow you to choose how the specified value is to be compared to the actual values in the column. You can specify equal to, not equal to, less than, and so on. For each column indicator there is a value field where you can enter the value for the items you want returned. The way in which you enter a value depends on the data type for the column indicator you have selected. Process Template Filter Criteria From the Templates tab, specific column indicators are available to filter on. Column indicators have specific data types. Name Description Data Type Name The name of the process template. This is specified in TIBCO Business Studio at design-time. Text TIBCO® Openspace User's Guide 94 Name Description Data Type Description The description of the process template. This is specified in TIBCO Business Studio at design-time. Text Version Identifies the version of the process template. Numeric Process Instance Filter Criteria From the Instances tab, specific column indicators are available to filter on. Column indicators have specific data types. Name Description Data Type ID A unique alphanumeric value identifying the process instance from which the work item was created. Text Priority A numeric value indicating the relative importance of the process instance. Numeric Starter The username of the user that started the process instance. Text Start Time The date and time the process instance was started/created, and arrived in the process instance list. DateTime Example: 2008-08-25 14:30:00 End Time The date and time the process instance was completed. DateTime Example: 2008-08-25 14:30:00 Duration The time the process instance was started until the time the process instance was completed. Numeric Value Data Types When configuring filter critera for specific attributes, the value entered in the Value field must match the data type for the attribute selected. The following describes the valid data types: Data Type Description Numeric Consists of one or more of the numbers 0-9. Used for things like work item ID and priority. The data entry field for numeric values will not allow you to enter any characters other than numbers. TIBCO® Openspace User's Guide 95 Data Type Description Text Consists of any number of letters, numbers, or special characters (for example, #, $). Used for things like process instance ID and work item description. Filtering on text is case sensitive. Note that text attributes are the only attribute types with which you can use wildcard characters. For more information, see Wild Card Characters. If you are filtering on text that contains any of the four special characters (*, ?, ‘, or \), they must be “escaped”. For information, see Filtering on Special Characters. Wild Card Characters The wild card characters ’*’ and ’?’ can be used when filtering on text attributes (work item name, description, etc.) — wild card characters cannot be used with any other attribute type. The ’*’ and ’?’ characters are evaluated as follows: ● ‘*’ matches zero or more of any character. For example: “bo*” matches anything beginning with “bo”. For example, “bo”, “bobbl”, “boulton_anne”. “s*s” matches anything beginning with “s” and ending with “s”. For example, “ss”, “sues”, sid_lewis”. “*s” matches anything ending with “s”. For example, “franks”, “ls”, “martha_lyons”. ● ‘?’ matches any single character. For example: “bill?” matches anything beginning with “bill”, plus one more character. For example, “bills”, “bill5”, “billh”. “c?ndy” matches “cindy”, “candy”, “c3ndy”. Also note that all character matching is case sensitive. Specifying a Filter Expression The Configure Filter dialog allows you to build a “filter expression” that is applied to all process templates and instances. Procedure 1. From the Process Views gadget, click . The Configure Filter dialog is displayed. TIBCO® Openspace User's Guide 96 2. Click either Templates or Instances, depending on your requirements. 3. Once you have set the filter expression in the Config Filter dialog, click OK. 4. To close the Configure Filter dialog without setting the filter, click Cancel. 5. To reset the Configure Filter to its default settings, click Reset. Sorting Process Templates Openspace allows you to sort the information in the process template list so that they are listed in a desired order. The sort function allows you to choose which columns in the process template list to sort on. Sort Criteria There are specific columns that you can sort on. Name Description Name The name of the process template. This is specified in TIBCO Business Studio at design-time. Description The description of the process template. This is specified in TIBCO Business Studio at design-time. Version Identifies the version of the process template. Specifying the Sort Direction Individual sort criteria can be sorted in Ascending or Descending order. They are set to ascending order by default when you add them to the list. Procedure ● You can specify the sort direction of the individual criteria by clicking on the item. For example: TIBCO® Openspace User's Guide 97 Specifying a Sort Order Sort order is applicable only if you have specified multiple sort attributes. It allows you to specify that the list be sorted first on one attribute, then on another attribute, and so on. In this example, all process templates with a version number of 1 are listed first — those process templates are then sorted by name. Then all of the process templates with a version number of 2 are listed — those process templates are then sorted by name. And so on. (Note that for this example both attributes are sorted in "ascending" order). Applying the Sort Criteria The Configure sort columns dialog allows you to apply the sort criteria for process templates. Procedure 1. Click . The Configure sort columns dialog is displayed. 2. From the column in the left hand pane, select the criteria to sort on. You can select multiple criteria. 3. Click . 4. For the individual items, select the sort direction by clicking on the individual item, see Specifying the Sort Direction. If you have multiple items in the list, specify the sort order of the items by clicking on or , see Specifying a Sort Order. 5. To close the Configure sort columns dialog without setting the sort criteria, click Cancel. 6. To reset the Configure sort columns dialog to its default settings, click Reset. TIBCO® Openspace User's Guide 98 Business Services A business service is a set of actions that accomplishes some sort of business function. For example, a business service could be designed to handle an incoming insurance claim. This business service may consist of the following actions: 1. When the business service is started, a form is displayed that allows you to enter the claimant’s policy number. 2. When the form with the policy number is submitted, a database is accessed to retrieve the claimant’s policy information. 3. Another form is displayed that contains the policy information. 4. After reviewing the policy information, and deciding it is a valid claim, submitting the form may start an instance of a process that is used to process the claim. 5. The process instance that is started causes a work item to be sent to the appropriate user, who must open it and work on it. Note that business services are stateless, meaning that if it consists of a number of forms, and you enter data into some forms, then cancel the business service (by clicking on the Cancel button on a form) before completing the business service, none of the data you entered on the previous forms is saved. If a business performs a stateful action, that is, something that cannot be reversed (for example, writing to a database, starting a process instance, and so on.), typically it will be the last action performed by the business service. The example business service described above is just one simple example. Depending on how it is designed, a business service may consist of the following types of actions: ● Display forms - Multiple forms may be displayed in sequence. When a business service includes multiple forms, the user that starts the business service will be the one to work through all of the forms — as soon as the user submits one form, the next one in the sequence is displayed. Note, however, that if there is an action of some sort in-between forms (database access, script execution, etc.), there may be a delay in displaying the next form. If this occurs, a shaded mask is shown over the previous form, and a "Waiting for response" message is displayed. ● Start process instances - One or more instances of processes may be started by a business service. resulting in one or more work items being sent to the appropriate users to process them. If the business service starts process instances, and results in work items, you can see those in the process instance and work item lists, respectively. This stateful type of action would typically be done as the last action in the business service. ● Access databases - The business service may access a database to read or write information. ● Scripts - Scripts can perform various functions, such as calculations, validation, etc. ● Web services - External web service may also be called to perform some custom function. ● Logical branching - The flow of the business service may branch in various ways, depending on its design. Business Services Gadget The business service gadget enables you to is divided into columns that show you information about the business services in your list. For an explanation of the columns, see Business Service List Columns. You can categorize your business services, depending on your requirements. Categories are specified in TIBCO Business Studio at design-time. TIBCO® Openspace User's Guide 99 The business service list that is initially displayed is a snap shot of the business services available at that point in time. You can refresh the list to get the most recent list of business services from BPM, see Refreshing the Business Service List. If you have a large number of business services in your list, you can use the search feature to search for a specific business service, see Searching for Business Services. Business Service List Columns Each column in the business service list provides information about the business services. Column Name Description Name The name of the business service. This is specified in TIBCO Business Studio at design-time. Version Identifies the version of the business service from which the instance was started. Category Identifies the category that the business service belongs to. You can customize the columns that are displayed by using the Column Selector. Customizing Columns You may want to customize your process template list so that only certain columns are displayed. Procedure 1. Click . Select the columns you want to display from the drop-down list. See Business Service List Columns for more information. 2. Click away from the list to save your changes. The process template list is now displayed based on the columns you chose. Customizing Split You may want to customize the split on the page, to allow more or fewer business processes to appear in the top pane. Procedure ● Use the Edit button to display the following and then specify the percentage split you require. TIBCO® Openspace User's Guide 100 Refreshing the Business Service List The Business Services gadget business service list that is initially displayed is a snap shot of the business services available at that point in time. You can refresh the list to get the most recent list of business services from BPM. Procedure ● Click from the Business Services gadget and Openspace automatically refreshes. Searching for Business Services If you have a large number of business services in your list, you can use the search feature to search for a specific category. This allows you to display only the business services from that particular category. Procedure 1. In the Criteria box, click the down arrow. Select Category from the drop down list. 2. In the Search box, type the search criteria you want to search for. You can either type in the category you are looking for exactly as at appears in the tree or you can use the * as a wild card character. A single * represents one level of the tree and two asterisks (**) represent all levels of the tree. Therefore if you had a tree structure like the one below: and if you are searching for CatC, you could type either: ● CatA/CatB/CatC ● */*/CatC You must not end a search with an * however as this would not return any categories. 3. Click . 4. Click Search. The Business Services gadget displays the business services that are listed in the category you specified. If you click Services, your original view is still displayed. The results of the Search only display the category you are looking for. It does not display the hierarchical tree structure of the categories. This means that you cannot navigate through the tree from Search. You must go back to Services to do this. Categories You can store your business services by category. As the number of business services grows, you can increase the number of categories you have so you can organize your business services as effectively as possible. You can specify a category for a business service in TIBCO Business Studio at design-time. The Business Services gadget allows you to view your categories. You can: ● Display all your categories. ● Display a list of your most recently viewed categories. ● Store categories as favorites. TIBCO® Openspace User's Guide 101 Initially, all categories are displayed by default, as shown below: Navigate through the tree to find the category you are looking for. Double-click the category to display the business services stored in this category. Viewing Categories You can view your categories from the Business Services gadget. You can: TIBCO® Openspace User's Guide 102 ● Display all your categories. ● Display a list of your most recently viewed categories. ● Store categories as favorites. Procedure . 1. To display all the categories, click You can expand the children categories of the selected category in the tree by clicking 2. To collapse the whole tree, click . . 3. To display a list of your most recently viewed categories, click Recent Categories displays the last 10 categories you viewed. . . 4. To display your favorite categories, click Adding Categories as Favorites You can add a category to favorites at any time. This is useful if you use a particular category frequently. Procedure 1. Select the category you want to add. 2. Click . The category is listed under Favorite Categories. Removing Categories as Favorites You can remove a category from Favorite Categories. Procedure 1. Click . 2. Hover your cursor over the category and click Categories. . The category is removed from Favorite TIBCO® Openspace User's Guide 103 Starting a Business Service The business service does not generate work items. The user who starts the business service completes the user interface pages for the business service and then the business service starts an instance of a process. A couple of things happen when you start a business service. ● a message is displayed in the form instanceid invoked where instanceid is a unique alphanumeric value that identifies this particular business service and ● the first user interface page in the business service is displayed in the gadget. The business service is considered complete when the final user interface page has been completed. Procedure 1. Click on the business service you want to start. Click . The business service is started as shown below: If you are using Openspace with Internet Explorer version 8, occasionally when starting a business service, Internet Explorer goes into compatibility mode and reloads the page. You can fix this by clicking Tools > Internet Options > Browsing > Advanced and deselecting Automatically recover from page layout errors with Compatibility View. 2. Complete the information in the user interface pages and click Submit. 3. Once the user interface pages are completed, click on the business service again to display a summary. TIBCO® Openspace User's Guide 104 Event Views Events are actions that have taken place, for example, logging in, opening a work item, submitting a work item, suspending a process instance, and so on. The Event Views gadget lists the events so that you can see what has occurred with a particular work item or process instance. The Event Views gadget uses event views to enable you to display a subset of all the available events. Openspace provides some pre-defined event views and you can also create your own, see Creating Event Views Overview. Once you have selected/created an event view, the event list that contains the events in the currently selected event view is displayed. An event list is sometimes referred to as an audit trail because it allows you to audit the trail of actions that have taken place for a particular entity. You can also filter and sort the list of events, see Filtering and Event Lists and Sorting and Event Lists. Some events provide links to related lists of events. For example, from a list of events for a work item, you can link to a list of events for the process instance to which the work item is related, or to a list of events pertaining to the user who allocated the work item. For information about using these links, see Saving an Event View Created Through Event Links. To view events, the Event Views gadget must be added to a tab. You may have logged into Openspace using a persona that automatically adds the Event Views gadget to a tab (for example, the Default persona automatically adds Event Views to the Events tab), otherwise you must manually add the Event Views gadget to a tab, see Adding Gadgets to a Tab. Event Views Gadget The Event Views gadget allows you to view events that have occurred in Openspace. The left pane displays some pre-defined event views that allow you to display a subset of all available events without creating an event view. The following pre-defined event views are available: ● Errors - displays all error events that have occurred in this instance of Openspace since it was installed. TIBCO® Openspace User's Guide 105 ● My Activity - displays events relating to your activities in Openspace today. ● Process Instances - displays events relating to all process instances available in this instance of Openspace. ● Work Items - displays events relating to all work items available in this instance of Openspace. You can also create your own event views to display events, see Creating Event Views. If you select an event view, the event list in the top right-hand pane displays the events in that event view. You may filter and/or sort the list so that only the events you are interested in are displayed, in the required order. For more information, see Filtering and Event Lists and Sorting and Event Lists. If you select an event in the top right-hand pane, the attributes associated with the event are displayed in the Event Attributes pane below, see Event List Columns Attributes. Saving Views There are two save functions for saving a view: the Save View the same selections on the View menu: and Save View As buttons and ● Save View - This saves the view using the same name that it currently has. This function is only available when you have defined a refined filter for the current view. This allows you to add the refined filter to the base filter and save the view without changing its name. For more information about refined filters, see Base Filters and Refined Filters. ● Save View As - This allows you to save the current view using a different name, without affecting the original view. For example, suppose you displayed a work view named “My Activity Today”, then specified a refined filter on the view. Using the Save View As function, you could save the view as “My Activity 2” — a new “My Activity 2” event view is created in which the refined filter expression is added to the original event view’s base filter (if there was one). The original “My Activity Today” event view is unchanged. Creating Event Views Overview There are a number of ways in which you can create event views to provide access to event lists. ● Contextually - This displays a list of events from a specific context, such as from a work item, or a process instance, and so on. For example, you could choose to display a list of events related to the process instance the selected work item is a part of. The specific types of events you can display from a context is customizable. Therefore, the selections you see on your system may vary from those you see in this document. You can create a contextual list of events from various locations in Openspace. For more information, see Creating a Temporary Event List. TIBCO® Openspace User's Guide 106 ● Using the Wizard - A wizard is provided that allows you to create a list of events, filtered and/or sorted in whatever way you require. The wizard provides some templates that have preset filters that allow you to quickly create an event list. For more information, see Creating a List of Events Using the Wizard. Creating a Temporary Event List Procedure 1. Select the required event list item, for example a work item or process instance event. 2. Select one of the available pre-defined filters. This creates an event view containing events of the type you selected in the drop-down list, that are associated with the selected item. For example, if you selected a work item event, “This instance”, the event list contains all events pertaining to the process instance that is associated with the selected work item. The selections in the drop-down list are customizable so those appearing on your system may differ from those shown here. This creates a contextual list of events in a temporary event view to be created in the event view list. The Save View As button in Event Views is enabled, indicating that the event is temporary. If you want to save the event view, it must be saved prior to logging out, otherwise it will be lost, see Saving Views. Creating a List of Events Using the Wizard A wizard is provided that allows you to create a list of events, filtered and/or sorted in whatever way you require. The wizard provides some templates that have preset filters that allow you to quickly create an event list. Procedure 1. Display the event view list by clicking on Event Views in the left part of the screen. 2. Click on the event view list menu bar (or select New from the View menu). The New Event View dialog is displayed: TIBCO® Openspace User's Guide 107 3. In the Name field, type the name of the event view, and (optional) enter a description for the event view in the Description field. 4. Choose how you want the event view to be created by selecting the appropriate radio button, as follows: ● Clicking Create a custom view by specifying a filter causes the list of filter templates on the dialog to be removed from the dialog. Choose this radio button if you want to create an event view by specifying your own filter and/or sort criteria. After choosing Create a custom view by specifying a filter, clicking Next causes the Filter dialog to be displayed — see step 5. ● Choose Create a view by selecting a filter template if you want to use one of the pre-defined filter templates shown in the list. The templates shown in the illustration above are examples that are provided out-of-the-box. However, the templates are customizable and may be different on your system. The Description column provides information about the type of filter that is imposed for each template. If you choose Create a view by selecting a filter template, select one of the available templates. You can then do one of the following: ● Click Next to advance to the Filter and Sort dialogs. This allows you to enter additional filter criteria if required, or to sort the event list as required. If you click Next, proceed to step 5. ● Click Finish to directly create the event view based on the filter template. 5. The Filter dialog allows you to enter criteria so that only the events you are interested in display in the view you are creating: If you selected a filter template in step 4 , you might expect the filter for that template to appear on the Filter dialog. However, the filters for the available templates are specified through a configuration file by an administrator, not through the Filter dialog. Also, if you selected a filter template in step 4 , you can enter additional filter criteria to further pare down the event list. From the Filter dialog, you can do one of the following: ● Enter filter criteria for the event view, then click Next to display the Sort dialog to specify how to sort the events in the view. ● Enter filter criteria for the view, then click Finish if you do not want to specify how to sort the events in the view. ● Click Next to advance directly to the Sort dialog if you do not want to specify filter criteria. Note that any filter criteria you specify through the wizard is considered the “base” filter for the view (as opposed to a “refined” filter that is set through the Filter function on the event list itself). For more information, see Base Filters and Refined Filters. 6. If you have displayed the Sort dialog, specify how to sort the events in the view, then click Finish. The new view appears in the list of event views. Editing an Existing Event List You can edit the definition of an existing event view, in other words, the name, description, filter template (if applicable), filter criteria, or sort criteria. Select the required event view in the event view list, then click (or select Edit from the View menu). The dialog that is displayed at this point depends on how the event view was defined when it was created: TIBCO® Openspace User's Guide 108 ● If a custom filter had been specified when the view was created (as opposed to selecting one of the filter templates), the next dialog displayed contains only the view Name and Description fields. You can modify the name and/or description, then click Finish to complete the edit, or click Next to display the Filter dialog — proceed to step 3. ● If a filter template was selected when the view was created, a dialog similar to the following is displayed: The filter template that was selected when the view was created is highlighted when this dialog is displayed. This dialog allows you to choose a different filter template to apply to the view. Notice that Create a custom view by specifying a filter is disabled; once an event view is created using a filter template, you can only select a different filter template — you cannot specify a custom filter (although, you can add additional filter criteria using the Filter dialog; see step 3). Select a different filter template, if required. Procedure 1. After making the required modifications to the view definition, you can do one of the following: ● Click Finish if you have no require to specify or edit the filter and/or sort criteria for this event view. The Edit Event View dialog is closed and the edited view appears in the event view list. ● Click Next to display the Filter dialog. 2. From the Filter dialog, you can do one of the following: ● Enter filter criteria for the view, then click Next to display the Sort dialog to specify how to sort the events in the view. ● Enter filter criteria for the view, then click Finish if you do not want to specify how to sort the events in the view. ● Click Next to display the Sort dialog if you do not want to specify filter criteria. TIBCO® Openspace User's Guide 109 Note that any filter criteria you specify through the wizard is considered the “base” filter for the event view (as opposed to a “refined” filter that is set through the Filter function on the event list). For more information, see Base Filters and Refined Filters. Filtering event lists is basically the same as filtering other types of lists in Openspace (with the exception of the specific fields on which you can filter). For details, see Filtering Event Lists Overview. 3. If you have displayed the Sort dialog, specify how to sort the events in the view, then click Finish. Because sorting event lists is basically the same as sorting other types of lists in Openspace (with the exception of the specific fields on which you can sort), details of sorting is explained in a single chapter — see Sorting Lists in Event Views. Deleting Event Lists If you don’t need an event view any longer, you can delete it from the event view list. Temporary views are automatically deleted when you log out. To delete an event view, select the event view in the event view list, then click menu bar (or select Remove from the View menu): on the event view list You will be asked to confirm the deletion before it is removed from the event view list. Event Lists To display an event list, select an event view in the left-hand pane. By default, the event list displays a chronological list of events for the selected event view. After displaying the event list, you may filter and/or sort the list so that only the events you are interested in are displayed, in the required order. For more information, see Filtering and Event Lists and Sorting and Event Lists. Selecting Items and Event Lists You can only select a single event at a time in an event list. Selecting an event causes the attributes associated with that event to be displayed in the preview pane. For example: The available columns in the event list provide information that is common to all event types. Attributes provide additional information that is specific to the type of event selected. The attribute list is for informational purposes only — there are no functions associated with it. For more information about event columns and attributes, see Event List Columns Attributes. TIBCO® Openspace User's Guide 110 Event Descriptions Each event has two descriptions defined: a detailed description and a summarized description. For example, for the “Started Instance” event: Summarized Description Detailed Description The detailed descriptions provide more information, but you may find that the summarized descriptions make it easier to scan the event list. You can switch between the two descriptions by selecting Event Descriptions from the event list View menu. The descriptions for events are also customizable by an administrator, therefore, you may see different descriptions than those shown in the documentation. Filtering and Event Lists Filtering a list of events involves entering filter criteria so that only some of the events are shown in the list, rather than all of them. Filtering a list of events allows you to display only the events you are interested in. For example, you may only be interested in events that occurred between 10 A.M. and 2 P.M. on Jan. 4, 2010, or you may only be interested in seeing certain types of events. You can filter the list so that only those events are shown. The filtering function allows you to build a “filter expression” that is applied to all events in the list. If the event satisfies the filter expression (e.g., the Time Stamp is greater than 10 A.M. on Jan. 4, 2010 and less than 2 P.M. on Jan. 4, 2010), it is shown in the event list; if it does not satisfy the filter expression, it is not shown in the list. Pre-defined Filters The event list provides some pre-defined filters that allow you to display a subset of all available events without requiring you to define a filter. The available pre-defined filters are selectable from the dropdown list on the toolbar of Event Views: The available pre-defined filters differ, depending on the type of entity for which you are displaying events. For instance, the list of pre-defined filters for work item events differs from the list of predefined filters for process instance events. TIBCO® Openspace User's Guide 111 Selecting one of the pre-defined filters causes the event list to be filtered according to the pre-defined filter. The pre-defined filter is actually specified using configuration files. Therefore, if you select one of the pre-defined filters, then display the Filter dialog, you will not see the filter expression that is causing the list to be filtered — it can be seen only by an administrator who opens the configuration file in which the pre-defined filters are specified. You are free to further refine any of the pre-defined filters. For example, you could select the “Allocated Work Items” pre-defined filter, then open the Filter dialog and refine the list further. Once you refine a filter, you can save the newly specified refined filter, causing it to be added to the “base” filter — for more information about refined and base filters, see Base Filters and Refined Filters. By default, there is an “All” pre-defined filter for all event types, which displays all of the events for the entity type whose events are being displayed. Pre-defined Filter Definitions The definitions of the pre-defined filters are customizable by an administrator. Therefore, those on your system may be different than those shown in the documentation. Because of this, the documentation does not provide descriptions of each of the default pre-defined filters, as an administrator may have changed the filter definition in the configuration file. However, the following provides guidelines about what you can expect from a pre-defined filter, based on the filter’s name in the drop-down list: ● All - As mentioned earlier, there is an “All” pre-defined filter for all event types. This filter contains all events related to the entity. ● Summary - Generally, this filter displays all events, except for those that are considered low-level, or probably not of interest. The events that are excluded through this filter depends on the entity type whose events you are viewing, as follows: ● — Work items - Excludes all Process Engine-related user task events. (Note that “Process Engine” is denoted as “BX” in event IDs and descriptions.) — Process instances - Excludes all Process Engine-related user task, event (e.g., throw and catch events), and gateway events. — Resources - Excludes all events related to saving user settings, logging in, and logging out. All other pre-defined filters, other than “All” and “Summary” have names that are self-descriptive. For example, “Opened and completed” only displays work item opened and completed events, “Started Instances” only displays start-instance events for the process template. Sorting and Event Lists Event Views allows you to sort the information in the event list so that events are listed in the required order. For example, you may want to list all events by priority number, then sort those by Time Stamp, from oldest to most recent. The sort function allows you to choose which columns on the event list to sort on. Event List Columns Attributes Events have attributes that contain information about the event. Some examples are: ● creationTime - The date and time the event occurred. ● messageId - A unique identifier for the event. ● description - Describes the action that triggered the event. The columns that are displayed in the event list represent event attributes; the column headers are attribute names, and the values in the columns are the values in the attributes. TIBCO® Openspace User's Guide 112 Some attributes are common to all event types, whereas some are unique to a particular type of event. The columns that are shown by default in the event list are those that are common to all event types. In other words, every event has a creationTime attribute, and a description attribute, and a principalName attribute, etc. When you select an event in an event list, attributes that are applicable to that specific event type are displayed in the event attribute list below the event list. In the example above, the BX_INSTANCE_PROCESS_STARTED event contains the attributes shown in the event attribute list. For each attribute in the list, you are shown the current value of the attribute, as well as the type of data in the attribute (e.g., string, date, etc.), and the component in the system that generated the event. Note that the specific attributes that display in the event attribute list can be specified in two ways: ● a system administrator can specify, via a configuration file, which attributes to display. ● you can specify which to display using the Attribute Selector — for information about the Attribute Selector, see Specifying the Attributes to Display in Event Attribute Lists. The event attribute list has a two features that allow you to view/get information about a particular attribute: ● Viewing the attribute description - Hovering the mouse pointer over a value in any of the columns in the event attribute list causes a description of that attribute to be displayed. For example: TIBCO® Openspace User's Guide 113 Note that the description that is displayed is customizable by your system administrator. Your system may show a different description than what is shown here. ● Copying the attribute value - Clicking on a value in the Value column causes a text box to be displayed that contains the value: You can highlight the value and press C to copy it so that it can be pasted wherever it is needed. Specifying the Columns to Display in Event Lists The columns that display by default in event lists represent the attributes that are common to all event types. However, you can customize event lists to display the required columns. Procedure 1. Click Select Columns from the event list View menu. The Column Selector dialog is displayed. The Column Selector lists the available columns/attributes in a tree structure categorized by the components that write values to the attributes. You can expand or collapse the list below each component name, as needed, by clicking on the + or - icon to the left of the component name. Use the Column Selector to choose which columns to display among the available columns. Note that when you customize columns for an event list, it applies only to that particular event list, not to any of the others. Customized columns for an event list are persisted, however, i.e., they will stay customized for that specific event list until you change them again with the Column Selector, or manually. Also, note that persisted settings are saved on the server, so if you log onto a different machine, those settings will be in effect on that machine also. TIBCO® Openspace User's Guide 114 As mentioned above, the default out-of-the-box columns in the event list are those that are common to all event types. However, you can specify a new default by clicking Set as Default Columns from the event list View menu. 2. Select the required columns, using the following actions: ● Individual columns can be selected by clicking on the required name. ● Multiple columns can be selected by holding down the Ctrl key while clicking on the required names. ● A group of columns can be selected by clicking on one name, then holding down the Shift key and clicking on the last name in the required group. 3. Move columns to the required list in the Column Selector: ● Columns can be moved back and forth between lists by selecting the required column(s), then clicking the “>” or “<“ buttons. ● An individual column can be moved from one list to the other by double-clicking on the column name. ● Columns can also be moved from one list to the other by using a “drag and drop” method — click on the required column name (or group of selected column names), and while holding the mouse button, drag them to the required list and release the mouse button. ● All columns can be moved from one list to the other by clicking on the “>>” or “<<“ buttons. You can also change the columns to the current default for that list type by clicking the Use Default button. 4. Once the columns you want displayed are shown in the list on the right, you can change the order in which they will appear on the list by doing one of the following: ● Using the Order buttons. Click on the column whose order you would like to change, then click on the Order button to move the column up or down in the list. ● Using the drag and drop method. Click on a column and drag it to the required location in the list. 5. Click OK when the list on the right contains the columns you would like displayed, in the order you would like them displayed. The list is displayed with the chosen columns. Specifying the Attributes to Display in Event Attribute Lists The event list contains an Attribute Selector that allows you to specify which attributes to display in the event attribute list. Procedure 1. Choose Select Attributes from the event list View menu. The following dialog is displayed: TIBCO® Openspace User's Guide 115 This dialog is used to specify which attributes to display in the attribute list. ● Attributes listed in the Available Attributes list on the left are available, but have not been designated to display in the event attribute list. The attributes listed in the Available Attributes section are categorized by the components that write the value to the attribute. Notice that if all of a particular component’s attributes are moved to the Selected Attributes section on the right, the component name is still shown in the Available Attributes section, with “empty” shown below the component name. ● Attributes listed in the Selected Attributes list on the right are the attributes that will be displayed in the event attribute list. The attributes in the Selected Attributes list are shown in the event attribute list only if they are applicable to the type of event selected in the event list. 2. Select the required attributes, using the following actions: ● Individual attributes can be selected by clicking on the required name. ● Multiple attributes can be selected by holding down the Ctrl key while clicking on the required names. ● A group of attributes can be selected by clicking on one name, then holding down the Shift key and clicking on the last name in the required group. 3. Move attributes to the required list in the Attribute Selector: ● Attributes can be moved back and forth between lists by selecting the required attributes, then clicking the “” or “<“ buttons. ● An individual attribute can be moved from one list to the other by double-clicking on the attribute name. ● Attributes can also be moved from one list to the other by using a “drag and drop” method — click on the required attribute name (or group of selected attribute names), and while holding the mouse button, drag them to the required list and release the mouse button. ● All attributes can be moved from one list to the other by clicking on the “ > ” or “<<“ buttons. TIBCO® Openspace User's Guide 116 You can also change the attributes to the system defaults by clicking the Use Default button. 4. Click OK when the list on the right contains the attributes you would like displayed in the attribute list. Also note that the specific attributes that are listed in the Attribute Selector are customizable by the system administrator. Therefore, you may see different attributes than are shown in the example above. You can view a description of an attribute on the Attribute Selector by hovering the mouse pointer over the attribute name. Sub-Process Events If an event in Event Views has a event: character to the left of the event, it means it is a sub-process start Clicking on the character expands the list to include the events related to the sub-process that was started. The events related to the sub-process are shown indented below the sub-process start event: Sub-processes can be many levels deep, that is, a task in one process can start another process, which can contain a task that starts another process, and so on. Each time another sub-process is started, the event hierarchy is shown with additional characters that can be expanded. For example: TIBCO® Openspace User's Guide 117 By default, a maximum of 100 events will be shown under a sub-process start event (although this number is configurable by a system administrator). This means that if there are more than 100 events related to the expanded sub-process, you will not be able to see them by expanding the list in this way. An alternative is to select the “Started instance” event, then select “This instance” from the Links menu to create a new event list containing all of the events related to the sub-process instance that was started. Filtering Event Lists Overview Filtering a list involves entering filter criteria so that only some of the items are shown in the list, rather than all of them. Filtering a list allows you to display only the items you are interested in. For example, you may only be interested in events that occurred between 10 am and 2 pm on Jan. 4, 2010, or you may only be interested in seeing certain types of events. You can filter the list so that only those events are shown. Filter criteria are specified using the filter dialog: Base Filters and Refined Filters Using Event Views you can specify a base filter and a refined filter. ● Base filter - This is a filter that has been permanently saved in the view definition. You can specify a base filter through the view wizard when creating a view, or later by editing the view. The base TIBCO® Openspace User's Guide 118 filter can also be modified by specifying a refined filter, then adding that filter to the base filter by saving the view after specifying the refined filter. ● Refined filter - This is a filter that is specified through the Filter function on the event list. It allows you to refine the base filter if there is one specified. Refined filters are persisted between log outs and application restarts. If you define a refined filter on a list, then either log out or restart the application, the refined filter will still appear when you view the list. Defining a Base Filter A base filter can be specified for an event view in several ways. ● By specifying a filter when the view is created. ● By editing an existing view, and specifying/modifying the filter. ● By specifying a refined filter, then saving the view. This causes the refined filter to be added to the base filter (if one exists), creating a new base filter. Currently, the only way to tell if there is a base filter defined for a view is to open the view wizard and look on the Filter dialog. Defining a Refined Filter A refined filter can be specified for an event view by using the Filter function on the event list. Once you specify a refined filter, the Filter button contains a green check to indicate that a refined filter is in effect. Also, the Save View button/menu selection becomes enabled. Procedure ● You can save a refined filter in one of two ways: ● Save View- This button/menu selection on the list adds the refined filter to the base filter, creating a new base filter (if there was no base filter defined previously, the refined filter becomes the base filter). ● Save View As- This allows you to save the view with a new name. The original view is not changed. The new view will have the original base filter (if defined) and the refined filter. When you specify a refined filter, then save the view (with either Save View or Save View As), the refined filter is added to the base filter, then removed from the event list. This results in the Save View button being disabled, and the check no longer appears next to the Filter button. So if you open the Filter dialog from the list after saving the view, it will not show a filter. However, if you open the Filter dialog using the view wizard, you will see that the refined filter has been added to the base filter. Refined filters are persisted between log outs and application restarts. If you define a refined filter on a list, then either log out or restart the application, the refined filter will still appear when you view the list. Accessing the Filter Function The filter function for event lists can be accessed either from the view definition, or from the list itself. ● From the view definition - When you are creating or editing an event view using the view wizard, a Filter dialog is displayed from which you can filter the contents of the view (for information about creating/editing views, see Event Views. Note that if you specify a filter in this way, it becomes the base filter for the view — for more information, see Base Filters and Refined Filters. TIBCO® Openspace User's Guide 119 ● ● button, or select Filter from the View menu on the event From the event list itself - Click on the list. Note that if you specify a filter in this way, it is considered a refined filter for the view — for more information, see Base Filters and Refined Filters. Filter Expression Example Basic filter expressions are very easy to specify in Openspace. This example shows how to display all work item scheduling events that were created by tibco-admin. This same example can also be used if you need to filter on only a single criteria. In which case, skip steps 4 and 5. Procedure 1. Display the event list filter dialog by clicking on the Filter button on the event list. 2. From the Grouping section on the filter dialog, double-click on the All Of entry: The All Of entry is added to the Filter section: All Of indicates that if “all of” the filter criteria that is specified below that icon is true for a work item, the work item is returned from the server and displayed in the work item list. Note - The filter expression defaults to an “all of” expression. Therefore, this step is technically not necessary for this type of expression. It is being added here for completeness. 3. From the Attributes section on the filter dialog, double-click the Principal Name attribute: TIBCO® Openspace User's Guide 120 Note that you can also "drag and drop" the PrincipalId attribute into the Filter section, or right click and select Insert Item. The PrincipalId data-entry dialog is displayed in the Filter section. This is the first criteria that must be true for the event to be displayed in the list. 4. In the PrincipalId data-entry dialog, select “equal” from the drop-down list and type tibco-admin in the field below, then click the Add button: Specifying a Filter Expression The filtering function allows you to build a “filter expression” that is applied to all items that could potentially be in the list. If an item satisfies the filter expression, it is shown in the list; if it does not satisfy the filter expression, it is not shown in the list. Specifying a filter expression is done using the filter dialog. TIBCO® Openspace User's Guide 121 This dialog is displayed by clicking on the Filter button, by selecting Filter from the event list pane or when creating a view with the view wizard. Specifying a filter expression is done from the filter dialog. Procedure 1. Choosing a Filter Grouping - This specifies “All Of” or “Any Of”. 2. Selecting Filter Attributes - The values in the attributes you choose determine whether or not each item is included in the list. 3. Applying the Filter Expression - This tells you how many items will be returned from the server and shown in the list. Choosing a Filter Grouping Choosing a filter grouping specifies that you want the list to include items where either, “all of” the specified filter criteria are true, or “any of” the specified filter criteria are true. Choose “All Of” or “Any Of” in one of the following ways: ● Double-click on the required entry in the Grouping section, TIBCO® Openspace User's Guide 122 ● click on the required entry and drag it into the Filter section, or ● right-click on the required entry and select Insert Item from the context menu. This causes the selected entry to appear in the Filter section. For example: You can specify multiple “All Of” and “Any Of” entries in the Filter section. For more information, see Combining “All Of” and “Any Of”. Default Filter Grouping Note that the default filter grouping is “All Of”. If you don’t explicitly add a filter grouping to the Filter section, then add an attribute, it is displayed without a filter grouping. For example: If you apply this filter expression, it displays all items that satisfy the single criteria. Then if you add another attribute to the Filter section, the system automatically adds the default “All Of” group. For example: Modifying the Filter Grouping Openspace allows you to change an “All Of” to an “Any Of”, or vice versa, in the Filter section. ● double-clicking on the entry in the Filter section, ● right-clicking on the entry, then selecting Modify Item, ● selecting the entry, then clicking on the Modify Expression button in the menu bar, or ● selecting the entry, then selecting the Modify selection on the Tools menu in the Filter section: TIBCO® Openspace User's Guide 123 Combining “All Of” and “Any Of” Most filter expressions will include a single “All Of” or “Any Of” filter grouping. However, you can also combine them in a single expression to create more complex expressions. When combining “All Of” and “Any Of” you are essentially combining logical ANDs and ORs in a single expression. When combining filter groupings, it is helpful to view the filter syntax as you build the filter expression, as parentheses are placed in the appropriate location in the syntax as you add groups. To view the filter syntax, select Show Expression from the Tools menu in the Filter section. A filter grouping that is added subordinate to another filter grouping is enclosed in parentheses when the system builds the filter syntax; this means that the subordinate grouping is evaluated separately, then its result is used to evaluate the parent grouping. See the following examples. To view events that have been scheduled by tibco-admin, and have a priority of 1 or 2, build the following filter expression: Selecting Filter Attributes Selecting filter attributes involves choosing the attributes upon which you want to filter the items, then entering a value for each attribute. When filtering event lists, the Attributes section on the filter dialog lists all of the filterable attributes, which is a subset of all available event attributes. They are displayed in a tree structure categorized by the component that writes values to each attribute. You can expand or collapse the list below each component name, as needed, by clicking on the + or - icon to the left of the component name. The Attributes section on the filter dialog lists all of the attributes on which you can filter. ● Double-click on the required attribute in the Attributes section, ● click on the required attribute and drag it into the Filter section, or ● right-click on the required attribute and select Insert Item from the context menu. TIBCO® Openspace User's Guide 124 This causes the data-entry dialog for the selected attribute to appear in the Filter section. For example: The data-entry dialog for every attribute contains the following data-entry fields: ● Logical operator - This is a drop-down list that allows you to choose how the specified value is to be compared to the actual values in the attributes of the item. You can specify “equal to”, “not equal to”, “less than”, etc. The logical operator drop-down list also includes a “Range” selection for DateTime attributes, which allows you to specify a range of dates/times for which you would like events returned. For information about using the Range operator, see DataTime Ranges. ● Value field(s) - Each data-entry dialog contains one or more value fields in which you enter the value for the items you want returned. The way in which you enter a value depends on the data type for the attribute you are adding. The data type for each attribute is shown in the tables in Selecting Filter Attributes. For information about data types, see Value Data Types. After choosing a logical operator and entering a value, you can add the filter attribute to the filter expression by clicking on the Add button (or just press the Enter key): The filter attribute is added to the filter expression in the Filter section. For example: TIBCO® Openspace User's Guide 125 You can add additional filter attributes to the filter expression in the manner described above. The filter attribute data-entry dialog has a couple other buttons on it that allow you to either close the dialog without making changes, or remove the attribute from the filter expression: ● To close the data-entry dialog without making any changes, click on the Close button: ● To remove the filter attribute currently displayed in the filter expression, click on the Remove button: Value Data Types The value entered in the Value field must match the data type for the attribute selected. Data Type Description Numeric Consists of one or more of the numbers 0-9. Used for things like ID and priority. The data entry field for numeric values will not allow you to enter any characters other than numbers. Text Consists of any number of letters, numbers, or special characters (e.g., #, $). Filtering on text is case sensitive. Note that text attributes are the only attribute types with which you can use wildcard characters. For more information, see Using Wild Card Characters. If you are filtering on text that contains any of the four special characters (*, ?, ‘, or \), they must be “escaped”. For information, see Filtering on Special Characters. TIBCO® Openspace User's Guide 126 Data Type Description DateTime Dates can be entered manually or by using the “date picker” on the filter data-entry dialog. Times, if specified, must be entered manually. If you enter a date, but not a time, it assumes “all times” for the specified date. All times use the 24-hour clock. There is also a special "Today" entry that can be used when filtering on DateTime attributes. This entry always represents the current date. For more information about entering dates and times in the filter data entry dialog, see DateTime Attributes. Enumeration Some attributes only allow you to select a valid entry. These are called “enumerations”. DateTime Attributes Filter data-entry dialogs that contain a DateTime attribute (for example, Start Date) are shown in the DateTime dialog. Dates and times can be entered for these attributes in the following ways: ● Dates can be entered in two ways: — Using the “date picker”, which is the calendar icon to the right of the date field. Clicking on the date picker icon displays a calendar from which you can choose the required date — the selected date is automatically entered in the date field. — Manually enter the date. If entered manually, it must be in the following format: YYYY-MM-DD where YYYY = year, MM = month, and DD = day. For example: 2008-08-25 As you enter the numbers, the hyphens are automatically entered for you. If required, you can also manually enter just a portion of the date, starting from the left. For instance, you can manually enter just "2009" in the date field — this means "all of 2009". Or you could enter just "2009-05" (the hyphen is automatically entered) — this means "all of May 2009". Or you can manually enter the entire date. ● Times are optional. If entered, they must be entered manually, in the following format: hh:mm:ss.nnn where hh = hour (using the 24-hour clock), mm= minute, ss = second, and nnn = milliseconds. For example: 15:30:00.000 TIBCO® Openspace User's Guide 127 If the time is not specified, Openspace assumes “all times” for the specified date. For example, if you specified “Start Date = 2008-10-04”, with no time, it will return all work items that were started on Oct. 4, 2008, regardless of the time they were started. If desired, you can enter just a portion of the time, starting from the left. For instance, you can enter just "10" in the first of the time fields — this means "all times that begin with 10 o’clock". Note that all times that are displayed in Openspace are based on your local time. So even if someone else in a different time zone than you starts a process instance, when you view the process instance, the start time is shown in your local time. It is your local time that you would enter in a filter dialog. Dynamic Time-Period Point-in-Time Entries When filtering on DateTime attributes, there are a number of entries you can select from that dynamically calculate a time period or point in time. The available dynamic time-period / point-in-time filter entries are displayed from the drop-down list to the left of the date attribute field. Dates and times can be entered for these attributes in the following ways: Each of these special entries calculates the time period or point in time when the filtered list is viewed, not when the filter was defined. The available dynamic time periods and points in time are described below: ● Today- The current day, from 12:00 A.M. to 12:00 P.M. ● This week- The current week, from 12:00 A.M. Sunday morning to 12:00 P.M. Saturday evening. ● This month- The current month, from the 1st through the last day of the month. ● This quarter- The current 3-month period used as a quarter by your company. The specific three months to which this refers depends on how your system is configured. As different companies use different months on which to begin a quarter, this may be referring to: ● — This month, and the next two months, — last month, this month, and next month, or — the previous two months, and this month. This year- The current year, from January 1 through December 31. TIBCO® Openspace User's Guide 128 Also note that if you choose any of the Today, This week, This month, This quarter, or This year dynamic time periods, another field is displayed on the dialog that allows you to also include an additional number of like time periods, either in the past, or in the future: In the field on the bottom of the dialog, select previous or future from the drop-down list to also filter on an additional number of periods in the past or the future, respectively. For example, if you chose to filter on “Today”, you could have it also return items from any number of previous days. ● Previous period- This allows you to filter based on a specified number of days, hours, and/or minutes in the past. Note that this period is calculated from the moment you invoke the filter, plus every time the list is refreshed. The "Equal" operator returns all items that fall within that time period, and "NotEqual" returns all items outside of the time period. The "LessThan" and "GreaterThan" operators return all items that fall previous to the time period, or after the time period, respectively. Note, however, that the LessOrEqualTo" and "GreaterOrEqualTo" operators return all items that either fall previous to or after the time period, as well as those that fall within the time period. ● Future period- This allows you to filter based on a specified number of days, hours, and/or minutes in the future. Note that this period is calculated from the moment you invoke the filter, plus every time the list is refreshed. The operators work the same as for "Previous period" — see above. ● Previous time- This specifies a specific point in time in the past, relative to the time at which you invoke the filter, or refresh the list. This would normally be used with the "greater than" or "less than" operators, because it defines a point in time, not a time period. If you used the "Equal" operator, the list will contain only those items that match the point in time exactly. ● Future time- This specifies a specific point in time in the future, relative to the time at which you invoke the filter, or refresh the list. This would normally be used with the "greater than" or "less than" operators, because it defines a point in time, not a time period. If you used the "Equal" operator, the list will contain only those items that match the point in time exactly. ● Now- This represents the current time. This would normally be used with the "greater than" or "less than" operators, because it also defines a point in time, the current time. TIBCO® Openspace User's Guide 129 DataTime Ranges When filtering on DateTime attributes, you can select a logical operator of "Range". This allows you to request that all items that fall within a range of dates be displayed in the list. Selecting "Range" causes another set of fields to be added to the filter dialog. Enter the beginning date/time of the range in the first set of fields, and the ending date/time of the range in the second set of fields. The date/time comparison is inclusive. For example, if you are filtering on the start date, and the range is from May 1, 2009 to May 3, 2009 (with no times specified), all items with a start date on May 1, 2, and 3, are displayed in the list. Using Wild Card Characters The wild card characters ’*’ and ’?’ can be used when filtering on text attributes (work item name, description, etc.) — wild card characters cannot be used with any other attribute type. The ’*’ and ’?’ characters are evaluated as follows: ● ● ‘*’ matches zero or more of any character. For example: — “bo*” matches anything beginning with “bo”. For example, “bo”, “bobbl”, “boulton_anne”, etc. — “s*s” matches anything beginning with “s” and ending with “s”. For example, “ss”, “sues”, sid_lewis”, etc. — “*s” matches anything ending with “s”. For example, “franks”, “ls”, “martha_lyons”, etc. ‘?’ matches any single character. For example: — “bill?” matches anything beginning with “bill”, plus one more character. For example, “bills”, “bill5”, “billh”, etc. — “c?ndy” matches “cindy”, “candy”, “c3ndy”, etc. Also note that all character matching is case sensitive. Applying the Filter Expression At any point after adding a filter attribute to the filter expression, you can apply it to determine how many items satisfy the expression. To apply the filter expression shown in the Filter section: ● Click the OK button (without clicking Apply first). This causes any filter expression you’ve entered to be applied and the list displayed. But you will not know the number of items that will be returned in the list until after the list is displayed. ● Click the Apply button. The system will apply the filter expression and calculate how many items satisfy the expression. This number is shown on the top of the Filter section (11 in this example): TIBCO® Openspace User's Guide 130 If you clicked Apply, and the number of items that will be returned from the server is satisfactory, click the OK button to display the list. If the number of items is still too large, you can modify any of the previously entered values, or add/ remove attributes from the expression, then click Apply again to get a new item count. Anytime you add, delete, or modify a filter expression in the Filter section, and have not yet clicked the Apply button to apply it, the following message is shown to notify you that the changed filter expression has not been applied: Whenever the message shown above is displayed, the Apply button will be active. Note that if you are applying the filter expression from the list itself (rather through the view definition), the Filter icon will now contain a check mark to indicate that a refined filter is currently applied on the list: Modifying an Existing Filter Expression Task topics are at the heart of most documentation sets. Users want to know how to do something, what the prerequisites of the task are, and what to do next. After you’ve specified your filter expression in the Filter section, it can be modified in a number of ways. For example: ● ● Change an “All Of” to an “Any Of”, or vice versa. This can be done in the following ways: — double-click on the entry in the Filter section, — right-click on the entry, then select Modify Item, — select the entry, then click on the Modify button in the Filter section, or — select the entry, then select the Modify selection on the Tools menu. Modify the value you’ve specified in one of the filter attributes. Display the data-entry dialog for an existing attribute in one of the following ways: — Double-click on the attribute name in the Filter section, TIBCO® Openspace User's Guide 131 ● — right-click on the attribute name, then select Modify Item, — select the attribute name, then press the Enter key, — select the attribute name, then click on the Modify button in the Filter section, or — select the attribute name, then select the Modify selection on the Tools menu. Delete a filter attribute from the filter expression. You can remove a filter attribute from the filter expression in one of the following ways: — Right-click on the desired attribute name, then select Delete Line, — select the attribute name, then select the Delete Line selection on the Tools menu, or — select the attribute name, then click on the Delete Line button in the Filter section. Notice that this button is one of three delete buttons provided in the Filter section: The Delete Line button deletes only the currently selected line (filter attribute). The Delete Branch button is active only when an “All Of” or “Any Of” entry is currently selected; it deletes the entire “All Of” or “Any Of” branch, including all filter attributes in that branch. The Delete Branch function is more applicable when creating a filter expression that contains a mixture of “All Of” and “Any Of” entries; these are explained in Combining “All Of” and “Any Of”. The Delete All button deletes all entries in the Filter section. Viewing the Filter Syntax As you are adding attributes to the Filter section to build the graphical representation of the filter expression, Openspace is creating the syntax that the server needs to process the expression. If you have a need to view the syntax (perhaps for debugging purposes), you can do so by selecting Show Expression from the Tools menu. The filter syntax is displayed on the bottom of the Filter section. The filter expression cannot be modified using the syntax — it is provided only for viewing purposes. Note that if you are filtering on a DateTime, a time zone offset is shown following the time. This is required by the server because it stores all times in Greenwich Mean Time (GMT). The offset is telling the server the number of hours you are, plus or minus, from GMT. In the example shown above, the application is running in a locale that is -7 hours from GMT. You don’t need to be concerned with this offset, other than to know why it’s shown in the filter syntax. TIBCO® Openspace User's Guide 132 Also, if you are filtering on a DateTime, and you specify "equal to" or "not equal to" a specific date, the syntax appears as a range because of the way the filter must be applied internally. For example: To close the window that displays the filter syntax, select Hide Expression from the Tools menu. Sorting Lists in Event Views You can sort event lists in Openspace. Openspace allows you to sort information displayed in event lists so that it is shown in the desired order. If you had applied a sort order the last time you displayed a list, that same sort order will be applied when you open that particular list again — in other words, the most recently applied sort order for each list/view will remain persistent until you either change it or remove it. Note that persisted settings are saved on the server, so if you log onto a different machine, those settings will be in effect on that machine also. If a sort order is still active, the Sort button will be shown with a check mark, and if the sort dialog is displayed, the previously entered sort specification will still be shown. You can choose the attributes/columns in the list to sort on. If you are sorting on multiple attributes, you can specify which attribute to sort on first, second, and so on. You can also choose to display the list in ascending or descending order or apply sort criteria so the display list in the desired order. Accessing the Sort Function The sort function can be accessed either from the list itself, or from the view that defines the list. ● From the list - Click on the ● From the view definition - When you are creating or editing an event view using the view wizard, a sort dialog is displayed from which you can sort the contents of the view. (For information about creating views, see Event Views) You can either specify a sort order, or click Finish to forego sorting the list. button, or select Sort from the View menu. TIBCO® Openspace User's Guide 133 Selecting Sort Attributes By default, before you specify a sort for the first time, all attributes that are available to sort on are shown in the Available Attributes section on the sort dialog. It lists an attribute for each column in the list. To specify sort attributes, move the attributes on which you want to sort the list to the Sort Attributes section on the sort dialog. Attributes can be moved back and forth between the Available Attributes and Sort Attributes sections using the following methods. To select attributes: ● Individual attributes can be selected by clicking on the desired name. ● Multiple attributes can be selected by holding down the Ctrl key while clicking on the desired names. A group of attributes can be selected by clicking on one name, then holding down the Shift key and clicking on the last name in the desired group. To move the attributes to the desired list: ● Attributes can be moved back and forth between lists by selecting the desired attribute(s), then clicking the “” or “<“ buttons. ● An individual attribute can be moved from one list to the other by double-clicking on the attribute name. ● Attributes can also be moved from one list to the other by using a “drag and drop” method — click on the desired attribute name (or group of selected attribute names), and while holding the mouse button, drag them to the desired list and release the mouse button. ● All attributes in the Sort Attributes section can be moved to the Available Attributes section by clicking on the “<<“ button. TIBCO® Openspace User's Guide 134 Specifying Sort Order Sort order is applicable only if you have specified multiple sort attributes. It allows you to specify that the list be sorted first on one attribute, then on another attribute, and so on. To change the order, move the desired attributes up or down in the Sort Attributes list. You can do this in one of the following ways: ● select the desired sort attributes in the Sort Attributes list, then click on the “Up” or “Down” Order button on the sort dialog to move the attributes up or down in the list, or ● “drag and drop” the attributes to the desired location in the list — select the desired attributes, and while holding the mouse button, drag the attributes up or down in the list, then release the mouse button. Specifying a Sort Direction You can specify that items in a list be sorted in either ascending or descending order: You can specify a sort direction for each of the attributes listed in the Sort Attributes list. They are set to ascending order by default when you add them to the list. To change the sort direction, select the desired sort attribute(s) (you can change multiple attributes at one time) in the Sort Attributes list, then click on the Ascending or Descending buttons on the sort dialog: The icon next to the attribute name will change to indicate the new sort direction: Applying the Sort Criteria After specifying the sort attributes, sort order, and sort direction, click on the OK button to apply the sort criteria you’ve specified. When you click the OK button, a check mark appears in the lower right part of the Sort icon to indicate that the list is being sorted: TIBCO® Openspace User's Guide 135 Sorting a List Using Column Headers You can quickly and easily sort any list on any one of the columns in the list. To sort on a column, click on the column header. If the column contains text, it is sorted in alphabetical order; if it is numeric, it is sorted in numerical order; if it is a date, time, or DateTime, it is sorted in chronological order. Once you click on a column header, a small arrow head appears in the column header, which indicates the order of the sort — if the arrow head is pointing up, the sort is in ascending order; if it’s pointing down, the sort is in descending order: Each successive click on the column header, toggles between ascending and descending order. Note, however, if the list consists of multiple “pages”, each page is individually sorted on the column you’ve clicked on. To sort through all of the available pages, use the Sort function on the toolbar or View menu. Auditing Process Data Process data appears in the audit trail if your system has been configured to audit process data. It appears in both the graphical audit trail as well as the Event Viewer. Auditing of process data must be configured at design-time using TIBCO Business Studio (see the TIBCO Business Studio Modeling Guide). The following two illustrations show process data appearing in work item attributes -- the first illustration is of the graphical audit trail; the second is of the Event Viewer. TIBCO® Openspace User's Guide 136 Graphical Audit Trail Event Viewer TIBCO® Openspace User's Guide 137 In these examples, two data fields have been mapped to two work item attributes -- Attribute3 and Attribute8. The values that were entered into the data fields appear in the attributes. If a work list facade has been defined on your system, and display labels have been assigned to Attributes 3 and 8, the labels are shown in the graphical audit trail and Event Viewer rather than "Attribute3" and "Attribute8". For more information, see Displaying Work Item Attributes Names. Also note that if process data is being audited, you may see an entry like the following in the Event Viewer: This indicates that the value in the attribute has been truncated because the value entered in the data field is too long to fit in the attribute to which the data field was mapped. The *nn* indicates that the value has been truncated, where nn is the number of characters that were entered into the data field. TIBCO® Openspace User's Guide 138 Calendars The Calendar gadget enables you to create calendars for use with TIBCO ActiveMatrix BPM. The working and non-working times defined in these calendars are used when performing date calculations. For example, when TIBCO ActiveMatrix BPM schedules a user task, it uses the calendars to calculate the work item’s duration and any deadline. Calendars are not deployed, they are created in TIBCO ActiveMatrix BPM at runtime. To view and create calendars, you must be logged in as a user that has privileges with the correct system actions assigned. These are described in Required System Actions . The following information can be maintained in calendars: ● working days and times. These are the days and time of your working hours. ● exceptions. These are exceptions to your normal working days and times. For example, a one-off exclusion like a Company lunch, or exclusions that are repeated over a defined period of time, like a regular company meeting. ● available working hours. These are defined as your working hours minus exceptions. For example, if your normal working hours are seven hours a day, but you have a two hour company meeting scheduled on a particular day then, on that day, you have five available working hours. By default, when you first login to Openspace, one system calendar is defined and no working days or times have been specified. The system calendar applies to all of TIBCO ActiveMatrix BPM. You can use the system calendar to define the working days/times and/or any exclusions in your system calendar. However, if you want to express working times and calculate deadlines for locations in different time zones or organizational units with different working hours, for example, you can define base and overlay calendars and apply them to an organizational entity. By default, if no base or overlay calendars are defined, TIBCO ActiveMatrix BPM uses the system calendar to calculate working hours. See Calendar Example for more information on how to configure your calendars depending on your organization. Base Calendars Base calendars maintain basic information regarding working times (for example, hours in the standard working week). You can use base calendars to express different working times for particular organization units or for locations in different time zones. Note that: ● You must map a base calendar to an organizational entity before you can use it. Base calendars cannot be mapped to resources. ● Base calendars are mapped to organizational entities using their alias. You can either: — define an alias before you map a base calendar to an organizational entity, or — define an alias when mapping a base calendar to an organizational entity. See Calendar Aliases (References). ● A base calendar can be mapped to multiple organizational entities. ● An organizational entity can only have one base calendar mapped to it at any time. ● You can remap a base calendar to a different organizational entity at any time. TIBCO ActiveMatrix BPM uses the latest calendar mapping so you should make sure that if you do remap a calendar while a process is deployed that it does not adversely affect the process. TIBCO® Openspace User's Guide 139 ● A base calendar is associated with a particular time zone, however working hours are time zone neutral. In other words, when specifying working hours, you should specify your working hours according to your own time zone. TIBCO ActiveMatrix BPM then interprets those hours according to the time zone you have specified. ● If the base calendar’s time-zone value changes, future entries are displayed adjusted to the new timezone, but existing entries are not adjusted. So if you define the start of the working week as 08:00 on Monday, it is still 08:00 on Monday even if the time zone of the calendar changes. Overlay Calendars Overlay calendars define non-working time exclusions (for example, public holidays) which can be applied to one or more base calendars at runtime. You should use overlay calendars for exclusions that are repeated over a defined period of time, like a regular company meeting. An overlay calendar is timezone-neutral, and so inherits the time zone from the base calendar it is applied to. Note that: ● You must map an overlay calendar to an organizational entity. Overlay calendars cannot be mapped to resources. ● Overlay calendars are mapped to organizational units using their alias. You can either, — define an alias before you map an overlay calendar to an organizational entity, or — define an alias when mapping an overlay calendar to an organizational entity. See Calendar Aliases (References). ● An overlay calendar can be mapped to multiple organizational entities. ● An organizational entity can only have one overlay calendar applied to it at any time. ● You can remap an overlay calendar to a different organizational entity at any time. TIBCO ActiveMatrix BPM uses the latest calendar mapping so you should make sure that if you do remap a calendar while a process is deployed, that it does not adversely affect the process. Calendar Aliases (References) TIBCO ActiveMatrix BPM uses calendar aliases at runtime to identify the calendars that should be used. This enables you to reflect situations where different parts of the organization have different working patterns. By default, if no calendar alias is mapped, TIBCO ActiveMatrix BPM uses the system calendar. Calendar aliases are called “references” in TIBCO Business Studio and TIBCO ActiveMatrix BPM. Assigning a calendar reference is done in TIBCO Business Studio. If you want to use different calendars from the system calendar then you must do the following: ● Specify the calendar reference to be used when defining your processes in TIBCO Business Studio. See the "Intermediate Events" section in the TIBCO Business Studio Process Modeling User’s Guide for more information on calendar references in Business Studio. ● Create the calendar alias. You can either: — Create the calendar alias using the Calendar Aliases option from the Manage menu in the Calendar gadget. See Calendar Aliases. — Create the alias when you map the calendar to an organizational entity. See Assigning Calendars to Organizational Entities. TIBCO® Openspace User's Guide 140 ● Map the calendar to an organization entity, making sure you specify the calendar alias when defining the mapping. Note that: ● An alias does not have to exist in Openspace when you create a calendar reference in your process. You can specify an alias in TIBCO Business Studio and then create it later in Openspace. See Calendar Aliases. ● A calendar can have more than one alias. ● You can map a calendar to multiple organizational entities using the same alias. ● You can remap aliases to organizational entities at any time. TIBCO ActiveMatrix BPM uses the latest calendar mapping so you should make sure that if you do remap a calendar while a process is deployed, that it does not adversely affect the process. Calendar Time Zones In TIBCO ActiveMatrix BPM, base calendars each have a timezone specified (see the time-zone parameter to saveCalendar). This enables you to use different base calendars in different locations around the world. Overlay calendars do not specify a timezone, so that an overlay can be applied on to any base calendar without any conversion. TIBCO ActiveMatrix BPM stores all date-time entries, whether on a base or an overlay calendar, with a timezone of UTC attached. This does not mean that they are necessarily intended to represent UTC times; in effect times are treated as timezone-neutral. For example, working hours entered as 08:00 to 17:00 on a base calendar with its timezone set to PST (UTC minus 8 hours) are actually stored as 08:00 to 17:00 UTC, not as 16:00 to 01:00 UTC. In most cases this is completely transparent to the user, but you need to be aware of how TIBCO ActiveMatrix BPM handles timezones and date-time values if you are making calls directly to the API. Changing a base calendar’s time-zone value does not cause any adjustments to existing or future calendar entries. So if you define the start of the working week as 08:00 on Monday, it is still 08:00 on Monday even if the time zone of the calendar changes. Although the date-time values are timezone-neutral, it is best practice to specify a timezone of Z (UTC) for values such as the time-slot start and end times that define working hours entries in a base calendar. If no timezone is specified, some APIs used by TIBCO ActiveMatrix BPM will automatically convert the value to the timezone used by the server, regardless of the calendar’s time-zone specification. This may not always be the timezone required. For example, if a user in Paris accesses a server in California and enters a calendar time of 11:00, expecting it to be 11:00 CET (10:00 UTC), the time would be interpreted as 11:00 PST and stored as the UTC equivalent of that time, 19:00 UTC. Entering 11:00Z, however, will be stored as 11:00 UTC. Times should be treated in this way whether they are for base or for overlay calendars. This enables the entries to be applied as if they were timezone-neutral, so that any overlay calendar can be applied on top of any base calendar. Exclusions in Calendars Calendar exclusions are exclusions from a standard working day. You can define exclusions in both your base calendars and your overlay calendars, depending on your requirements. ● You can create exclusions directly in your system or base calendars. These can be both one-off events that do not occur all the time, for example, an unexpected company meeting or exclusions that repeat over a defined period of time. ● Create overlay calendars for exclusions that repeat over a defined period of time. For example, you can define such exclusions as: TIBCO® Openspace User's Guide 141 — Every Friday from 14:00 to 18:00 — The first Monday of the month, for the next six months These exclusions are defined using a recurrence rule, that sets out how the start date/time of each occurrence of the exclusion is calculated. The rule is given in the standard notation set out in http://tools.ietf.org/html/rfc5545. How Calendars are Resolved When determining how to calculate deadlines, TIBCO ActiveMatrix BPM traverses the organization model, from the given organization entity, for example a group and then works up the hierarchy of groups, organization units, locations, organizations, and so on, until the first overlay calendar is identified. The first overlay calendar identified is applied to the first base calendar identified, and the working hours identified. If no calendars are identified, then the default system calendar is used. Required System Actions To use calendars in Openspace you must login as a user that has certain system actions assigned. For each of the functions you can perform, a system action is required to perform them. Function readCalendar writeCalendar deleteCalendar New Base Calendar Yes Yes No New Overlay Calendar Yes Yes No Open Calendar Yes No No Copy Calendar Yes Yes No Calendar Aliases Yes Yes No Map to Organization Model Yes Yes No Specify Working Hours Yes Yes No Specify Exclusions Yes Yes No Delete Calendar Yes Yes Yes Calendar Example By default, when you first login to Openspace, one system calendar is defined and no working days or times have been specified. You can use the system calendar to define your working hours and exceptions. However, you can also define base and overlay calendars which you can use to express working times and calculate deadlines for locations in different time zones, organizational units with different working hours, and so on. For example, If your company is based in several time zones, then you may wish to configure your calendars as follows: 1. Amend the System calendar to specify the working days and times for your organization. See Displaying the Calendar. TIBCO® Openspace User's Guide 142 2. Specify the calendar alias to be used when defining your processes in TIBCO Business Studio. See TIBCO Business Studio Process Modeling Guide for more information. 3. Create a base calendar for each organizational entity whose hours differ from the standard working hours and times. See Creating Base Calendars. 4. Map the base calendars to the organizational entity, ensuring you specify an alias for the mapping. See Assigning Calendars to Organizational Entities. 5. Create an overlay calendar for any exclusions, if required. You may want more than one overlay calendar, depending on how many exclusions you have. See Creating Overlay Calendars. 6. Map the overlay calendars to the organizational entity, ensuring you specify an alias for the mapping. See Assigning Calendars to Organizational Entities. Displaying the Calendar When you first login to Openspace, the default system calendar is displayed. The Calendar gadget is organized as follows: ● The system calendar displays your current working hours. Note that: — The very first time you log in the system calendar is displayed. No working days or times are specified. See Specifying Working Days Times. — When the system calendar is initially displayed: — your current time zone is displayed. — the calendar displays the current month. — the current date is also selected. It is displayed in yellow. — When you specify working days or times, or exclusions, the calendar displays both. — The system calendar uses a 12-hour clock. — Calendars can be displayed by day, week, or month, depending on your requirements. You can view previous or future periods (day, week or month) by clicking on the left and right arrow icons in the upper-left part of the calendar gadget. — When you create base and overlay calendars, the latest base or overlay calendar you have created is displayed. To display an existing calendar, see Opening Calendars. ● The date picker allows you to view the working or non-working hours of selected dates. Depending on whether you are viewing the system calendar by day, week, or month, the date picker allows you to select a specific day, week, or month. ● The legends are: — Today Work Day. If today’s date is also a working day, it is displayed in green. — Work Day. Work days are displayed in blue. Specifying Working Days Times You can specify working times in the system calendar, for example, hours in the standard working week. Procedure 1. From the system calendar, click edit. 2. Click Working Hours. TIBCO® Openspace User's Guide 143 The page is composed of a grid that shows the days of the week. The days are split into hourly segments. Note that: ● You can specify up to five different working time spans for each day of the week. ● You can either select individual segments of 15 minutes, 30 minutes or an hour or more, from the drop-down list or you can enter a specific time in the Add Working Hours dialog. For example, entering work times for a Monday, means that those are the work times for every Monday. ● Click EXCLUSIONS to display exclusions and WORKING HOURS to display working hours. You can also add working hours by clicking in the area that corresponds to the day and time when you want the working hours to start from and drag the working hours segment to the hour where you want the working hours to end. Repeat this for each working day you want to define. 3. Click Add Working Hours. The Add Working Hours dialog displays. 4. Click Start time and select a start time from the drop-down list. 5. Click End time and select an end time from the drop-down list. 6. From Recurring, select the days you want the working hours to apply to. 7. Click Add to add the working hours. 8. Click Save Updates to save your changes to the system calendar. 9. Repeat the steps above to specify additional time spans for all desired working days. Working hours display in blue, as shown below: TIBCO® Openspace User's Guide 144 10. Click Back to go back to the Calendar gadget. Editing/Deleting Working Hours You can edit or delete your working hours at any time. However, TIBCO ActiveMatrix BPM uses the latest calendar mapping so you should make sure that if you do edit or delete your working hours while a process is deployed that it does not adversely affect the process. Procedure 1. To edit or delete your working hours in the system calendar, click Edit. The system calendar is displayed with the work hours and exclusions displayed, similiar to the one below: TIBCO® Openspace User's Guide 145 2. Click the time span you want to edit. The Edit Working Hours dialog displays. 3. Either, ● make the changes you require and click Edit, or ● click Delete to delete the time span. Creating System Calendar Exclusions You can create exclusions directly in your system calendars. Exclusions can be both one-off events that do not occur all the time, for example, an unexpected company meeting or exclusions that repeat over a defined period of time. Procedure 1. To add an exclusion to the system calendar, click Edit. TIBCO® Openspace User's Guide 146 2. Click EXCLUSIONS. The system calendar displays in month view. 3. Use either the date picker or the forward and back buttons to select the month you require. 4. Click on the date you require. The Add Exclusion dialog displays. In terms of calculating deadlines, it only makes sense to create exclusions on “working days”. In other words, those that are currently displayed in blue. 5. Enter a description for the exclusion in the What: field. 6. Either click the All Day box if the exclusion spans the entire day (for example, a holiday), or enter the time span for the exclusion (for example, a company lunch) in the Start time and End time fields. 7. Select Repeat if this exclusion is going to happen every day, week, month or year or leave this unselected if it is a one-off event. If you select Repeat, the Add Exclusion dialog displays as follows: a) From the Repeats: drop-down list, select whether the exclusion is repeated, daily, weekly, monthly or yearly. TIBCO® Openspace User's Guide 147 b) From the Repeats every: drop-down list, select how often the exclusions is repeated. For example, daily, weekly, monthly or yearly, depending on what you selected in step a. If you selected: ● Daily, you must specify how often the exclusion should repeat; for example, Repeats every 3 days means that the exclusion repeats once every 3 days. ● Weekly, you must specify the day of the week the exclusions occurs on. Monthly, you must specify either the day of the month or the day of the week when the exclusions occurs. c) Click in the Starts on: box to display a date picker that you can use to select the start date of the exclusion. d) When defining when the exclusion ends, you can do one of the following: ● ● Select Never if the exclusion never ends. ● Select After and enter a numeric value in the Occurrences box if the exclusion ends after it has occurred a certain number of times. ● Select On and click in the On box to display a date picker that you can use to define a specific end date for the exclusion. 8. Click Add. The exclusion is added to your system Calendar. 9. Click Save Updates to save your changes. 10. Repeat the steps above to specify additional time spans for all desired working days. 11. Click Back to go back to the Calendar gadget. Editing/Deleting Exclusions You can edit or delete your exclusions at any time. However, TIBCO ActiveMatrix BPM uses the latest calendar mapping so you should make sure that if you do edit or delete your exclusions while a process is deployed that it does not adversely affect the process. The system calendar is displayed with the work hours displayed. Procedure 1. From the system calendar, click Edit. 2. Click Exclusions. 3. Click the exclusion you want to edit or delete. The Edit Exclusion dialog displays. 4. Either, TIBCO® Openspace User's Guide 148 ● make the changes you require and click Edit, or ● click Delete to delete the exclusion. Viewing Your Working Hours When you have finished specifying your working days, your system calendar is updated to show the hours you have specified. By clicking Day, Week or Month you can choose whether to display the working hours daily, weekly or monthly, depending on your requirements. The example below shows the working hours and exclusions in month view. Note that: ● The default view is monthly. ● The total working hours for each day are shown in blue. ● Todays date is shown in green. To display a graphical view the available hours, select either Day or Week. TIBCO® Openspace User's Guide 149 Available hours are the working hours that are currently available. In the example above, working days start at 9.00 GMT and finish at 17.30 GMT, but each Monday there is a one hour team meeting, then the available hours for that day display from 10.00 - 17.30 GMT. Note that: ● Working hours are shown in blue. ● Exclusions are shown in red. ● Available hours are shown in green. Creating Base Calendars Procedure 1. From the Calendar gadget, click Manage. 2. Click New Base. The New Base dialog displays. 3. Complete the New Base dialog as follows: You must complete all the fields in the dialog to create a new base calendar. ● Name: The name of the new base calendar. ● Category: A category for the new base calendar. Calendars are grouped by category when opening and copying calendars. See Opening Calendars and Copying Calendars. ● Minimum hours: This should be set to the minimum hours that constitute a working day in your organization. This is because, when calculating a deadline, a start date-time and duration must be given. If the duration does not include hours, minutes or seconds, then the duration is assumed to be 'working days'. For example; the duration "P3D" is assumed to be 3 Working Days and not 72 hours. If the duration is "PT72H" then it is taken to be 72 hours, and not 3 Working Days. When calculating a deadline using units of 'Working Days', if the number of available hours in the day being considered is less than this defined minimum value, that day is not included. TIBCO® Openspace User's Guide 150 The calculation moves on to the next available day, where again the number of available hours is compared. If the duration specified months, then the start date is used to determine how many days are in the months. ● Timezone: the timezone for this calendar, for example, GMT. Once you have selected a time zone, the box below is automatically populated with the time zone IDs for that time zone. Some of the time zone Ids have an Automatically adjust clock for daylight saving time icon ( ). Depending on whether or not you want to automatically adjust your calendar for daylight saving, select a time zone ID that either does or does not have the Automatically adjust clock for daylight saving time icon ( ). 4. Click OK to create the new base calendar or Cancel to cancel your changes. 5. Once you have created your base calendar, you can specify the working days/times and/or any oneoff exclusions in the same way you did for the system calendar. See Specifying Working Days Times. 6. Once you have created your base calendar you must map it to an organizational entity before you can use it. See Assigning Calendars to Organizational Entities. Creating Overlay Calendars Procedure 1. From the Calendar gadget, click Manage. 2. Click New Overlay. The New Overlay dialog displays. 3. Complete the dialog as follows: You must complete all the fields in the dialog to create a new base calendar. ● Name: The name of the new overlay calendar. ● Category: A category for the new overlay calendar. Calendars are grouped by category when opening and copying calendars. See Opening Calendars and Copying Calendars. 4. Click OK to create the new overlay calendar or Cancel to cancel your changes. 5. Once you have created your overlay calendar, you can specify the exclusions in the same way you did for the system calendar. See Creating System Calendar Exclusions. 6. Once you have created your overlay calendar you must map it to an organizational entity before you can use it. See Assigning Calendars to Organizational Entities. Assigning Calendars to Organizational Entities If you want to define different calendars for organizational units, then you must create a base calendar and/or an overlay calendar to express those working hours and exclusions. See Creating Base Calendars and Creating Overlay Calendars. Once you have created your base and overlay calendars, you must map them to the organizational entities they apply to. TIBCO® Openspace User's Guide 151 Note that: ● Base and overlay calendars cannot be mapped to resources. ● Base and overlay calendars are mapped to organizational entities using their alias. This means you must specify an alias for base and overlay calendars when mapping them to an organizational entity. You can either: — Create the calendar alias using the Calendar Aliases option from the Manage menu in the Calendar gadget. See Calendar Aliases. — Create the alias when you map the calendar to an organizational entity. See Assigning Calendars to Organizational Entities. ● You can change an existing alias when you define the mapping. ● An organizational entity can either have one base calendar or overlay calendar mapped to it, at any time. It cannot have both. ● Calendars can be mapped to multiple organizational entities. ● You can remap calendars to different organizational entities at any time. TIBCO ActiveMatrix BPM uses the latest calendar mapping so you should make sure that if you do remap a calendar while a process is deployed that it does not adversely effect the process. Procedure 1. From the Calendar gadget, make sure you have opened the calendar that you want to map to an organizational entity. See Opening Calendars. 2. Click Manage. 3. Click Map to Org Model. The Map to Organization Model dialog displays. 4. Select the version number of the organization model where the organizational entity resides. 5. To locate the organizational entity you require, use the graphical display of the organization model in the left hand pane to drill down to the organizational entity you want to select. Clicking an organizational entity or an LDAP container in the left pane causes the resource list to be displayed in the right pane. If you assign permission to an organizational entity like a group or location, all the child organizational entities in the parent entity inherit that permission, unless an individual user does not have the correct system actions assigned, as described in Required System Actions. 6. Click Show entity names if you want Openspace to display the internal name of the organizational entity, rather than its label. By default, Openspace displays the organizational entity’s label. 7. If no aliases have been defined for this calendar then, in the Alias box, type in the name of the alias and click to add the alias. You can modify an alias by selecting it. The alias is populated in the Alias box. Amend the alias and click 8. Click to modify it. once you have completed the dialog or at any time to return to the main window. TIBCO® Openspace User's Guide 152 Opening Calendars When you define a new base and/or overlay calendar, the latest calendar you defined is displayed in the Calendar gadget. Procedure 1. From the Calendar gadget, click Manage. 2. Click Open. The Select a Calendar dialog displays. 3. Select the calendar you want to open and either double-click it or click Open. The calendar is displayed in the Calendar gadget. Copying Calendars If you are creating multiple calendars that share particular properties, you can copy your calendar. When copying a calendar, only exclusions from current date and beyond are copied. Exclusions that have expired are not copied. Procedure 1. From the Calendar gadget, click Manage. 2. Click Copy. The Select a Calendar dialog displays. 3. Select the calendar you want to copy from your list of calendars. TIBCO® Openspace User's Guide 153 4. In the Name: box, enter a name for your new calendar. 5. In the Category: box, enter a category name for your new calendar. The new calendar is created. 6. Specify working days/times and/or exclusions in the same way as you do for the system calendar. See Specifying Working Days Times. Editing Base Calendars Depending on your requirements, you can edit an existing base calendar’s minimum hours, timezones and timezone IDs. Note that you cannot edit existing overlay calendars. Procedure 1. From Calendar, click Manage. 2. Click Configure. 3. From the dialog, select the calendar you want to configure. For information on minimum hours, timezones and timezone IDs, see Creating Base Calendars. Calendar Aliases You must define aliases for your calendars. TIBCO Active Matrix BPM uses aliases when identifying which calendar should be used for an organizational entity. If no aliases are defined then TIBCO Active Matrix BPM uses the system calendar. This means that if you want an organizational entity to use a specific base or overlay calendar then you must map them to the organizational entity and specify the calendar alias as part of the mapping. You can also create a new calendar alias or modify an existing alias when you map a calendar to an organizational entity. The alias does not have to exist before you define the mapping. See Assigning Calendars to Organizational Entities. Note that: ● You can define as many aliases as you like. ● The calendar’s name can be used as an alias. ● The system calendar can have an alias. ● A calendar can have more than one alias. ● You cannot map a calendar alias to more than one calendar. For example assume you have an alias called UK mapped to a calendar called Call Centre UK and you remap the UK alias to a calendar called Returns UK, TIBCO ActiveMatrix BPM removes the mapping between the UK alias and Call Centre UK and instead maps the UK alias to the calendar called Returns UK. ● You can add, modify or delete an alias. Adding a Calendar Alias Procedure 1. From the Calendar gadget, click Manage. 2. Click Calendar Aliases. 3. Select the calendar that you want to create an alias for. If there are any aliases already defined for this calendar, they are shown in the right hand pane. TIBCO® Openspace User's Guide 154 In the Alias box in the bottom right hand corner of the pane, type an alias for the calendar and click . The alias is added. 4. Repeat these steps to create as many aliases as you require. Click to close the Calender Aliases dialog. Mapping a Calendar Alias to a new Calendar Procedure 1. From the Calendar gadget, click Manage. 2. Click Calendar Aliases. The Calendar Aliases dialog displays. 3. Select the calendar whose alias you want to remap. The aliases currently defined for this calendar are shown in right hand pane. 4. If you want to add a new alias, see Adding a Calendar Alias. 5. Select the alias you want to map. 6. A list of available calendars that the calendar alias can be mapped to is displayed under Change Mapping. Select the calendar you want the calendar alias to be mapped to and click Submit. The calendar alias is remapped. Click to close the Calender Aliases dialog. Deleting a Calendar Alias Procedure 1. From the Calendar gadget, click Manage. 2. Click Calendar Aliases. The Calendar Aliases dialog displays. 3. Select the calendar whose alias you want to delete. The aliases currently defined for this calendar are shown in right hand pane. 4. Select the alias you want to delete and click 5. Click . The alias is deleted. to close the Calender Aliases dialog. Deleting Calendars You can delete a specific calendar. Once you have deleted a calendar, it is permanently removed from TIBCO ActiveMatrix BPM. ● You cannot delete the system calendar. ● You cannot delete a calendar if it has aliases specified. You must remap or remove the aliases before you can delete the calendar. Procedure 1. From the Calendar gadget, click Manage. 2. Click Delete.... The Select a Calendar to Delete dialog displays. TIBCO® Openspace User's Guide 155 3. Select the calendar you want to delete and click Delete. The Deleting permanent. Are you sure? message displays. a Calendar is 4. Click OK to delete the calendar or Cancel to cancel the operation. 5. Repeat these steps for all the calendars you want to delete. TIBCO® Openspace User's Guide 156 Openspace and TIBCO Spotfire You can view TIBCO Spotfire BPM visualizations in Openspace. The Spotfire gadget allows you to view TIBCO Spotfire BPM Visualizations in Openspace. Using the Spotfire gadget, you can: ● open the Spotfire BPM visualizations. ● adapt the Spotfire BPM Visualizations to show the information you require, see the TIBCO Spotfire BPM Visualizations Guide for information. ● view the Spotfire BPM visualizations that have been provided, see the TIBCO Spotfire BPM Visualizations Guide for information. The Spotfire Gadget To view Spotfire BPM visualizations in Openspace, you must first add the Spotfire gadget to your desktop. To use the Spotfire gadget, you must be able to: ● Connect to the TIBCO Spotfire Server. See the TIBCO Spotfire BPM Visualizations Guide for information on configuring Spotfire to connect to your BPM database. ● Connect to the TIBCO Spotfire Web Player. Please see the TIBCO Spotfire Web Player Installation guide for information on how to install and configure Spotfire Web Player. ● Access the template visualizations provided in the Spotfire BPM analysis file (tibcoamxbpmembedded.dxp). The file contains template visualizations that have been created based on data from your BPM implementation. Accessing the TIBCO Spotfire BPM Visualizations You can access the Spotfire BPM Visualizations from the Spotfire gadget. You need the URL for the Spotfire BPM Visualizations and a username and password. Prerequisites Contact your system administrator to determine the URL for TIBCO Spotfire BPM Visualizations. Procedure 1. From the Spotfire gadget, click . A default URL for a TIBCO Spotfire Web Player is displayed: TIBCO® Openspace User's Guide 157 2. Click the URL to select it and type in the URL for your TIBCO Spotfire Web Player. 3. Click to refresh. The Login page for TIBCO Spotfire Web Player is displayed: 4. In the User Name: field, type your username. 5. Press the Tab key. 6. In the Password: field, type your password. Select Save my login information if you do not want to type in your user name every time you log in to the TIBCO Spotfire Web Player. 7. Click Login. The TIBCO Spotfire Web Player is displayed. 8. Select the TIBCO Spotfire BPM Visualizations Library. Contact your system administrator to determine the location of your TIBCO BPM Spotfire Visualizations Library. 9. To view a visualization, click the tab that corresponds to the visualization you want to view. Refer to the TIBCO Spotfire BPM Visualizations Guide for an explanation of how to use the BPM Visualizations. Setting Preferences You can specify your preferences for the Spotfire gadget. Procedure 1. Click . The following table describes the preferences you can set: Preference Description home url: Type the URL of your Spotfire BPM Visualizations so that it is automatically loaded when Openspace is started. Height: Type in the minimum height required for the gadget. By default this is 483. Refresh upon resize Select this only if the contents of the gadget should be refreshed whenever the gadget resizes (due to a layout change or a browser window size change, for example). 2. Once you have selected your preferences, click 3. Click to save your changes. for the changes to take effect. TIBCO® Openspace User's Guide 158 Reporting Gadget Overview You can use the Reporting gadget to view measures like the total number of process instances and work items by their current status. You can also view the average duration of a process instance or work item. You can view the measures of the process instances for a selected process template or group of process templates, depending on your requirements. The measures can be further categorized by hours, days, weeks, months or years over a period of time of that you can specify. The Reporting gadget displays the total number of process instances by their current status for the first process template in your process template list as shown below: The Reporting gadget is divided into 3 tabs: ● Process Instances - allows you to view the total number of process instances by their current status, see Displaying the Current Status of Process Instances for Selected Process Template. ● Work Items - allows you to view the total number of work items for a process instance by work item status, see Displaying the Current Status of Work Items for selected Process Template(s). ● Averages - allows you to view the average duration of a process instance or work item, see Displaying the Average Duration of Work Items and Process Instances for Selected Process Template(s). Selecting Process Templates Once you have decided the type of measures you want to view, you need to select the process template whose measures you want to view. Procedure 1. Drag the divider to reveal the list of process templates that are currently available. You can choose to permanently display the Process Template panel, by setting the Open Templates option in the Preferences for the gadget, see Setting Preferences . 2. Select the process templates whose measures you want to view. TIBCO® Openspace User's Guide 159 Viewing Process Templates You can use the Reporting gadget to view performance information about your process templates. You can: ● Display all your process templates. ● Display a list of your most recently viewed process templates. ● Store process templates as favorites. Procedure 1. To display all the process templates, click . . This 2. To display a list of your most recently viewed process templates, click displays the last 3 process templates you viewed. (You can specify how many recent processes should be displayed by amending the Recent Processes option in the preferences for the gadget, see Setting Preferences). . 3. To display your favorite process templates, click Adding Process Templates as Favorites You can add a process template as a favorite. This is useful if there are process templates that you use frequently. You can remove a process template as a favorite at any time. Procedure 1. To add a process template as a favorite, select the process template and click template is listed under Favorite Processes. 2. To remove a process template from Favorite Processes, click 3. Hover your cursor over the process template and click . The process . . The process template is removed. Specifying a Date Range By default, the measures are displayed hourly for the current day. However, you can specify the dates for the measures that you want to view. Procedure 1. Click Start Date. A date picker is displayed. 2. You can specify the time that you want to start from or accept the default, which is the first minute of the day. Click AM or PM, if you want to enter the time in a 12 hour format. Click 24 if you want to use a 24 hour clock format. TIBCO® Openspace User's Guide 160 ● For the 12 hour clock format AM 12.0.0 is the first second of the day and PM 12.0.0 is the second after 12.00 (midday). ● For the 24 hour clock format, hour 00 is equivalent to 12 AM and hour 23 to 11.00 PM. 3. Select the start month and start date of the time period that you want to view. 4. Click Target Date. A date picker is displayed. 5. Using the date picker, select the end month and target date of the time period that you want to view. 6. You can specify the time that you want the date period to end or accept the default, which is the last minute of the day. Specifying the Time Period By default, the measures are displayed hourly for the current day. However, you can select the period of time for the measures you want to view by selecting one from the drop-down list (hours is selected by default). If you select a measurement of time that spans too long a period of time, Openspace asks you to reduce the period of time you specified. Otherwise, there is too much information to display in the column chart. ● hours ● days ● weeks ● months ● years Displaying the Current Status of Process Instances for Selected Process Template Procedure 1. Click Process Instances. The gadget displays a column chart of the current status of the process instances for the first process template in your list for the current day. 2. Select the process template(s) whose process instance status you want to view, see Searching for Process Templates.The column chart displays the current status of the process instance(s) for the selected process template(s). For an explanation of process instance states, see Process Instance State. TIBCO® Openspace User's Guide 161 3. Select the date range of the period whose status you want to review, see Specifying a Date Range. 4. Select the time period of the status you want to view, see Specifying the Time Period. 5. If you want to show the current status of the work items associated with the selected process instance(s), click the Work Item tab. The work item status for all the process instances started from the selected process template(s) is displayed as a pie chart in the Work Item tab. 6. By clicking on a particular section, more details are displayed, for example, the total time the work items in that section have been active. Displaying the Current Status of Work Items for selected Process Templates Procedure 1. Click Work Items. The gadget displays a column chart of the current status of the work items for the first process template in your list for the current day. TIBCO® Openspace User's Guide 162 2. Select the process templates whose work item status you want to view, see Selecting Process Templates. The column chart displays the current status of the work items for the selected process templates. For an explanation of work item states, see Work Item State. 3. To display the work item status as a column chart, click . To redisplay them as a pie chart, click . 4. Select the date range of the period whose status you want to review, see Specifying a Date Range. 5. Select the time period of the status you want to view, see Specifying the Time Period. 6. By clicking on a particular section, more details are displayed, for example, the total number of work items in that section. Displaying the Average Duration of Work Items and Process Instances for Selected Process Templates Procedure 1. Click Averages. The gadget displays a column chart of the current averages of the process instances for the first process template in your list for the current day. TIBCO® Openspace User's Guide 163 2. Select the process templates whose average duration you want to view, see Selecting Process Templates. 3. From the top right-hand corner of the gadget, select one of the following from the drop-down list: ● Process Duration - allows you to see average duration of the process instances started from the selected process templates. The column chart displays the current average duration for the selected process templates. There are two measurements shown: ● Average Time Taken - displays the average time taken for each process instance of a process template. ● Process Total - displays the total time taken for each process instance of a process template. ● Work Item Duration - allows you to see average duration of the work items started from the selected process templates. The column cart displays the current average duration of the work items by status. See Work Item State. 4. Click Show Calender to specify the date range of the period whose average duration you want to view. See Specifying a Date Range. 5. Select the time period that you want the average duration to span for the selected process templates (x-axis), by clicking one of the following (hours is selected by default): ● hours ● days ● weeks ● months If you select a measurement of time that spans too long a period of time, Openspace asks you to reduce the period of time you specified. Otherwise, there is too much information to display in the bar chart. 6. Select the time period that you want the average duration to be measured in (y-axis) by clicking one of the following (seconds is selected by default): ● seconds ● minutes TIBCO® Openspace User's Guide 164 ● hours ● days Seconds is selected by default which means that you see all the data but the values are high. If you know your process instances usually take longer to complete, 30 minutes for example, you might want to select a larger time period, like minutes. 7. By clicking on a particular section, more details are displayed, for example, the total time duration of work items in that section. Setting Preferences You can specify your preferences for the Reporting gadget. Procedure 1. Click . The following table describes the preferences you can set: Preference Description Default Tab Click on the name of the tab that you want displayed automatically when the Process Instance gadget is added. 3D Preferred (This option is currently not supported). Select this if you want to use 3D. Open Templates: This option is not selected by default but you can select this if you want the Process Template panel to be displayed automatically. Stack Averages: This option is not selected by default but you can select this if you want the averages in the column chart for work item duration displayed as stacked automatically. Logarithmic Scale This option is selected by default. This allows you to account for differences in scales, for example, between minutes and hours. It allows small values and large values to be shown on the same chart. Deselect this option if you require a linear scale. Show Version: This option is not selected by default but you can select this if you want the version numbers of the process templates displayed in the Process Template panel automatically. Min Width Templates: Type in the minimum width required for Process Template panel. By default this is 203. Height: Type in the minimum height required for the gadget. By default this is 483. Recent Processes: Type in the number of processes you require to be listed in the Recent Processes tab. By default, the last 3 processes you have accessed are listed. TIBCO® Openspace User's Guide 165 2. Once you have selected your preferences, click 3. Click to save your changes. for the changes to take effect. TIBCO® Openspace User's Guide 166 Logger Gadget Overview The Logger gadget is a diagnostic tool that allows you to investigate any problems you may have with Openspace. It records the messages that are returned from your browser. The messages are unique to your current browser session. You can save the messages by saving them to a file. Using the Logger gadget, you can: ● display the messages for the current session, ● diagnose problems by configuring the Logger gadget to record different levels of messages. Displaying Messages in the Logger Gadget To view the messages that have been returned from your browser, you must first add the Logger gadget to a tab. When the Logger gadget is added to a tab, it is displayed as shown below: The messages that are displayed in the Logger gadget have the following format: Timestamp messagetext where: ● timestamp is in the form DD/MM/YY HH:MM:SS and is the date and time the message was created. ● messagetext is the text of the message. There are 6 different levels of messages that you can record, as described in the following table: TIBCO® Openspace User's Guide 167 Action Description TRACE TRACE is the lowest level of message that you can record. This is the most verbose level and should only be turned on when diagnosing problems. Types of messages recorded at this level can be tibcopanel. getOffsetHeight ()=696), for example recording how Openspace is setting the height of the gadget. Messages recorded at this level mean the system is running normally and no remedial action is required. DEBUG DEBUG records low-level diagnostic information. Types of messages recorded at this level are BusinessServicesGadget: refresh(). In other words, a user has refreshed the Business Services gadget. Messages recorded at this level mean the system is running normally and no remedial action is required. INFO INFO displays audit level information messages. Messages recorded at this level mean the system is running normally and no remedial action is required. For example, Invoking BusinessServiceGadgetService service located at [http://localhost:8080/bpm/BusinessServiceGadgetService]. In other words, Openspace has started a business service and the location where it was started from. WARN Messages recorded at this level mean minor potential problems or reduction in system performance. Investigation and rectification of the error is recommended at the first suitable opportunity. ERROR Messages recorded at this level mean there could be potential data integrity problems, reduction in system performance, or a system component is experiencing a serious problem. Urgent investigation and rectification of the error is required. FATAL Messages recorded at this level means that the system is down and the problem must be resolved before going on. If you do receive messages at the ERROR or FATAL level, then you should contact TIBCO Support. Setting the Message Level To set the level of action that you want to record, click the corresponding level in the Logger gadget. The levels of message logging are cumulative. For example, if you select TRACE, all levels of message logging are selected and if you select INFO then WARN, ERROR and FATAL are selected also. If you only want to record errors, click ERROR and FATAL. If you have a particular problem to diagnose, you might want to select all the message levels so as to capture as much information as possible from your browser. Procedure ● Select the message level you require by clicking on the corresponding level in Openspace. For example, to select INFO, click . Once the levels are selected, the buttons turn green. The following screenshot shows that all levels of message logging have been selected: TIBCO® Openspace User's Guide 168 Turning Off Logging You can turn off logging in the Logger gadget at any time. Procedure ● From the Logger gadget, click . Clearing the Logs You can clear the logs in the Logger gadget at any time. Procedure ● From the Logger gadget, click . TIBCO® Openspace User's Guide 169 Copying the Logs You can copy the messages from the Logger gadget to a text editor. This is useful because you may want to copy all or a selection of the logs so that you can send them to TIBCO Support for diagnostic purposes, for example. Procedure 1. Select the logs you want to copy by either: ● clicking and dragging the mouse over the specific logs you want to copy, or ● by selecting All Selected if you want to copy all the logs in the Logger gadget. 2. Once you have selected the logs you want to copy, click The Copy/Paste window is displayed. . 3. Use the copy and paste functions provided by the browser you are using to copy and paste the logs to the location you require. The copy and paste functions differ depending on the browser you are using. Refer to the documentation provided by your browser for more information. 4. Click gadget. to close the Copy/Paste window and return to the Logger Saving the Logs to the Openspace Log File By default, the messages captured in the Logger gadget are saved to the BPM runtime appender. However, you can save the messages to a persistent log file that is generated by Openspace. By default, the log files are generated by Openspace automatically: ● every time you restart your system ● every day at midnight Your system administrator determines how the Openspace log file is generated so you should consult your system administrator to confirm exactly how the Openspace log file is generated. This is achieved by configuring the logging properties in the OSProperties.properties file. See TIBCO ActiveMatrix BPM Administration Guide for more information. Procedure ● From the Logger gadget, click . When you click , the messages are appended to the end of the log file. TIBCO Administrator provides you with different types and levels of logging information depending on your requirements. See TIBCO ActiveMatrix BPM Administration Guide for more information. Setting Preferences You can specify your preferences for the Logger gadget. The following table describes the preferences you can set: TIBCO® Openspace User's Guide 170 Preference Description Default Log Level Click on the Log Level that you want displayed automatically when the Logger gadget is added. See Setting the Message Level for more information. Auto Scroll Select this option if you want the Logger gadget to scroll down to the last entry automatically. This option is selected by default. Procedure 1. From the Logger gadget, Click The Prefer . 2. From the dialog, select your preferences. 3. Click to save your changes. 4. Click for the changes to take effect. TIBCO® Openspace User's Guide 171 Working with the Webview Gadget The Webview gadget enables you to render a third-party website by typing in a specific URL. Secondly, using TIBCO PageBus, the Webview gadget can subscribe to messages sent from the Work Views and Business Services gadgets within Openspace. The messages can specify a new URL or a token that can be appended to the existing URL. The Webview gadget responds by modifying the URL, and rendering the new website. The advantage of this is that if there have been any changes to the status of your work items or business services, for example, the Webview gadget can be updated to display the newly updated information dynamically. You cannot customize the Webview gadget. For example, you cannot change the gadget name, category or height and/or associate a custom thumbnail for a web page. If you want to do this, you must create an Openspace Compatible gadget either by the URL is not a Gadget Spec - it is a web site option from the Contribute Gadget dialog or using the GWT toolkit. There are a number of functions on the Webview gadget that are common to all Openspace gadgets. See Common Openspace Gadget Functions for information about these functions. Rendering a Specific URL The Webview gadget enables you to render a third-party website using a specific URL. Procedure 1. Add the Webview gadget to a tab, see Adding Gadgets to a Tab. 2. Click . The Webview URL box displays. 3. Type in the URL of the website you want to display. 4. Click . The Webview gadget now displays the website whose URL you specified. Dynamically Rendering a URL Using TIBCO PageBus, the Webview gadget can subscribe to messages sent from the Work Views and Business Services gadgets within Openspace. The messages are published using the forms defined in your BPM application using TIBCO Business Studio. This is achieved by adding JavaScript that uses the TIBCO PageBus Publish and Subscribe functions and adding it as a presentation resource. It also should be available to the forms that you define in TIBCO Business Studio. For more information about TIBCO PageBus, see TIBCO PageBus Developer’s Guide. As the Work Views and Business Services gadgets are the only gadgets that can display forms, these are the only gadgets within Openspace that the Webview gadget can subscribe to. When an action is performed on a form, a submit for example, a message can be sent to the Webview gadget that specifies a new URL or a token that can be appended to the existing URL. The Webview gadget responds by modifying the URL, and rendering the new website. TIBCO® Openspace User's Guide 172 ● The WebView gadget always appends the URL to the base URL specified in the gadget. For a full URL to be rendered, you must set the base URL to be blank in the Webview URL box. See Rendering a Specific URL . ● If you have specified a token to be appended to an existing URL and you use the Refresh button on the gadget, then the Webview gadget always refreshes the original base URL rather than the appended URL. This means that the Webview gadget will then display the original URL, not the appended URL. If you want to refresh the gadget, you must use the refresh option in your browser. The method for doing this depends on the browser you are using. Refer to your browser for information on how to do this. The advantage of this is that, if there have been any changes to your work items or business services, for example, the Webview gadget can be updated to display the newly updated information dynamically. Procedure 1. In TIBCO Business Studio, expand your project in the Project Explorer. You now need to add the JavaScript that uses the TIBCO PageBus Publish and Subscribe functions as a presentation resource. 2. If no Presentation Resources folder exists in the project, you must create one. a) Right-click the project and select New > Folder. The Folder dialog displays. b) In the Folder name: box, type Presentation Resources. c) Click Finish to close the dialog. 3. Create a folder in your Presentation Folders to contain your JavaScript. a) Right-click Presentation Folders and select New > Folder. The Folder dialog displays. b) In the Folder name: box, type a name for your folder. c) Click Finish to close the dialog. 4. Create the JavaScript. a) Right-click your folder and select New > Other. The New wizard dialog displays. b) From the Wizards box, expand JavaScript. c) Select JavaScript Source File. d) Click Next. The JavaScript dialog displays. e) In the File name: box, type a name for your JavaScript. f) Click Finish to close the dialog. g) Open the JavaScript source file you just created and add the following: function subscribeListenerControl(subject, control) { var callback = function(subject, message, control) { var value = control.getValue(); if (message != null && message.length > 0) { value += "message: " + message + "\r\n"; } control.setValue(value); }; PageBus.subscribe(subject, null, callback, control); } function publishMessage(subject, message) { PageBus.publish(subject, message); } You should now have something similar to that shown below. TIBCO® Openspace User's Guide 173 5. All the forms you define in your project must reference the JavaScript you created above, as shown below: 6. Create an action on your form, for example, a button that is activated when Enter is pressed (a Submit button, for example) which runs JavaScript similar to that shown below: publishMessage("com.tibco.openspace.webview.subjectchange", control.Field.getValue()); where: ● control.Field is the name of the field that is passing the URL to the Webview gadget. ● getValue is the URL specified. This can be either, — a complete URL, for example, — a PageBus topic that will be appended to an existing URL, for example /industries/ default.jsp. http://www.tibco.com or For example, publishMessage("com.tibco.openspace.webview.subjectchange",control.Field.getValue(/ industries/default.jsp)); TIBCO® Openspace User's Guide 174 Data Admin You can configure TIBCO ActiveMatrix BPM so that you must manually execute the CREATE/ UPDATE/DROP database scripts created from the successful deployment of an application that uses case data. This is useful if you want to check the scripts and/or make any changes to them before executing them in your database. If you have configured ActiveMatrix BPM this way, Data Admin enables you to retrieve these scripts. This applies when deploying from both TIBCO Business Studio or TIBCO Administrator. You can make a small number of supported edits to these scripts, depending on your requirements. Once you have verified them, you must execute them in your database and generate the database schema for your application. Once the database schema is generated, you must notify TIBCO ActiveMatrix BPM from Data Admin. Your process instances will fail if the database schema has not been generated correctly. In other words, if you have not first run the appropriate Create or Update script. If you want to configure TIBCO ActiveMatrix BPM to allow you to verify the database scripts before executing them on your database, you must set the autogenerateDB property to false in the BDS.properties file. See "BPM Properties Files" in the TIBCO ActiveMatrix BPM Administration guide for more information. The value of the autogenerateDB property must be set directly after installing TIBCO ActiveMatrix BPM or (at the latest) immediately before you deploy your first application that contains case data. It must not be changed after that, unless instructed to do so by TIBCO Support. Case data is defined in business object models in TIBCO Business Studio. See TIBCO Business Studio Modelling Guide for more information. Case data is any business related concept that many TIBCO ActiveMatrix BPM based applications can operate on or be associated with. For example, in an insurance company, case data may be an insurance claim or the actual policy. See TIBCO ActiveMatrix BPM Concepts Guide for more information. Case Models Applications with case data use case model database schema generation. This means that when an application is deployed, a complete set of database tables is generated for that application. The case models are listed in Data Admin. You can browse to the case model you want and then select the type of script you want to retrieve. By default, TIBCO ActiveMatrix BPM automatically generates the database schema. If you hover your cursor over each case model, the details of the case model display. Name Description ID The unique identifier of the case model. The ID is automatically assigned when you deploy the case model number. See TIBCO Business Studio Modeling Guide for more information. Name The case model name in the format com.example.applicationnameversionnumber where State ● applicationname is the name of the application you deployed. ● versionnumber is the major version number of the case model that you specified when you created the business object model in TIBCO Business Studio. See TIBCO Business Studio Modelling Guide for more information. The current state of the case model. TIBCO® Openspace User's Guide 175 Name Description Current Version The version number of the case model, in the format major.minor.micro.qualifier. Deployment Date The date and time the case model was deployed, in the format dd:mm:yy:hh:mm:ss Frozen Whether the case model is frozen or unfrozen. If a case model is frozen, there can be no further changes made to that case model. The Frozen property has two values: = the case model is frozen ● true ● false = the case model is not frozen Case models have a deployment lifecycle. In other words, you can deploy new versions and obtain UPDATE database scripts. Similarly, undeployment of the last remaining version of a deployed application requires the running of the DROP scripts to remove the case data from the BPM database. See TIBCO ActiveMatrix BPM Deployment Guide for more information about application deployment lifecycles. Case models have states. The case model state depends on where the case model is in the deployment lifecycle. The following table describes the states a case model can have. State Description INITIAL This describes the initial state of the application. The application is still in the process of deploying. INSTALLED The database tables are created and TIBCO ActiveMatrix BPM has been notified. PENDING_DBA_ACTION_TO_INSTALL The database tables need to be manually created or updated by running either the CREATE or UPDATE scripts. PENDING_DBA_ACTION_TO_UNINSTALL The database tables need to be manually removed by running the DROP scripts. FAILED_TO_UNINSTALL The scripts have not executed correctly on the database. If TIBCO ActiveMatrix BPM is configured for manual database schema creation, you must check the status of the case model in Data Admin for the true status of the application. This is because the application may have a status of "Deployed with Start Successful" in TIBCO Administrator, but if the case model does not have a status of INSTALLED in Data Admin then the database schema has not been created, and no process instances can be started from the application. The following diagram explains the deployment cycle of a case model. TIBCO® Openspace User's Guide 176 ● INITIAL This describes the initial state of the application. The application is still in the process of deploying. If the application is undeployed before the database schema is generated, the case model is deleted and removed from Data Admin. ● PENDING_DBA_TO_INSTALL The CREATE/UPDATE scripts are ready for retrieval. You must retrieve the scripts and manually execute them on your database to generate the case model database schema. If there has been multiple versions of an application deployed and then the application is undeployed before the UPDATE scripts for the new version of the application have been executed, then the case model’s state changes to PENDING_DBA_TO UNINSTALL so the DROP scripts can be retrieved. ● INSTALLED The CREATE/UPDATE scripts have been executed and TIBCO ActiveMatrix BPM has been notified. ● PENDING_DBA_TO_UNINSTALL The DROP script is ready for retrieval. You must retrieve the scripts and manually execute them on your database to generate the case model database schema. ● FAILED_TO_UNINSTALL The scripts have not executed correctly on the database. You must clean-up your database and then notify TIBCO ActiveMatrix BPM when the clean-up is complete. ● DELETED The DROP script has been executed and the case model database tables deleted. The case model is removed from Data Admin. If the application is undeployed before the database schema is generated, the case model is deleted and removed from Data Admin. Data Admin Views Data Admin has two views: ● Live View - use this view to display the scripts for the latest version of the application currently deployed. You can: — Retrieve the CREATE/UPDATE/DROP database scripts for currently deployed applications. — Edit the CREATE/UPDATE/DROP scripts. — For information on how you can edit database scripts, see Best Practice When Editing Case Model Database Scripts. — When you edit a script, it is saved as a new revision. See Comparing Global Data Database Scripts to compare revisions of scripts. TIBCO® Openspace User's Guide 177 — Freeze/unfreeze current versions of deployed case models. See Freezing Case Data Models. — You can view the current status of the case model. Icon Description The case model is installed. The case model is frozen. ● Audit View - use this view to display all the scripts for all the versions of a particular case model. You can — View all the versions of the CREATE/UPDATE/DROP scripts for all currently deployed case models. Once the last version of an application has been undeployed and the DROP scripts executed on the database, then the case model's database schema is deleted and it is no longer displayed in Data Admin. — View and compare revisions of the CREATE/UPDATE/DROP scripts for all currently deployed case models. See Comparing Global Data Database Scripts to compare revisions of scripts. Guidelines When Editing Case Model Database Scripts Data Admin enables you to obtain the CREATE/UPDATE/DROP database scripts created from the successful deployment of an application that uses case data. Although editing the scripts is possible, TIBCO does not recommend this unless it is essential and there are only a few changes that you are allowed to make. ● No validation is performed on the scripts when you edit them in Data Admin. This means it is possible to make invalid changes to your scripts. ● If the CREATE script is changed (for example, index or foreign key names), then you must edit the UPDATE/DROP scripts, to reflect the changes. ● If you have edited an UPDATE script and the business object model is updated, then the new UPDATE script that is generated restores the original values and settings. This means you must manually edit the newly generated UPDATE script with your changes. If a change is not listed in the table below, you cannot make that change to the script. Item Description Comments The addition of comments using either single line comments ("--") or multiple line comments ("/* ... */") is supported. Note that: Splitting the script over several lines ● Oracle REMARK and REM comments are not supported. ● if a business object model is updated and deployed, then all of the comments in the previous database scripts are lost. You can split the database over several lines (for example, by adding carriage returns). Note that: ● the meaning of the script cannot be changed. ● each statement must be delimited by a semi-colon. TIBCO® Openspace User's Guide 178 Item Description Changing a Foreign Key Name You can change the name of a foreign key. However, the new name assigned to the foreign key must not start with the BDS table prefix value (BDS_ by default) or the BDS index prefix value (IDX_ by default). Changing an Index Name You can change the name of an Index. However, the new name assigned to the index must not start with the BDS table prefix value (BDS_ by default) or the BDS index prefix value (IDX_ by default). Increasing the Size of a String Column You can increase the size of a string column in the database (but not to a CLOB). However, if you specified a data size in the business object model, any process instances that reference the business object model will use the size limit specified in the business object model until a new version of the business object model is deployed. Increasing the Size of a Number Column You can increase the size of a number column in the database. However, if you specified a data size in the business object model, any process instances that reference the business object model will use the size limit specified in the business object model until a new version of the business object model is deployed. Adding Additional Indexes You can add an additional index (either, unique or composite). Note that: Adding Check Constraints ● the index must not break the integrity of the database representation of the business object model. ● the index must not start with the BDS table prefix value (BDS_ by default) or the BDS index prefix value (IDX_ by default). ● If you are adding an index to the CREATE script then you must manually remove the index from the DROP script so that the table can be dropped successfully. You can add CHECK constraints to a table for force compliance to a given requirement. For example: ALTER TABLE table_name ADD CONSTRAINT constraint_name CHECK (predicate) Note that: ● The name of this constraint must not start with the BDS table prefix value (BDS_ by default) or the BDS index prefix value (IDX_ by default). ● If you are adding a constraint to the CREATE script then you must manually remove the constraint from the DROP script so that the table can be dropped successfully. ● The constraint must still abide by the restrictions defined in the business object model. This is to ensure that any data that is valid against the business object model, can still be inserted into the altered table. TIBCO® Openspace User's Guide 179 Item Description Refining Indexes You can refine an index that has been created in the default database scripts. You can do this by editing the CREATE/UPDATE script before it is run, or by running an ALTER INDEX command on the database directly. This allows you to edit an index to include such things as storage, unique, clustered, non-clustered and so on. Any changes you make to the index must match the design of the business object model used to generate the original scripts. Changing Default Tablespace You can change the default tablespace when installing TIBCO ActiveMatrix BPM by supplying the new tablespace name as part of the BDS Global Data installation. Retrieving CREATE Case Data Database Scripts Once your application that contains case data is deployed, you can go to Data Admin and retrieve the CREATE database scripts. Once you have verified them and perhaps edited them, depending on your requirements, you must execute them on your database to generate the case model database schema. Once you have executed them, you must notify TIBCO ActiveMatrix BPM from Data Admin. You will not be able to start process instances from an application unless you have executed the scripts and generated the case model database schema. Prerequisites Make sure your application is deployed. In other words, in TIBCO Administrator, the status of your application is Deploy with Start Successful. Procedure 1. From TIBCO Openspace, click Data Admin. 2. Click Live View. A list of the currently deployed case data models displays. 3. Click the case data model whose CREATE scripts you want to retrieve. The latest version number that is currently deployed for that case model displays. The status of the case model must be PENDING_DBA_ACTION_TO_INSTALL. 4. Click Create Script. The CREATE database script displays. 5. If you want to make any changes to the script, click Edit. ● For information on how you can edit database scripts, see Best Practice When Editing Case Model Database Scripts. ● When you edit a script, it is saved as a new revision. See Comparing Global Data Database Scripts to compare revisions of scripts. 6. Make any changes you require and click Save. The Save dialog displays. 7. You must enter a comment in the Comments box. 8. Click Save to save your changes or Cancel to close the dialog without saving your changes. 9. You can now execute the script on your database. If you have any problems executing the scripts, check your scripts to make sure that you have not made any invalid changes. See Best Practice When Editing Case Model Database Scripts. TIBCO® Openspace User's Guide 180 10. Once the script has executed successfully, click Notify to notify TIBCO ActiveMatrix BPM that the scripts have been executed. The status of the case model has changed to INSTALLED. Retrieving UPDATE Case Data Database Scripts If a new version of an application that contains case data is deployed, you can go to Data Admin and retrieve the UPDATE database scripts. Once you have verified and perhaps edited them, depending on your requirements, you must execute them on your database to generate the case model database schema. Once you have executed them, you must notify TIBCO ActiveMatrix BPM from Data Admin. Process instance execution fails unless you have executed the scripts and generated the case model database schema. When a new version of a case model is deployed, the older version is automatically uninstalled, as long as there are no outstanding process instances using the older version. If there are any outstanding process instances using the older version, then the older version is undeployed after a configured period (default one minute), once the last outstanding process instance is completed. This means that there could be two versions of the case model with an INSTALLED state. See TIBCO ActiveMatrix BPM Deployment Guide for more information about application deployment. Prerequisites Make sure your application is deployed. In other words, in TIBCO Administrator, the status of your application is Deploy with Start Successful. Procedure 1. From TIBCO Openspace, click Data Admin. 2. Click Live View. A list of the currently deployed case data models displays. 3. Click the case data model whose UPDATE scripts you want to retrieve. The latest version number that is currently deployed for that case model displays. The status of the case model must be PENDING_DBA_ACTION_TO_INSTALL. 4. Click Update Script. The UPDATE database script displays. 5. If you want to make any changes to the script, click Edit. ● For information on how you can edit database scripts, see Best Practice When Editing Case Model Database Scripts. ● When you edit a script, it is saved as a new revision. See Comparing Global Data Database Scripts to compare revisions of scripts. 6. Make any changes you require and click Save. The Save dialog displays. 7. You must enter a comment in the Comments box. 8. Click Save to save your changes or Cancel to close the dialog without saving your changes. 9. You can now execute the script on your database. If you have any problems executing the scripts, check your scripts to make sure that you have not made any invalid changes. See Best Practice When Editing Case Model Database Scripts. 10. Once the script has executed successfully, click Notify to notify TIBCO ActiveMatrix BPM that the scripts have been executed. The status of the case model has changed to INSTALLED. TIBCO® Openspace User's Guide 181 Retrieving DROP Case Data Database Scripts If your application with case data is undeployed, you can go to Data Admin and retrieve the DROP database scripts to drop database tables in the case model database schema. Once you have verified them, you must execute them on your database to remove the case model database schema. Once you have executed them, you must notify TIBCO ActiveMatrix BPM from Data Admin. The case model is deleted and removed from Data Admin. Prerequisites Make sure your application is undeployed. In other words, in TIBCO Administrator, the status of your application is Undeploy Successful. See TIBCO ActiveMatrix BPM Deployment Guide for more information about application undeployment. Procedure 1. From TIBCO Openspace, click Data Admin. 2. Click Live View. A list of the currently deployed case data models displays. 3. Click the case data model whose DROP scripts you want to retrieve. The latest version number that is currently deployed for that case model displays. The status of the case model should be PENDING_DBA_ACTION_TO_UNINSTALL. 4. Click Drop Script. The DROP database script displays. 5. If you want to make any changes to the script, click Edit. ● For information on how you can edit database scripts, see Best Practice When Editing Case Model Database Scripts. ● When you edit a script, it is saved as a new revision. See Comparing Global Data Database Scripts to compare revisions of scripts. 6. Make any changes you require and click Save. The Save dialog displays. 7. You must enter a comment in the Comments box. 8. Click Save to save your changes or Cancel to close the dialog without saving your changes. 9. You can now execute the script on your database. If you have any problems executing the scripts, check your scripts to make sure that you have not made any invalid changes. See Best Practice When Editing Case Model Database Scripts. 10. Once the script has executed successfully, click Notify to notify TIBCO ActiveMatrix BPM that the scripts have been executed. Once the DROP scripts have been executed, the case model is removed from Data Admin. Comparing Case Data Database Scripts When any of the case model database scripts are edited, a new revision of the script is saved. There may be many revisions for a particular script. In Data Admin, you can compare revisions so that you can see what changes have been made between revisions. Procedure 1. From TIBCO Openspace, click Data Admin. TIBCO® Openspace User's Guide 182 2. Click Audit View. A list of the currently deployed case data models displays. 3. Click the case data model whose script revisions you want to compare. A list of version numbers that are currently deployed for that data model displays. 4. Click the version number that you require. 5. Depending on the script you want to compare, click either Create Script, Update Script, Drop Script. 6. Click Revisions. 7. From Select Revision, click the first revision you want to compare. 8. Press Ctrl + click the second revision you want to compare the first revision with. 9. Click Compare. The Comparison Viewer displays the scripts. The changes between the scripts are highlighted in green. 10. From the Compare Create Scripts drop-down list, select either ● Create Scripts ● Update Scripts ● Drop Scripts if you want to review the other scripts for that case model. 11. To select different revisions, click Revisions. 12. Click Return to return to Audit View. Freezing Case Data Models You can freeze case data models so that no further changes can be made to it. In other words, the case model cannot be upgraded or undeployed. This prevents another database administrator making any further changes to the case data model. Prerequisites Make sure the status of the case model is Installed. TIBCO® Openspace User's Guide 183 Procedure 1. From TIBCO Openspace, click Data Admin. 2. Click Live View. A list of the currently deployed case data models displays. 3. Click the case data model that you want to freeze. The latest version number that is currently deployed for that case model displays. 4. Click the version number. If you hover your cursor over the version number, the status of the case data model must be Installed. You cannot freeze a case model that is PENDING_DBA_TO_INSTALL or PENDING_DBA_TO_UNINSTALL. 5. Click . A message displays indicating that the case model is frozen. If you hover your cursor over the case model, the Frozen property has a status of true. 6. To unfreeze, click . A message displays indicating that the case model is unfrozen. If you hover your cursor over the case model, the Frozen property has a status of false. TIBCO® Openspace User's Guide 184 Case Management You can use the Case Management gadget to manage and manipulate your case data. Case data is business data that is centrally managed by ActiveMatrix BPM and can therefore be accessed and updated by multiple BPM process applications. Business data is structured data that contains information about real-world entities or business concepts that an organization needs to manipulate, for example: Customer, Order, Orderline, Claim or Policy. Case data: ● can have a state (that is, it can have data and/or documents associated with it). ● can be referenced by a set of processes and/or work items that are responsible for making state changes to it. ● has its own audit history, independent of any processes or work items that operate on it. Case data can be modeled at design-time as case classes in a case model then represented at runtime as case objects which can be referenced by corresponding case classes. Any BPM application can interact with a case data model to create and use case data. A BPM application, in this context, is either: ● a BPM process, defined in TIBCO Business Studio and deployed to the BPM runtime. ● a custom client application that uses the ActiveMatrix BPM public API to invoke BPM services provided by the BPM runtime. See TIBCO ActiveMatrix BPM Case Data User's Guide for more information. Using the Case Management gadget, you can manage and manipulate case data in the following ways: ● display and update case objects in forms or pageflows. ● view and manage any documents associated with the case data. ● use case data to find in-progress work items and/or process instances that are associated with a particular case. ● locate a particular case and perform case state-specific actions on it. ● update case objects on an ad-hoc basis, independent of any enterprise process update - for example, a customer reporting a change of address. You must log in as a user that has privileges with the correct system actions assigned to it. Using Case Search You can create ad-hoc searches or advanced searches. Using an ad-hoc search, you can perform searches using one or more case attributes of a case class. An advanced search allows you to build up a complex search query. When you access the Case Management gadget, a list of the available case classes for all business object models deployed to your ActiveMatrix BPM system are displayed. Also, a list of your saved and favorite searches (if you have any) are displayed. You can either select one of these or create a new search. See Performing an Ad-hoc Search or Performing an Advanced Search. There are two top-level categories for searches: ● Saved Searches: When you save a search, it is added to Saved Searches. You can create categories within Saved Searches. See Performing an Ad-hoc Search or Performing an Advanced Search. TIBCO® Openspace User's Guide 185 ● Favorites: To add a search to Favorites, select a search in Saved Searches and click . You cannot create categories for searches within Favorites. Prerequisites You must login as a user that has the system actions assigned ● To perform an ad-hoc search or a parameterized ad-hoc search, the readGlobalData system action must be assigned. ● To edit, save or delete ad-hoc, parameterized ad-hoc searches, or advanced searches, both the readGlobalData and manageDataView system actions must be assigned. Procedure 1. Navigate to the category where your search is stored. 2. Select your search. The cases that match the defined search criteria display. The case attributes listed in your case summary are displayed. The case summary is defined at design-time in TIBCO Business Studio. See TIBCO Business Studio Modeling Guide for more information. 3. Select a case. If required, use the Search facility to identify your case. See Searching Case Data. All the case data associated with the selected case is displayed. 4. If you have any case actions defined for your case, you can select a case action to perform. See Performing Case Actions. 5. If you select a case, you are able to select one of the following: Option Description View Work List Select this to view and progress work items using the selected case. See Managing Work Lists Associated With Case Data. View Audit/Events Select this to view an audit trail for the selected case. See Viewing Audit and Event Information Associated with Case Data. View Process Select this to view process instances using the selected case. See Managing Processes Associated With Case Data. Manage Ad-hoc Activities Select this to manage ad-hoc activities associated with the selected case. See Executing Ad-Hoc Activities. 6. If there are any case documents associated with your case you can manage them from the Case Management gadget. See Managing Case Documents. Performing an Advanced Case Data Search To create your advanced search, you must select the Advanced button in the Case Management gadget. The Advanced Search wizard enables you to: ● (Required) Enter the advanced search details, for example, its name, description and/or category. ● (Required) Select the case data and configure the search criteria for your advanced search. ● (Optional) Configure any sort criteria, depending on your requirements. Procedure ● Click Advanced. TIBCO® Openspace User's Guide 186 Enter Advanced Search Details The Details screen in the Advanced Search wizard allows you to enter the details for your advanced search, its name and, optionally, its description. Procedure 1. (Required) In the Name field, type a name for your advanced search. The name must be unique. 2. (Optional) In the Description field, type a description of your advanced search. 3. (Optional) In the Category field, type a category for your advanced search. Categories exist when an advanced search is first associated with them and cease to exist when the last advanced search is deleted. You can create a hierarchical structure for your categories using forward slashes. If you do not specify a category, the advanced search is created under the UNCATEGORIZED category in Saved Searches. 4. Click Next to continue. Configuring the Advanced Search Filter Criteria You can configure filter criteria for all the searchable attributes in your case class. This allows you to filter the list of case data in your search to display specific case data. Using the Filter page, you can construct conditions using the searchable attributes defined in your case classes. Attributes are specified as searchable when designing your case data in TIBCO Business Studio. See TIBCO Business Studio Modeling Guide for more information. Procedure 1. From the Case Class Information box, select the case data model whose case classes you want to define search criteria for. The case classes that are available for the case model display. Advanced searches can only specify one case class at a time. In other words, you cannot add more than one case class to a search condition. If you want to search another case class, you can add a new advanced search or change to another case class. If you change to another case class, a warning displays indicating that the currently selected conditions will be cleared if you do this. 2. Select the case class. The searchable attributes defined for the case class display. 3. Select the searchable attribute. If the searchable attribute is an array, you can also specify filter criteria for the array. See Filtering Array Attributes in Searches. 4. Double-click the attribute to add the condition. 5. Specify a logical operator for the condition. Depending on the data type of the attribute you selected, you can select one of the following: Option Description EQ Equal to value. If value contains any unescaped wildcard symbols ('_' or '?' for single character, '%' or '*' for anything - any of which can be escaped by prefixing with '\'), this will result in a 'like' comparison. For example: apple = "apple" banana% = "banana%" cherry% = like cherry% TIBCO® Openspace User's Guide 187 Option Description damson\*? = like damson\*? NEQ Not equal to the value. GT Greater than value. GTE Greater than or equal to value. LT Lower than value. LTE Lower than or equal to value. IN Equal to one of the values in an array. For example, IN('abc', 'bcd', 'def'). NOT_IN Not equal to any of the values. BETWEEN Between value#1 and value#2 (inclusive). NOT_BETWEEN Not between value#1 and value#2 (inclusive). NULL Object reference is null. NOT_NULL Object reference is not null. TYPE_OF Object referenced is of a particular type (where value is fully qualified class name) or a sub-type of that type. 6. Specify a value for the attribute. The value must be the same data type as the data type of the attribute. See "BOM Native Types" in the Business Data Services Guide for more information. 7. You can select another attribute to create more complex expressions. When adding additional attributes, you are essentially combining logical ANDs and ORs in a single expression. An attribute that is added underneath another attribute is effectively enclosed in parentheses. This means that the second attribute is evaluated separately, and then its result is used to evaluate the parent attribute. You can add as many attributes as you want. To select another attribute, double-click the attribute. 8. Depending on your requirements, click the arrow icon ( be included into a single expression. ) next to the condition if you want it to 9. Select one of the following: Option Description AND Select AND if you want the search critieria to match more than one attribute. OR Select OR if you want the search criteria to search against more than one attribute. Follow Step 5 - Step 6 to complete the search condition. The Description displays your completed condition. 10. You can remove a condition at any time by clicking the Remove icon ( ) Filtering Array Attributes in Searches When specifying filter criteria in a search, some of the attributes in the case class may be arrays. If the attribute is an array, its name is followed by [ ] characters in the data view list. Attributes in a case class can also include nested arrays. TIBCO® Openspace User's Guide 188 Procedure 1. When you are filtering an array, or an item in an array, a field appears next to the array name on the Filter pane. The field appears for most operators, like Equal, Not Equal, Greater Than, Null, and so on (there are some exceptions that are described below). The valid entries for this field are: Option Description ANY Returns any of the items in the array that match the specified criteria ALL Returns all of the items in the array that match the specified criteria An index number Returns the cases that match the specified criteria at that index number (zero based). 2. You can use tags in filter expressions to build more complex compound expressions. Tags are used when you want to stipulate that one or more of the compound expressions are to evaluate the same members of the array, or different members of the array. Tags only make sense when you are building compound expressions. A tag is entered in the array field on the Filter page by entering a $ character followed by a letter (a-z), optionally followed by additional letters or integers. The tag value following the $ is arbitrary, although each tag value represents a unique member of the array. 3. When you are filtering on an array attribute, the following Size... operators are available: ● Size Equal ● Size Not Equal ● Size Greater Than ● Size Greater Than or Equal ● Size Less Than ● Size Less Than or Equal These operators allow you to specify that cases be returned that have a certain number of members in the array. Configuring Sort Order for Advanced Searches You can configure the sort information for attributes in your case class so that the results of your advanced search display in a desired order. For example, you may want the results of the advanced search to display claims that are open first, and then the date and time they started. You can select the attributes you want to sort, specify the desired order to display them, and the direction. You must have multiple attributes to configure sort information. By using the Up ( ) and Down ) arrow keys, you can configure the list to be sorted first on one attribute and then another, and ( so on. If you click Next without specifying any sort criteria, the data is returned in an arbitrary order from the TIBCO ActiveMatrix BPM node. Procedure 1. From the left hand column in the pane, select the criteria to sort on. You can select multiple criteria. Click the Right icon to move it to the right-hand column. TIBCO® Openspace User's Guide 189 2. For the individual attributes, select the sort direction by clicking on the individual attribute. 3. If you have multiple items in the list, specify the sort order of the items by clicking on or . They are set to ascending order by default when you add them to the list. Performing an Ad-hoc Search Ad-hoc search enables you to quickly perform a one-off search, based on one or more top-level attributes of a case class. Ad-hoc search simplifies the search criteria selection by showing only top-level attributes of the case class. The contained classes and nested grouping of conditions are not provided. Ad-hoc search applies the condition to all the search criteria. You can also save your ad-hoc searches as parameterized searches. For example, you may want to perform many searches that use the same case attributes but different filter criteria. By saving your search as a parametized search, you can retrieve only the attributes you want. You can only select one case class in each ad-hoc search. If you want to search another case class, you must go back and select a new case class. Prerequisites You must login as a user that has the following system actions assigned: ● To perform an ad-hoc search or a parameterized ad-hoc search, the readGlobalData system action must be assigned. ● To edit, save or delete ad-hoc or parameterized ad-hoc searches, both the readGlobalData and manageDataView system actions must be assigned. Procedure 1. From the Select an item to start an ad-hoc search box, a list of the available case classes for all business object models deployed to your ActiveMatrix BPM system are displayed. 2. Select the case class that you want to perform the search for. The attributes available for the case class are displayed. 3. Select a logical operator for the attribute you want to perform the search on. Depending on the data type of the attribute you selected, you can select one of the following: Option Description EQ Equal to value. If value contains any unescaped wildcard symbols ('_' or '?' for single character, '%' or '*' for anything - any of which can be escaped by prefixing with '\'), this will result in a 'like' comparison. For example: apple = "apple" banana% = "banana%" cherry% = like cherry% damson\*? = like damson\*? NEQ Not equal to the value. GT Greater than value. TIBCO® Openspace User's Guide 190 Option Description GTE Greater than or equal to value. LT Lower than value. LTE Lower than or equal to value. IN Equal to one of the values in an array. For example, IN('abc', 'bcd', 'def'). NOT_IN Not equal to any of the values. BETWEEN Between value#1 and value#2 (inclusive). NOT_BETWEEN Not between value#1 and value#2 (inclusive). NULL Object reference is null. NOT_NULL Object reference is not null. TYPE_OF Object referenced is of a particular type (where value is fully qualified class name) or a sub-type of that type. If the searchable attribute is an array, you can also specify filter criteria for the array. See Filtering Array Attributes in Case Views. 4. Specify a value for the attribute. The value must match the data type for the data type of the attribute. See "BOM Native Types" in the Business Data Services Guide for more information. The data type of the value is displayed in the value field. 5. You must specify filter criteria for at least one attribute. When configuring additional attributes, you are combining a logical AND into a single expression. Repeat Step 3 - Step 4 for all the other available attributes that you want to configure filter criteria for. 6. Once you have specified your filter criteria, select Search. The search results display. The case attributes listed in your case summary are displayed. The case summary is defined at design-time in TIBCO Business Studio. See TIBCO Business Studio Modeling Guide for more information. 7. You can either: ● Select to exit the search without saving it. ● Select Save Search, if you want to save the search. ● Select Edit to rerun the search. a) In the Name field, type a name for your search. The name must be unique. b) (Optional) In the Description field, enter a description for your search. c) (Optional) In the Category field, enter a category for your search. You can specify an existing category or create a new one. You can create a hierarchical structure for your categories using forward slashes, for example, Car/Release ID. Categories exist when a search is first associated with them and cease to exist when the last search in the category is deleted. If you do not specify a category, the searches are created under the UNCATEGORIZED category in Saved Searches. d) (Optional) You can save the search as a parameterized search. That is, you can save this search for one or more specific case attributes. From the Select items to save the search as parameterized (optional) field, select the case attributes you want. By default, the attribute names are listed in the field but you can specify a label for the attribute if you wish. 8. Select Save Changes. TIBCO® Openspace User's Guide 191 Searching Cases Once the cases that match the search query defined in your ad-hoc or advanced search are displayed, you can use the Search facility to quickly find a single case. This is a text based search and it searches all the text in the cases that are currently displayed. The search is dynamic so as you start typing, Openspace searches all the columns that are displayed, to identify your case. Any cases that matches the text you are typing, automatically display. If you have a large number of cases, the search may take a few minutes. Prerequisites You must login as a user that has privileges with the correct system actions assigned. Procedure 1. Perform a search to return the cases. See Performing an Ad-hoc Search or Performing an Advanced Search. 2. Type your text in the Search box. Once you start typing, Openspace dynamically populates the Case Management gadget with the cases that match your text. 3. To clear your search, select . Editing Searches You can edit your searches at any time. Procedure 1. From Saved Searches, select Edit. All your saved searches are displayed, including your favorites. 2. Select Edit next to the search you want to edit. Then, depending on what type of search you are editing, do the following: ● If you are editing an advanced search or non-parameterized ad-hoc search, the search criteria is displayed. Follow the steps described in "Configure the Advanced Search Filter Criteria" to edit your search. ● If you are editing a parameterized ad-hoc search, the Save Search page is displayed. Follow the steps described in Performing an Ad-hoc Search to complete the Save Search page. Deleting Searches You can delete your saved searches at any time. Procedure 1. From Saved Searches, select Edit. All your saved searches are displayed, including your favorites. 2. Select Delete next to the search you want to delete. A message dialog displays to confirm you want to delete the view. 3. Select OK to delete the search or Cancel to return to the Case Management gadget. TIBCO® Openspace User's Guide 192 If you delete a search, any users who are accessing the search lose access to the search and a message displays when they next try to access the search. Performing Case Actions You can select a case in the Case Management gadget and perform any case actions that have been defined for the case. A case action is an action that can be performed on a case when it is in a particular state. Case actions are designed within the context of the business process itself. For example, a claim may have the following states defined; Reported, Review, Submitted and Completed. Once a claim is Reported it may need to be reviewed by a Claims Adjuster. Once you have selected your case in the Case Management gadget, you can select Review from Case Actions and progress the claim to the next task in your business process. Case states are a special type of attribute that can be defined for a case class. Case actions are a type of business service defined for a case class. Case states and actions are defined when creating your case data model in TIBCO Business Studio. See TIBCO ActiveMatrix BPM Case Data User's Guide for more information. Procedure 1. From the Case Management gadget, perform a search to retrieve a list of cases. See Performing an Ad-hoc Search or Performing an Advanced Search. You cannot select multiple cases. You can only perform a case action on one case at a time. 2. Select a case. If required, use the Search facility to identify your case. See Searching Cases. 3. Select Case Actions. Any case actions that are available for the selected case display. What case actions you see, if any, are entirely dependent on what state the case is in, and what permissions have been set. 4. Select the case action you want to perform. Depending on how your process template is defined, either ● The action defined by the case action is performed. ● A form displays. The content of the form depends on how your process template has been defined. Select Submit to submit the form and perform the action on the case, or select Cancel or Close to close the form without performing any action. Managing Work Lists Associated With Cases You can select a case in the Case Management gadget and view the work items that are using that case data. You can view information about the work item such as its name, description, ID, priority and so on. You can also perform some actions on the work item. For example, you can open the work item and submit it, or allocate the work item to another resource. Prerequisites You must be logged in to Openspace as a user that has privileges with the correct system action assigned to view the work lists. Procedure 1. From the Case Management gadget, perform a search to retrieve a list of cases. See Performing an Ad-hoc Search or Performing an Advanced Search. TIBCO® Openspace User's Guide 193 2. Select a case. If required, use the Search facility to find your case. See Searching Cases. 3. Select Case Navigation > View Work List. The work list for the selected case displays. 4. You can choose what columns are displayed. See Configuring Columns in Case Navigation. 5. Select the work item you want to manage. Note that: ● By default, a maximum of 10 items display, depending on how many work items are associated with the case. You can change how many items are displayed by clicking the up or down arrow in the Page Size box. ● You can use the arrows to scroll through the list. For information about the work item columns you can view, see Work Item Columns. You can select one of the following tabs: Option Description Details Displays information about your work item. See Work Item Columns. Attributes Displays the work item attributes that were defined in your process at design-time. Preview Displays a preview of the case data that this work item is accessing. 6. You can perform the following actions on a work item. Option Description Open a work item A work item must be allocated to you for you to open a work item. Opening a work item causes the form associated with that work item to display. You cannot enter any information into the form. However, you can select Cancel, Close or Submit, depending on your requirements. See Opening Work Items. Close a work item The work item must have a state of OPENED for this option to be enabled. It causes any information entered in the form to be saved, then the work item is closed (and unlocked) and placed back in the work item list with a state of PENDED. The work item is then available to be opened and completed at a later time. See Saving Work Items. Allocate a work item A work item can be allocated to a specific user. See Allocating Work Items Overview. Skip a work item A work item must have a state of ALLOCATED and all the required fields on the form must be completed before a work item can be skipped. This marks the work item as complete, removes it from the work item list, and causes the process to advance. It has the same affect as opening the work item and submitting it. See Skipping Work Items. Refresh the You must refresh ( ) the work item list any time you perform an action so Work Item list that the work item list can be updated to show the results of your actions. 7. Select to close the Work List page. TIBCO® Openspace User's Guide 194 Configuring Columns in Case Navigation Case Navigation in the Case Management gadget allows you to view information about a selected case ID. For example, the work item list, process list, audit / event information and ad-hoc activities using the case data. You can select the information you want to display. Procedure 1. From the Case Management gadget, select a case ID whose case data you want to manage. See: ● Searching for Case IDs ● Using Case Views 2. Select an option from Case Navigation. . 3. From the right of the page, select The Choose Columns window displays. 4. Select or deselect the columns you want to display. The page displays the columns you selected. 5. Optionally, select next to the columns, if you want to group your items together. You can select more than one. Each group you select is added as a subordinate group to the previous group you selected. For example, you may want to group your work items by State and then Priority. The page displays the grouped items and the Group icon displays with a number beside it to . indicate where it is in the group hierarchy. For example, 6. Once you have made your selections, select to close the Choose Columns window. 7. You can change the order of the columns, by selecting a column and dragging it to a new location. 8. To return to the default settings, open the Choose Columns window and ensure that all the columns are selected and remove any groups. Managing Processes Associated With Case Data You can select a case in the Case Management gadget and display information about the process templates associated with the case data. You can view information, such as process status, priority, duration and so on. You can also perform actions such as start, suspend, or cancel a process instance. Prerequisites You must be logged in to Openspace as a user that has privileges with the correct system action assigned to view and perform actions on the process template list. Procedure 1. From the Case Management gadget, perform a search to retrieve a list of cases. See Performing an Ad-hoc Search or Performing an Advanced Search. 2. Select a case. If required, use the Search facility to find your case. See Searching Cases. 3. Select Case Navigation > View Processes. The process template list for the selected case displays. 4. You can choose what columns are displayed. See Configuring Columns in Case Navigation. 5. Select the process template you want to manage. TIBCO® Openspace User's Guide 195 The process template list is divided into columns that show you information about your process templates. See Process Template List Columns. Note that: ● By default, a maximum of 10 items display, depending on how many process templates are associated with the case. You can change how many items are displayed by clicking the up or down arrow in the Page Size box. ● You can use the arrows to scroll through the list. 6. You can perform the following actions on a process template. Option Description Start a process Starting an instance of a process results in initiating the first task of the process. This typically results in one or more work items being sent to one or more work lists. See Starting a Process Instance. Suspend a process You can suspend activity in a process instance, which causes all work items that are associated with that process instance to also become suspended, and the process flow is halted at that point. Work items that are suspended cannot be worked on, for example, they cannot be opened, allocated, re-offered, nor cancelled. See Suspending a Process Instance. Cancel a process You can cancel a process instance, which stops the process flow and deletes all work items that are associated with that process instance. See Canceling a Process Instance. Refresh the Work Item list You must refresh ( ) the process list any time you perform an action so that the process list can be updated to show the results of your actions. 7. You can select to close the Process List page. Viewing Event Information Associated with Case Data Events are actions that have taken place, for example, logging in, opening a work item, submitting a work item, suspending a process instance, and so on. You can view information about the events that have taken place for a selected case. Prerequisites You must be logged in to Openspace as a user that has privileges with the correct system action assigned to view the work lists. Procedure 1. From the Case Management gadget, perform a search to retrieve a list of cases. See Performing an Ad-hoc Search or Performing an Advanced Case Data Search. 2. Select a case. If required, use the Search facility to find your case. See Searching Cases. 3. Select Case Navigation > View Audit/Events. The event list for the selected case displays. 4. You can choose what columns are displayed. See Configuring Columns in Case Navigation. 5. Select the event you want to view. Note that: TIBCO® Openspace User's Guide 196 ● By default, a maximum of 10 items display, depending on how many events are associated with the case. You can change how many items are displayed by clicking the up or down arrow in the Page Size box. ● You can use the arrows to scroll through the list. The following table describes the information that is displayed for each event. Option Description Creation Time The date and time the event occurred. Principal Name The name of the resource that performed the event. Message ID The unique identifier of the event. Severity The message level that is set for that event. See Setting the Message Level. 6. You can refresh the event list at any time by selecting 7. Select . to close the Event List page. Managing Case Documents You can select a case in the Case Management gadget and download, upload, open, and delete documents associated with the case. When using TIBCO Business Studio Forms, the sample library of custom controls contains Document Viewer, a sample custom control for downloading and viewing case documents through a form. For implementation details, see the Custom Controls section in the TIBCO Business Studio Forms User's Guide. Prerequisites You must be logged in to Openspace as a user that has privileges with the correct system action assigned to manage case documents. You or your BPM administrator must also have configured BPM to use the CMIS repository either during or after installation using TCT (the Edit ActiveMatrix BPM Instance option) or by editing the cm.properties and bds.properties configuration files. Procedure 1. From the Case Management gadget, perform a search to retrieve a list of cases. See Performing an Ad-hoc Search or Performing an Advanced Case Data Search. 2. Select the case for which you want to manage case documents. If required, use the Search facility to find your case. See Searching Cases. The Case Documents details are displayed. If no document has been uploaded yet, only the Upload button is displayed. 3. In Case Documents, you can: Option Description Download a document Select a document and click the Download Selected Document button to download a document from the CMIS repository to your local computer. Upload a document Click the Upload a Document button to browse for a document, upload is to the CMIS repository, and associate it with the selected case. TIBCO® Openspace User's Guide 197 Option Description Depending how your CMIS repository is configured, you may need to select a version, Major, Minor, or None, or else the upload fails. Also, you cannot upload a document with the same name to the same location in the CMIS repository. Open a document Select a document and click the Open Selected Document button or doubleclick the document name to view the document content. When the document is selected, you can also view metadata about the document such as the name, when it was created, and the file size. Open a document Select a document and click the Open Selected Document in New Window in a new window button to view the document content in a new window. Delete a document Click the Delete button to delete a document from the CMIS repository. Delete Orphaned Folders Click Delete Orphaned Folders to remove leftover folders from an application undeployment (if when you undeployed the application you selected the option to leave the folders intact). TIBCO® Openspace User's Guide 198 Managed Events Openspace allows contributed gadgets to communicate with Openspace and with other gadgets. ● Contributed gadgets run in Iframes that are code isolated for security reasons. ● Managed Events provide communication between gadgets and Openspace securely using the TIBCO PageBus™ Managed Hub. A ManagedEvent is an extension of a normal Google Web Toolkit (GWT) GwtEvent. A PageBus message is any JavaScript type that can be published directly to the TIBCO PageBus™. A Hub Policy is used to control which gadgets have the ability to either fire or receive specific Managed Events or PageBus messages. Managed Events extend the normal Google Web Toolkit (GWT) Event/ Handler model and transparently handle the PageBus message details. Gadgets that are developed in GWT can use Managed Events. Non-GWT JavaScript applications can also subscribe to and publish PageBus messages directly using the TIBCO PageBus™ Managed Hub API. For API details see: TIBCO PageBus™ Developer’s Guide Software Release 2.0 October 2009 All contributed gadgets run in secure iFrames that are code isolated from Openspace and other gadgets. To administer Managed Events, you must first contribute a gadget, and then use the Hub Policy Administrator. Contributing a Gadget to the Hub Policy Administrator You must contribute a gadget to the Hub Policy Administrator to administer managed events. Procedure 1. Deploy an application (GWT or JavaScript) to the webserver. 2. Contribute a deployed gadget to Openspace. a) Click on a tab to display the Gadgets panel. b) Select More Gadgets > Contribute Gadget . c) For the Gadget Spec URL, enter the URL of the application created in step 1. d) For the Hub Policy URL, enter the Hub Policy URL. When a gadget is contributed a URI is specified to a HubPolicy file. The HubPolicy is required for Openspace to publish Managed Events. The HubPolicy file defines the URL the gadget is loaded from and the topics associated with either Managed Events or PageBusMessages the gadget is allowed to publish and subscribe to. e) Enter a Name and Description for the gadget you are creating. f) Select Import Gadget. When you have contributed a policy, the HubPolicy Administrator page appears showing the HubPolicy you have contributed. All access will initially be set to not granted and this view of the HubPolicy Administrator is read only. 3. Select Close. This loads the gadget onto the palette. 4. Select the gadget on the palette and select Add Gadget. 5. Select Manage Gadgets > Communication . The Hub Policy Administrator is displayed as a tree of checkbox elements (it adds the new hub policy to the list). Each item that is checked is granted permission and each that is not checked is denied permission. TIBCO® Openspace User's Guide 199 Using the Hub Policy Administrator The Hub Policy Administrator is used to configure what URI's have access to publish or subscribe to topics for messages or events on the PageBus Managed Hub. Permissions are granted based on the Origin value of a given URI. The Origin value includes only the URI scheme and the host value. For example, for http://host:port/pathname the Origin is http:// host. All URI values that have the same Origin have the same permissions. See Sample HubPolicy File Only a user who has the viewHubPolicy (to read only) or editHubPolicy (to read and edit) system actions configured can use the Hub Policy Administrator. See “System Actions” in TIBCO ActiveMatrix BPM Concepts for more information. The Hub Policy Administrator displays the items as a tree. The tree can be ordered in one of three orders: Domain, Topic Name, Topic Category. The order is selected from one of the radio buttons at the top of the display. The checkbox against each item in the tree is a three state checkbox which can be checked, unchecked, or multi-checked which is indicated by a checkbox with blue shading. The multi-checked state indicates that some child elements are checked and some child elements are unchecked. If all child elements are checked then the parent checkbox will be checked. If all child elements are unchecked then the parent checkbox will be unchecked. In the example above, the tree is ordered by Domain, and the multi-checked state at the top level and the level below that shows that a child element of each level is unchecked. An exclamation point icon next to the checkbox indicates that an item is required. This means that if permission is not granted for this item the gadget cannot operate normally and may not be loaded as a result. This icon can have three colors: TIBCO® Openspace User's Guide 200 ● Yellow: Item is required and has been selected. For a parent node this means all child items are required and all of them have been checked. ● Red: Item is required and has not been selected. For a parent node this means that at least one child that is required has not been checked. ● Green: This applies only for a parent node and indicates that some child elements are required and some are not but all those that are required have been checked. When the URI refers to the Manager Application (the application running in the main page loaded in the browser, not in an iframe) then this URI has a special designation as Window.Location: URI: Window.Location When Window.Location is encountered for the URI value the actual URI of the main loaded page is substituted for this value. Procedure 1. From a tab, expand the User Preferences area. 2. Click More Gadgets to display the Gadget Store. 3. From the Gadget Store, click Manage Gadgets > Communication. The Hub Policy Administrator displays. Developing Managed Events To enable development of managed events, you can use HubPolicy Files, Openspace Managed Events and two sample applications. ● HubPolicy File which defines the URL the gadget is loaded from and the topics associated with either Managed Events or PageBusMessages the gadget is allowed to publish and subscribe to. See Sample HubPolicy File. ● Openspace Managed Events, which are a number of Managed Events published by Openspace. See Openspace Managed Events. ● Two demo applications (Google Web Toolkit (GWT) and JavaScript) are supplied for you to edit to your own requirements. See Demo Applications. Sample HubPolicy File The HubPolicy file defines the URL the gadget is loaded from and the topics associated with either Managed Events or PageBusMessages the gadget is allowed to publish and subscribe to. The HubPolicy Administrator does not allow you to add a HubPolicy if the domain URI value is a duplicate of one that already exists. However, a new domain URI value may have the same Origin value even though the domain URI is different. If you contribute a Gadget with a HubPolicy (or a HubPolicy is added) that contains an Origin value that is a duplicate of one that exists in the current global HubPolicy, then: ● Any permissions granted to this Gadget's domain URI is granted to all Gadgets with the same Origin. ● Any permissions granted to the other Gadgets with the same Origin are also granted to this Gadget. For example, the following domain URIs have the same Origin value (http://host). ● http://host:port/apath?param1=example. ● http://host:port/apath?param1=example¶m2=anotherExample. publish b, subscribe B. The HubPolicy allows publish a, subscribe A. The HubPolicy allows TIBCO® Openspace User's Guide 201 ● http://host:anotherPort/anotherPath. The HubPolicy allows publish c, subscribe C. Each of these can be added with its own domain element in the HubPolicy. Whatever permissions are given are accumulated for the same Origin. In other words, each one of the three has all of the combined permissions. For example, for all the domain URIs beginning http://host, the HubPolicy allows publish a,b,c, subscribe A,B,C. The URI value must be URI encoded. See HubPolicy schema notes. This example shows subscribe elements for each of the Openspace ManagedEvents that are currently fired to the ManagedHub. The steps for creating a JavaScript client that receives ManagedEvents from Openspace are similar to those of the ManagedHubDemo example GWT application with several key differences: ● The TIBCO PageBus ManagedHub JavaScript interface must be used directly. For details on this interface see: TIBCO PageBus™ Developer’s Guide Software Release 2.0 October 2009 ● In JavaScript there is no ManagedEvent or ManagedEventHandler classes so the JavaScript message object is handled directly. ● In JavaScript there is no ManagedEventClient class which handles the details of creating and connecting the IframeHubClient. This needs to be done directly in JavaScript. The same basic steps are performed as in the createIframeHubClient() method of the ManagedEventClient class in GWT. Procedure 1. Check the format of the messages that correspond to the Openspace ManagedEvent the client will be receiving: See JSON Message Format. 2. Create an onDataCallback function to handle the message resulting from an Openspace ManagedEvent: function onDataCallback(topic, message, subscriberData) { // Process topic and message here. } 3. Create the IframeHubClient: See the JavaScriptDemo.js createIframeHubClient function. 4. Connect the IframeHubClient: The call to IframeHubClient connect is asynchronous and the post connect actions must be done in a callback that is passed to the connect method: iframeHubClient.connect(onConnectCompleteCallback); 5. After connecting the IframeHubClient: ● These actions are performed in the onConnectCompleteCallback. ● Subscribe to each of the message types using the topic and onDataCallback that will process incoming messages. ● The JavaScriptDemo.js provides two examples functions that subscribe to messages: doPageBusMessageSubscribe(); TIBCO® Openspace User's Guide 205 doManagedEventMessageSubscribe(); These both subscribe to messages in the same way. The only difference is in distinguishing between messages that result from an Openspace ManagedEvent being fired and any other message that can be published on the PageBus. JSON Message Format The following examples show the JSON serialized format of the Openspace published ManagedEvent messages. These values are returned in the onDataCallback which looks like this: function onDataCallback(topic, message, subscriberData) { // Process topic and message here. } where: ● topic = A JavaScript String. ● message = A JavaScript Object. ● subscriberData = The value passed on the subscribe method. The onDataCallback function is passed as a parameter to the JavaScript iframeHubClient.subscribe method. The format of the message parameter of the OnData callback is a JavaScript Object that looks like this: { message : "A JSON serialized string for the data that the ManagedEvent class defines", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.ManagedEventClassName_Ext_ManagedEvent_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.ManagedEventClassName_Ext_ManagedEvent" } TIBCO® Openspace User's Guide 206 BusinessService Event topic :"com.tibco.bpm.web.client.model.managedevents.BusinessServiceEvent_Ext_Mana gedEvent" message : { message : "{\"action\":\"START\",\"processInstanceId\":\"processInstanceId\", \"moduleName\":\"moduleName\",\"processName\":\"processName\",\"version\": \"version\",\"category\":\"category\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.BusinessServiceEvent_Ext_ManagedEven t_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.BusinessServiceEvent_Ext_ManagedEven t" } or { message : "{\"action\":\"one of: CANCEL, COMPLETE, UPDATE\",\"processInstanceId\": \"processInstanceId\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.BusinessServiceEvent_Ext_ManagedEven t_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.BusinessServiceEvent_Ext_ManagedEven t" } LocaleChangedEvent topic :"com.tibco.bpm.web.client.model.managedevents.LocaleChangedEvent_Ext_Manage dEvent" message : { message : "{\"locale\":\"en_us\",\"names\":[\"GadgetClassName1\", \"GadgetClassName2\"],\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.LocaleChangedEvent_Ext_ManagedEvent_ 1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.LocaleChangedEvent_Ext_ManagedEvent" } or { message : "{\"locale\":\"en_us\",\"names\":[],\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.LocaleChangedEvent_Ext_ManagedEvent_ 1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.LocaleChangedEvent_Ext_ManagedEvent" } TIBCO® Openspace User's Guide 207 LoginEvent topic :"com.tibco.bpm.web.client.model.managedevents.LoginEvent_Ext_ManagedEvent" message : { message : "{\"username\":\"username\",\"guid\":\"guid\",\"managedEventVersion\": \"1.0.0\"}" messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.LoginEvent_Ext_ManagedEvent_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.LoginEvent_Ext_ManagedEvent" } LogoutEvent topic :"com.tibco.bpm.web.client.model.managedevents.LogoutEvent_Ext_ManagedEvent" message : { message : "{\"username\":\"username\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.LogoutEvent_Ext_ManagedEvent_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.LogoutEvent_Ext_ManagedEvent" } PersistenceEvent topic : "com.tibco.bpm.web.client.model.managedevents.PersistenceEvent_Ext_ManagedEvent" message : { message : "{\"action\":\"one of: SAVE_DEFAULTS, DROP_USER, RESET_PERSONAS\", \"persona\":\"persona\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.PersistenceEvent_Ext_ManagedEvent_1. 0.0", topic : "com.tibco.bpm.web.client.model.managedevents.PersistenceEvent_Ext_ManagedEvent" } or { message : "{\"action\":\"RESET_PERSONA\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.PersistenceEvent_Ext_ManagedEvent_1. 0.0", topic : "com.tibco.bpm.web.client.model.managedevents.PersistenceEvent_Ext_ManagedEvent" } TIBCO® Openspace User's Guide 208 ProcessInstanceEvent topic :"com.tibco.bpm.web.client.model.managedevents.ProcessInstanceEvent_Ext_Mana gedEvent" message : { message : "{\"action\":\"START\",\"processInstanceId\":\"processId\",\"moduleName \":\"moduleName\",\"processName\":\"processName\",\"version\":\"version\", \"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.ProcessInstanceEvent_Ext_ManagedEven t_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.ProcessInstanceEvent_Ext_ManagedEven t" } or { message : "{\"action\":\"one of: CANCEL, RESUME, SUSPEND\",\"processInstanceId\": \"processId\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.ProcessInstanceEvent_Ext_ManagedEven t_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.ProcessInstanceEvent_Ext_ManagedEven t" } or { message : "{\"action\":\" SELECT\",\"processInstanceId\":\"managedEventVersion\": \"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.ProcessInstanceEvent_Ext_ManagedEven t_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.ProcessInstanceEvent_Ext_ManagedEven t" } Process Template Event topic : "com.tibco.bpm.web.client.model.managedevents.ProcessTemplateEvent_Ext_ManagedEven t" message : { message : "{\"action\":\"SELECT\",\"moduleName\",\"processName\":\"version\": \"description\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.ProcessTemplateEvent_Ext_ManagedEven t_1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.ProcessTemplateEvent_Ext_ManagedEven t" } TIBCO® Openspace User's Guide 209 SystemActionsEvent topic :"com.tibco.bpm.web.client.model.managedevents.SystemActionsEvent_Ext_Manage dEvent" message : { message : "{\"systemActions\":[{key:{\"entityType\":\”entityGuid\": \"actionComponent\":\"actionComponent1\",\"actionName\": \"actionName1\"},value:true},{key:{\"entityType\":\"entityGuid\":\"actionComponent \":\"actionComponent2\",\"actionName\":\"actionName2\"},value:true}], \"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.SystemActionsEvent_Ext_ManagedEvent_ 1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.SystemActionsEvent_Ext_ManagedEvent" } WebviewChangedEvent This is not published by Openspace but is received and handled by Openspace from external gadgets. topic : "com.tibco.bpm.web.client.model.managedevents.WebviewChangedEvent_Ext_ManagedEvent " message : { message : "{\"subject\":\"subject\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.WebviewChangedEvent_Ext_ManagedEvent _1.0.0", topic : "com.tibco.bpm.web.client.model.managedevents.WebviewChangedEvent_Ext_ManagedEvent " } WorkItemDataEvent topic :"com.tibco.bpm.web.client.model.managedevents.WorkItemDataEvent_Ext_Managed Event" message : { message : "{\"action\":\"OPEN\",\"workItemId\":1234,\"version\":12,\"processId\": \"processId\",\"dataFeed\":\"dataFeed\",\"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.WorkItemDataEvent_Ext_ManagedEvent_1 .0.0", topic : "com.tibco.bpm.web.client.model.managedevents.WorkItemDataEvent_Ext_ManagedEvent" } TIBCO® Openspace User's Guide 210 WorkItemEvent topic : "com.tibco.bpm.web.client.model.managedevents.WorkItemEvent_Ext_ManagedEvent" message : { message : "{\"action\":\"one of: OPEN, CLOSE, COMPLETE, CANCEL, SELECT\", \"workItemId\":1234,\"version\":12,\"processId\":\"processId\", \"managedEventVersion\":\"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.WorkItemEvent_Ext_ManagedEvent_1.0.0 ", topic : "com.tibco.bpm.web.client.model.managedevents.WorkItemEvent_Ext_ManagedEvent" } or { message : "{\"action\":\"CLOSE_LIST\",\"workItemId\":0,\"version\": 0,\"closeListItems\":[{\"workItemId\":123,\"version\":12},{\"workItemId\": 124,\"version\":13},{\"workItemId\":125,\"version\":14}],\"managedEventVersion\": \"1.0.0\"}", messageType : "com.tibco.bpm.web.client.model.pagebus.message.PageBusMessage", schemaId : "com.tibco.bpm.web.client.model.managedevents.WorkItemEvent_Ext_ManagedEvent_1.0.0 ", topic : "com.tibco.bpm.web.client.model.managedevents.WorkItemEvent_Ext_ManagedEvent" } TIBCO® Openspace User's Guide 211 Openspace - Mobile Overview Openspace - Mobile allows you to access Openspace from your mobile. Openspace - Mobile is only supported on iPhone. It is not supported on any other mobile device. Using Openspace - Mobile, you can access some of your gadgets from your mobile. You can: ● access your To Do List ● open work items and complete them ● allocate work items to yourself or other users ● display the current status of an individual process instance or group of process instances, by hours, days, months or years. You can also display the current status of all the work items associated with the individual process instance or group of process instances you have selected. ● configure the settings for Openspace - Mobile. Accessing Openspace - Mobile To start Openspace - Mobile you must enter a URL. Your system administrator determines how you start Openspace - Mobile but the URL will be in the form of http://machinename:8080/openspace/ mobile/mobile.html where machinename should be a fully qualified domain name or IP address. Procedure ● To start Openspace - Mobile, enter the URL. You must log in to Openspace - Mobile with a valid BPM username and password. Result After the browser connects, the following screen is displayed: TIBCO® Openspace User's Guide 212 Logging into Openspace - Mobile Procedure 1. In the User Name: field, type your username. 2. Press Tab. 3. In the Password: field, type your password. 4. Click Login. Result The first time you log in to Openspace - Mobile, the following screen layout is displayed: Click on the gadget you want to view. You can select either: ● To Do List, see Using To Do List. ● Performance, see Using Performance. ● Settings, see Using Settings. Using Gadgets in Openspace - Mobile There are some functions that are common to all gadgets in Openspace - Mobile. Function Description Click to refresh the screen at anytime. Click to return to the Main screen from whereever you are in Openspace Mobile. TIBCO® Openspace User's Guide 213 Function Description Click to cancel the current action. Note: The Search functionality is not available in this release. Using To Do List You can use the To Do List to display the work items in your list. From here, you can process work items. Procedure ● Click To Do List to display your work items. From the To Do List you can: ● View your work item list, see Work Item Status. ● Open, complete and submit work items, see Processing Work Items. ● Allocate a work item to yourself or others, see Allocating Work Items. ● Search for work items. Search functionality is not available for this release. Work Item Status The status of a work item determines what stage it has reached in the process. A work item can have various states. The following table shows how the work item states are displayed in Openspace - Mobile: TIBCO® Openspace User's Guide 214 State Description OFFERED. The work item is being offered to you to work on. When a work item is in an OFFERED state, you can: ● open and work on the work item (while it is open, its state changes to OPENED), ● allocate the work item to yourself, causing it to be removed from all other user’s work lists, ● allocate the work item to another user, causing it to be removed from all work lists other than the user’s to which it was allocated, or ● skip the work item, causing it to be submitted and the process to advance to the next task (all required fields must be filled in). ALLOCATED. A work item with an allocated state appears only in your work list. Work items can be allocated to a specific user in the following ways: ● by the system when it is initially distributed, ● you can allocate a work item to yourself, or ● you can allocate a work item to another user. OPENED. The work item is currently opened and locked by a user. PENDED. This occurs when you open a work item, perform some work on it, then close it without submitting it. Once it is in this state, the work item appears only in your list. Processing Work Items Open a work item to process it. You can fill in the form and complete the work item or save your changes, depending on your requirements. Procedure 1. Click a work item to select it. The work item is displayed. TIBCO® Openspace User's Guide 215 2. Click to open the work item. An example of an opened work item is shown below: Enter the information you require in the form and then you can either: ● click ● click to save the information but not submit the work item. to save and submit the work item. TIBCO® Openspace User's Guide 216 Allocating Work Items A work item can be allocated to a specific user. This means that the work item is supposed to be worked on by that specific user - the work item only appears in your list with a state of ALLOCATED. Procedure ● To allocate a work item, select the work item and click . Using Performance Performance allows you to display the current status of the process instances for a selected process template or group of process templates, by days, weeks, months or years. You can also display the current status of all the work items associated with the process instances for the individual or group of process templates you have selected. The results are displayed in either a column chart or a pie chart, depending on what you are viewing. Once you have selected Performance, the following screen is displayed: Viewing the Status of Selected Process Templates The procedure for viewing the current status of the process instances and the work items associated with the process instances for the selected process templates are the same. Procedure 1. Depending on your requirements, click: ● ToDo Items Measures, to view the current status of the work items associated with the process instances for the selected process templates. ● Process Instances Measures, to view the current status of the process instances for the selected process templates. The following screen is displayed: TIBCO® Openspace User's Guide 217 2. Select the process templates whose status you want to view. The screen displays a column chart of the current status of the work items or process instances, depending on whether you selected ToDo Items Measures or Process Instances Measures. The screen below is an example of a screen showing the work item status. 3. From Scope, select one of the following from the drop list (daily is selected by default): ● daily ● weekly ● monthly ● yearly 4. Click Start Date. Type the date in the format DD/MM/YY. The start date you select starts from the first second of the day. 5. Click Target Date. Type the date in the format DD/MM/YY. TIBCO® Openspace User's Guide 218 Note that: The target date you select ends at the last second of the day. ● ● If you select a measurement of time that spans too long a period of time, Openspace asks you to reduce the period of time you specified. Otherwise, there is too much information to display in the bar chart. ● The date is in the format DD/MM/YY and is not configurable. To display the status as a bar chart, click . To redisplay them as a pie chart, click . 6. By clicking on a particular section, more details are displayed, for example, the total number of work items in that section and the percentage of total work items that this section makes up. Using Settings You can configure Openspace - Mobile using Settings. Procedure ● When you click Settings, the following screen is displayed: TIBCO® Openspace User's Guide 219 You can click Help and About... to view the help information. Help information is not available for this release. TIBCO® Openspace User's Guide 220 User Access in Openspace Openspace displays all functions, and shows all buttons and menu selections that are available, even though you may not be able to use those functions because of your access privileges. Access to functions in Openspace is controlled by system actions. System actions are actions that need to be authorized, or need to be restricted to users with a certain level of authority. These actions might include, for example, re-allocating workitems, skipping workitems, viewing another user’s work list, or administering resources. This authorization is implemented by associating system actions with privileges within the organization model that is built in TIBCO Business Studio. See TIBCO Business Studio Process Modeler User’s Guide for more information. Some Openspace functions are controlled by a single system action, some are controlled by multiple system actions, whereas some are not controlled by system actions at all. At runtime, BPM maintains a list of system actions and of privileges, as defined in the organization model, and thus determines whether a user is authorized to carry out a particular action. You must be logged in as a user that has privileges with the correct system actions assigned to them. If you do not have the correct privileges to use a particular function, an exception is displayed that includes an Authorization Failed message. System Actions Mapping to Openspace Features Each Openspace features requires a system action that allows you to have access to that feature. Openspace Feature System Actions Required Provides access to the Manage Settings button and menu selection in the main banner. WSB. applicationConfiguration Business Services gadget WSB.startBusinessService Provides access to the Start a new instance of business service button. WSB.startBusinessService Provides access to the Add current category to favorites button. WSB.startBusinessService Work Views Gadget Provides access on a personal work item list or work view. DE.resolveResource Provides access to the Open Selected Work Items button and menu selection on a personal work item list or work view. DE.resolveResource Provides access to the Open Next Work Item button and menu selection on a personal work item list or work view. DE.resolveResource Provides access to the Auto-Repeat Open Work Item button and menu selection on a personal work item list or work view. DE.resolveResource BRM.autoOpenNextWorkItem BRM.autoOpenNextWorkItem TIBCO® Openspace User's Guide 221 Openspace Feature System Actions Required Provides access to the Cancel Work Items button and menu selection on a personal work item list or work view. DE.resolveResource Provides access to the Skip Work Item(s) button and menu selection on a personal work item list or work view. DE.resolveResource Provides access to the Pend Work Items button and menu selection on a personal work item list or work view. DE.resolveResource Provides access to the Change Priority of Selected Work Item button and menu selection on a personal work item list or work view. DE.resoolveResource Provides access to the Allocate Work Items to Self button and menu selection on a personal work item list. DE.resolveResource Provides access to the Re-Offer Work Items button and menu selection on a personal work item list. DE.resolveResource Provides access to both Allocate Work Items to Offer Set function on a personal work item list. DE.browseModel BRM.cancelWorkItem BRM.skipWorkItem BRM.pendWorkItem BRM.setWorkItemPriority BRM.workItemAllocation BRM.workItemAllocation DE.resolveResource BRM.workItemAllocation Provides access to Allocate Work Items To World function on a personal work item list. DE.browseModel DE.resolveResource BRM.workItemAllocation Provides access to the Filter button and menu selection on a personal work item list. DE.resolveResource Provides access to the Sort button and menu selection on a personal work item list. DE.resolveResource Provides access to the Auto-Refresh button and menu selection on a personal work item list. DE.resolveResource Provides access to the Select Columns button and menu selection on a personal work item list. DE.resolveResource Provides access to the Set as Default Columns button and menu selection on a personal work item list. DE.resolveResource Allows rescheduling of work items if a work item’s data has been modified in some way, either by the system or another application. DE.resolveResource Process Views Gadget DE.resolveResource BRM.scheduleWorkItem TIBCO® Openspace User's Guide 222 Openspace Feature System Actions Required Provides access to the list of process instances. PE.queryProcessTemplate PE.queryProcessInstance Provides access to the Cancel button and menu selection PE.queryProcessTemplate PE.queryProcessInstance PE.cancelProcessInstance Provides access to the Resume button and menu selection PE.queryProcessTemplate PE.queryProcessInstance PE.resumeProcessInstance Provides access to the Suspend button and menu selection PE.queryProcessTemplate PE.queryProcessInstance PE.suspendProcessInstance Provides access to the Filter button and menu selection PE.queryProcessTemplate PE.queryProcessInstance Provides access to the Sort button and menu selection PE.queryProcessTemplate PE.queryProcessInstance Provides access to the Process Migration button and menu selection PE. handleProcessMigration Provides access to the Force Special Action on Halted Process Instances button and menu selection. PE.haltedProcessAdministration Event Views gadget No system action required. Organization Browser gadget DE.browseModel Allows you to browse an organization model tree, for example, groups, capabilities, privileges. You can: DE.browseModel ● View and open Organization model versions ● Display the details (lower-right pane) to view information (privileges, capabilities and push destinations) for the selected organizational entity. TIBCO® Openspace User's Guide 223 Openspace Feature System Actions Required Allows you to view LDAP containers in the left hand pane of the Organization Browser. DE.browseModel ● You can view potential resources (shown in the resource list). Potential resources are those that are in the resource list, but have not been created nor mapped to a group or position; they are greyed out in the resource list. ● This provides access to the New LDAP Container button and menu selection in the Organization Browser. ● This provides access to the Edit LDAP Container button and menu selection in the Organization Browser. Provides access to the Delete LDAP Container button and menu selection in the Organization Browser. DE.LDAPAdmin DE.browseModel DE.LDAPAdmin DE.deleteLDAPAdmin Determines whether or not resource attribute columns are displayed in the resource list. DE.browseModel DE.readParameters Also, one of the following is required to see a resource: Provides access to the details (lower-right hand pane) to view information. This enables you to view: ● group membership ● positions held ● privileges ● capabilities for the selected resource ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) DE.browseModel DE.resolveResource Also, one of the following is required to see a resource: ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) TIBCO® Openspace User's Guide 224 Openspace Feature System Actions Required Provides access to view resource attributes in the details pane for the selected resource. DE.browseModel DE.resolveResource DE.readParameters Also, one of the following is required to see a resource: Provides access to view push destinations in the details pane for the selected resource. ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) DE.browseModel DE.resolveResource DE.readPushDestinations Also, one of the following is required to see a resource: ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) Provides access to View Events button and menu selection in the organizational model pane in the Organization Browser. DE.browseModel Provides access to all of the Edit Organizational Entity Push Destinations button and menu selection. DE.browseModel DE.readPushDestinations DE.writePushDestinations Provides access to all of the Import LDAP Containers button and menu selection. DE.browseModel Provides access to all of the Export LDAP Containers button and menu selection. DE.browseModel DE.importLDAPAdmin DE.exportLDAPAdmin TIBCO® Openspace User's Guide 225 Openspace Feature System Actions Required Provides access to group membership editing for the selected resources. DE.browseModel DE.resolveResource DE.createResourceAdmin Also, one of the following is required to see a resource: Provides access to positions-held information editing for the selected resources ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) DE.browseModel DE.resolveResource DE.createResourceAdmin Also, one of the following is required to see a resource: Provides access to the Edit Resource Attributes button and menu selection ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) DE.browseModel DE.readParameters DE.writeParameters Also, one of the following is required to see a resource: ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) TIBCO® Openspace User's Guide 226 Openspace Feature System Actions Required Provides access to the Edit Resource Attributes button and menu selection DE.browseModel DE.createResourceAdmin Also, one of the following is required to see a resource: Provides access to the Edit Resource Push destination button and menu selection ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) DE.browseModel DE.readPushDestinations DE.writePushDestinations Also, one of the following is required to see a resource: Provides access to the Create Resources button and menu selection ● DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) ● DE.resourceAdmin (indirectly needed to list resources in a group or position) DE.browseModel DE.createResourceAdmin DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) Provides access to the Delete Resources button and menu selection DE.browseModel DE.deleteResourceAdmin DE.LDAPAdmin (indirectly needed to list resources from an LDAP Container) Calendar Gadget DE.readCalendar Provides access to the New Base Calendar menu selection DAC.readCalendar DAC.writeCalendar Provides access to the New Overlay Calendar menu selection DAC.readCalendar DAC.writeCalendar Provides access to the Open Calendar menu selection DAC.readCalendar TIBCO® Openspace User's Guide 227 Openspace Feature System Actions Required Provides access to the Copy Calendar menu selection DAC.readCalendar DAC.writeCalendar Provides access to the Calendar Aliases menu selection DAC.readCalendar DAC.writeCalendar Provides access to the Map to Organization Model menu selection DAC.readCalendar Provides access to the Specify Working Hours menu selection DAC.readCalendar DAC.writeCalendar DAC.writeCalendar Provides access to the Specify Exclusions menu selection DAC.readCalendar DAC.writeCalendar Provides access to the Delete Calendar menu selection DAC.readCalendar DAC.writeCalendar DAC.deleteCalendar Provides access to the Lockdown properties in the OS.openspaceFeatureSetA CONFIG_HOME\tibcohost\adminenvironment- OS.openspaceFeatureSetB bpmenvironment-adminservername\data\host\plugins \com.tibco.openspace.login_n\resources \config.properties OS.openspaceFeatureSetC file. TIBCO® Openspace User's Guide 228 Accessibility Openspace can be used by users with disabilities such as those with visual impairments or problems with fine motor control. This means it can be used with assistive technology such as screen readers and magnifiers and that all functionality can be accessed and used using a keyboard only. Openspace addresses the requirements of: ● Section 508 Subpart B – Technical Standards — ● Section 508 Subpart C – Functional Performance Criteria — ● 1194.22 Web-based Intranet and Internet Information and Applications 1194.31 Functional Performance Criteria Web Content Accessibility Guidelines 2.0 — Level A — Level AA The following functionality is available in Openspace (accessible): ● Business Services. This displays all the business services that you can start in Openspace. ● Work Views. This displays your available work views and the work items listed in that work view. ● Process Views. This displays columns that show you information about the process templates and process template instances in your list. About User Access Access to functions in Openspace is controlled by system actions. System actions are actions that need to be authorized, or need to be restricted to users with a certain level of authority. These actions might include, for example, re-allocating work items, skipping work items, viewing another user’s work list, or administering resources. This authorization is implemented by associating system actions with privileges within the organization model that is built in TIBCO Business Studio. See TIBCO Business Studio Process Modeling User’s Guide for more information. Some Openspace functions are controlled by a single system action, some are controlled by multiple system actions, whereas some are uncontrolled. At runtime, BPM maintains a list of system actions and of privileges, as defined in the organization model, and thus determines whether a user is authorized to carry out a particular action. You must be logged in as a user that has privileges with the correct system actions assigned to them. If you do not have the correct privileges to use a particular function, an exception is displayed that includes an Authorization Failed message. Navigating Openspace You can navigate Openspace using Tab to move forward and Shift, then Tab to move back. You can also use shortcut keys. Listed below are some general points about navigating around Openspace. ● To move through the controls: — press Tab to move forwards — press Shift + Tab to move backwards. TIBCO® Openspace User's Guide 229 When a control has focus, this is represented by a focus rectangle, consisting of a dotted border. For example, . If you do not want the elements to be displayed with an outline, remove the *:focus CSS declaration in the accessibility.css stylesheet. ● To apply the action of a control, you can press Spacebar or Enter. ● You can move back to the first control of the page you are on at any time by navigating to . For example, if you are in Work Views, pressing Enter on Skip to Main Content will take the focus to the Work List box. ● Openspace has the following paging options: Icon Description Move to the first page of the list. Move to the previous page in the list. Move to the next page in the list. Move to the last page of the list. Select/Unselect all the items on the current page. Login Keyboard Shortcuts Openspace has provided keyboard shortcut keys for Login. Click Keyboard Shortcuts in the bottom right-hand corner of the screen to display the keyboard shortcuts. Press To .. Tab Moves focus through the login input fields Spacebar Hit the spacebar to select or unselect that active option for Remember me. Enter Hit enter on the Change Language link to display the list. Up or Down arrow keys Use down and up arrow keys to navigate through language list Business Services Keyboard Shortcuts Openspace has provided keyboard shortcut keys for Business Services. Click Keyboard Shortcuts in the bottom right-hand corner of the screen to display the keyboard shortcuts. TIBCO® Openspace User's Guide 230 Press To .. To move to Business Services Alt + Q Load Business Services Toggling Menu Down Arrow key Open a menu Shift + Up arrow key Close a menu Traversing the tree Up and Down arrow keys Traverse the tree from top to bottom Left and Right arrow keys Traverse the tree from left to right Navigating to Recent and Favorite Tabs Left arrow key Move left to Categories, Recent Categories and Favorite tabs Right arrow key Move right to Categories, Recent Categories and Favorites Alt + 1 Move to Categories tab from business services list Alt + 2 Move to Favorites tab from business services list Alt + 3 Move to Favorites tab from business services list Alt + 1 Move to business services list from any of the Categories, Recent Categories or Favorites tabs. Navigating the Business Services list Up and Down arrow keys Navigate the business services list Adding a business service to Favorites A Toggle the Add to Favorites action Working on Business Services Enter Display the business service in the data grid. Navigating the form Enter Open a form TIBCO® Openspace User's Guide 231 Press To .. Escape Close a form Moving between grid and table Alt + L Move to data grid from the Business Services List Alt + G Move to Business Services List from the data grid Work Views Keyboard Shortcuts Openspace has provided keyboard shortcuts for Work Views. Click Keyboard Shortcuts in the bottom right-hand corner of the screen to display the keyboard shortcuts. Press To .. To move to Work Views Alt + W Load Work Views Displaying work list. See the Data Grid keyboard description. Alt + Left Arrow key or Tab Move left Process Views Keyboard Shortcuts Openspace has provided keyboard shortcuts for Process Views. Click Keyboard Shortcuts in the bottom right-hand corner of the screen to display the keyboard shortcuts. Press To .. To move to Process Views Alt + P Load Process Views Moving Between Audit And Process Views Alt + 1 Move to Templates view From anywhere inside Process Views Alt + 2 Move to Audit View from anywhere inside Process Views Moving Between Grid and List Alt + L Move to grid from the Business Services Templates List TIBCO® Openspace User's Guide 232 Press To .. Alt + G Move to Business Services Templates List from the data grid Datagrid Keyboard Shortcuts Openspace has provided Datagrid keyboard shortcuts. Click Keyboard Shortcuts in the bottom right-hand corner of the screen to display the keyboard shortcuts. Press To .. Data Grid keyboard usage Right arrow key Move focus to the column left of current column Left arrow key Move focus to the column right of current column Home Move focus to the first column of the current row End Move focus to the last column of the current row Up arrow key Move focus to the row above the current row Down arrow key Move focus to the row below the current row Ctrl + Shift + Page Up Move focus to the first row of the current page Ctrl + Shift + Page Down Move focus to the last row of the current page Page Up Move focus to the last row or first row on the current page if the previous page is not available Page Down Move focus to the first row on the next page or focus on last row on the current page if the next page is not available. Spacebar Select the current row Shift + Up arrow key Toggle selection on the current row and the previous row. Shift + Down arrow key Toggle selection on the current row and the next row. Ctrl + Spacebar Toggle selection of all rows on the current page. Ctrl + Shift + Up arrow key Sort ascending order Ctrl + Shift + Down arrow key Sort descending order Ctrl + Enter Show current page number, row number and column name TIBCO® Openspace User's Guide 233 Press To .. Ctrl + Shift + Enter Shows rows selected Sort Column Ctrl + Shift + Up arrow key Sort ascending order Ctrl + Shift + Down arrow key Sort descending order Status Information Ctrl + Enter Shows page # of page #, Row H, Column Name Ctrl + Shift + Enter Shows row or rows # selected Datagrid Toolbar Keyboard Shortcuts Openspace has provided Datagrid toolbar shortcuts. Click Keyboard Shortcuts in the bottom right-hand corner of the screen to display the keyboard shortcuts. Press To .. Toolbar Navigation Enter Move focus to the Action toolbar above the data grid Tab Move focus to the Grid Navigation toolbar below the data grid Shift + Tab Moves focus to the Action toolbar above the data grid Search Mode Tab Moves focus to the next cell matching the search criteria Shift + Tab Moves focus to the next cell matching the search criteria Escape Cancels the search mode and returns to the normal view of the Data Grid Toolbar Button Navigation Left Arrow key Move focus to the button left of the current button Right Arrow key Move focus to the button right of the current button Escape Return focus back to the data grid Toolbar Button Selection TIBCO® Openspace User's Guide 234 Press To .. Enter Apply the button action based on the currently selected rows Spacebar Apply the button action based on the currently selected rows Click Keyboard Shortcuts in the bottom right-hand corner of the screen to display the keyboard shortcuts. Configuring Text Size You can increase or decrease the size of the text in Openspace. Procedure 1. Navigate to the text size icons in the top right-hand corner of Openspace. This enables you to increase or decrease the text size in Openspace by one pixel. You can also increase or decrease the text size by zooming in or out from your browser. The middle icon returns the text to its default size. 2. Press Tab to move to the icon that represents the text size you require. 3. Press Enter or Space bar. The text in Openspace is resized. You can resize the text at any time. The Openspace Login URL To access Openspace, type the Openspace login URL into your browser. The URL is: protocol://host:port/openspace/lite.html where: ● protocol is the communications protocol being used by Openspace, either http or https. This was determined at installation. ● host is the DNS name or IP address of the server hosting the BPM runtime. ● port is the port being used by Openspace. The default value is 8080. After the browser connects, the Openspace Login screen is displayed. TIBCO® Openspace User's Guide 235 ● You must log in to Openspace with a valid BPM username and password. See About User Access. Adding a Locale Code to the Openspace URL You can enter a locale code as part of an extended URL in Openspace. For example: https://localhost:8080/openspace/accessibility/accessibility.html?locale=en_GB If no locale is specified, Openspace defaults to American English. See TIBCO Openspace User's Guide for more information about localizing Openspace. Logging into Openspace Login to Openspace using your username and password. Out-of-the-box, Openspace recognizes the user name “tibco-admin” with a password of “secret”. This is the only user authorized to log in until another user is configured using the Organization Browser. By default, the tibco-admin resource is located in the System Resources container. Note that: ● you can configure this name using the AdminLdapName property in the de.properties file. See TIBCO ActiveMatrix BPM Administration Guide for more information. ● you can configure the password in the LDAP directory, whether you are using either the internal BPM LDAP directory or an external LDAP directory. Procedure 1. Initially, the focus is in the Username field. Type your username. 2. Press Tab to move to the Password field and type your password. 3. Press Tab to move to the Remember Me checkbox. Press Spacebar to select it. This is useful if you do not want to type in your username every time you log in to Openspace. TIBCO® Openspace User's Guide 236 4. If you want Openspace to use a different language from the default (American English or British English, depending on the default language of your browser), press Tab to Change Language and press Enter. A dialog displays the languages that are available. 5. Press the down arrow to select the language you require. Upon selection, the language changes automatically. 6. Press Tab to move to Submit and press Enter. Login Session Timeout If there is no activity in Openspace for 30 minutes, a Inactivity warning you that you are about to be logged out of Openspace. Warning message is displayed Press Tab, then Enter on either Logout to log out or Postpone to return to Openspace. If there is no activity, you are automatically logged out of Openspace after 60 seconds. Your system administrator can increase or decrease the session timeout using the sessionTimeout property in the OSProperties.properties file. See TIBCO ActiveMatrix BPM Administration Guide for more information. Logging out of Openspace You can log out of Openspace at any time. It is good security practice to close a browser when you have finished as this closes the session to the server. Procedure 1. Make sure any currently open work items are closed. 2. Navigate to Logout in the upper right-hand corner of Openspace. 3. Press Enter. When you are successfully logged out, the Login window is displayed. You can choose to log in again, go to another web site, or close the browser. Business Services Business Services displays all the business services that you can start in Openspace. A business service is a set of actions that accomplishes some sort of business function. For example, a business service could be designed to handle an incoming insurance claim. See Business Services for more information. You can categorize your business services, depending on your requirements. Categories are specified in TIBCO Business Studio at design-time. As the number of business services grows, you can increase the number of categories you have so you can organize your business services as effectively as possible. To view or start a business service, you must locate the business service you require. See Viewing Business Services. The business services list that is initially displayed is a snap shot of the business services available at that point in time. You can refresh the list to get the most recent list of business services from BPM, see Refreshing the Business Service List. You can click on a column header, use the Grid Navigation toolbar sort buttons, or use keyboard shortcuts to sort your business services. This allows you to list the business services in a desired order. TIBCO® Openspace User's Guide 237 For example, you may want to list all business services by name or version. See Configuring Sort Criteria. If you have a large number of business services, you can use the search feature to search for a specific business service. See Searching for Business Services. Business Service Columns Business service columns show you information about your business services. By default the following columns are displayed. Column Name Description Name The name of the business service. This is specified in TIBCO Business Studio at design-time. Version Identifies the version of the business service from which the instance was started. Module Identifies the module name. Category Identifies the category that the business service belongs to. Customizing Business Service Columns You may want to customize the columns that are displayed in the business service list so that only certain columns are displayed, or to change the order in which the columns are displayed. Procedure 1. From Business Services, navigate to Grid Setting ( ) located at the far right of the Search box. 2. Press Enter. The columns are displayed. See Business Service Columns for a description of the columns. The columns that are currently displayed in Business Services have a numeric value assigned to them. The numeric values indicate the columns that are displayed and their order, with 1 being the first column and 4 being the last column. You can display a maximum of 4 columns at any one time. 3. To change the columns that are displayed, you can: ● Change the existing order of the columns by renumbering them. ● Change the columns that are displayed by deleting a number from a column you do not want to display and typing a number against a new column. ● Enter any value between 0 and 99 and the columns are ordered relative to the values you have entered. A blank or negative value removes the column. 4. Press Tab, then Enter on Grid Setting ( Summary. ) to save your changes and exit Business Service Sorting Business Services Openspace allows you to sort your business services. This allows you to list the business services in a desired order. For example, you may want to list all business services by name or version. You can select one of the following to sort on: TIBCO® Openspace User's Guide 238 ● Name - the name of the business service. ● Module Name - the name of the module to which the process template belongs. ● Version - the version number of the business service. ● Category - the categories the business services are in. Procedure 1. Navigate to the column you want to sort on. 2. Press Enter on the column. By default, the column is sorted in ascending order. Press Enter again to sort the column in descending order. Viewing Business Services Categories are displayed in a tree structure. The categories are organized as follows: ● Categories to display a complete list of all your categories. ● Recent Categories to display a list of your recently viewed categories. Recent Categories displays the last 10 categories you viewed. ● Favorites to display your favorite categories. Procedure 1. Navigate to Categories, Recent Categories or Favorites. 2. To display the list, press Enter. A dialog displays your categories and business services. If no categories are defined, all the business services are listed alphabetically. If categories are defined, then initially, the focus is on the top category in the tree. 3. To navigate through the tree structure: ● To expand the currently selected category, press the Left arrow key. ● To collapse the categories, press the Right arrow key. ● To move up and down the tree, press the Up and Down arrow keys. ● Press Alt, then 1 to move to Categories from Recent Categories or Favorites. ● Press Alt, then 2 to move to Recent Categories from Categories or Favorites. ● Press Alt, then 3 to move to Favorites from Categories or Recent Categories. 4. Navigate through the tree until you find the business service you want to start. 5. Press Enter. The business service displays. Depending on your requirements, press Shift, then Tab to Start to start the business service. Adding Categories as Favorites If you have some business services that are in a category that you use frequently, you may want to add it to Favorites. This is useful as it allows you to quickly and easily find your most frequently used business services. Procedure 1. Navigate to Categories or Recent Categories. TIBCO® Openspace User's Guide 239 2. Press Enter to display the categories/business services. 3. Use the Up and Down arrows to navigate to the business service you require. 4. When the business service has focus, press A to navigate to the Add to Favorites icon ( The category is added to Favorites. ). Removing Categories as Favorites You can remove a category from Favorites. Procedure 1. Navigate to Favorites. 2. Press Enter to display a dialog containing your favorite business services. 3. Press Tab to navigate to the business service you want to remove. 4. Press Enter to select the business service you want to remove from Favorites. 5. When the business service has focus, press A to navigate to . 6. Press Enter. The category is removed from Favorites. Searching for Business Service Categories If you have a large number of business services in your list, you can use the search feature to search for a specific category. This allows you to display only the business services from that particular category. This search only displays categories, not business services. To find a specific business service in category, see Searching for Business Services. Procedure 1. Navigate to the Search box. 2. In the Search box, type the search criteria you want to search for. You can either type in the category you are looking for exactly as at appears in the tree or you can use the * as a wild card character. A single * represents one level of the tree and two asterisks (**) represent all levels of the tree. Therefore if you had the following tree structure CatA > CatB > CatC and you are searching for CatC, you could type either: ● CatA/CatB/CatC, or ● */*/CatC You must not end a search with an * however, as this would not return any categories. 3. Press Enter. Business Services displays the business services that are listed in the category you specified. The results of the search only display the category you are looking for. It does not display the hierarchical tree structure of the categories. This means that you cannot navigate through the tree from Search. You must go back to either Categories, Recent Categories or Favorites to do this. TIBCO® Openspace User's Guide 240 Searching for Business Services If you have a large number of business services in a category, you can use the search feature to search for a specific business service. This allows you to display specific business services from that particular category. Procedure 1. Ensure the business service list has focus. 2. Press Enter to move to the Action toolbar. 3. Press Tab to move the first Search box. 4. Use the Up and Down arrows to select a column indicator to search on from the drop-down list. You can search on All Columns, Name, Version or Module. See Customizing Business Service Columns for more information. 5. Press Tab to move to the next box. Use the Up and down arrows to select an operator that is appropriate for your search. You can choose: Option Description Contains Matches if a specified column contains the search text value (case is ignored) Case is ignored. Contains (case sensitive) Matches if a specified column contains the search text value Exact match Matches if a specified column exactly matches the search text value (case is ignored) Exact match (case sensitive) Matches if a specified column exactly matches the search text value (case sensitive). (case sensitive). 6. Press Tab to move to the next box. Type the search criteria you want to search for. 7. Press Enter. Fields that match the search criteria are highlighted. Use the Tab key to move between highlighted fields. 8. Pressing Escape or the Clear Search icon ( )returns you to your normal view. Refreshing the Business Service List The business service list that is initially displayed is a snap shot of the business services available at that point in time. You can refresh the list to get the most recent list of business services from BPM, wherever you are in Business Services. Navigate to the Refresh icon ( ) in Business Services. Press Enter and Openspace refreshes. Starting a Business Service The business service does not generate work items. The user who starts the business service completes the user interface pages for the business service and then the business service starts an instance of a process. A couple of things happen when you start a business service. ● a message is displayed in the form instanceid invoked where instanceid is a unique alphanumeric value that identifies this particular business service and ● the first user interface page in the business service is displayed. The business service is considered complete when the final user interface page has been completed. TIBCO® Openspace User's Guide 241 Procedure 1. Navigate to the category where the business service is located (for example, Categories, Recent Categories, Favorites). 2. Navigate to the business service you want to start. 3. Press Enter on the business service you want to start. The business service displays and the focus moves to Start. 4. Press Enter on Start to start the business service. The user interface pages are displayed. 5. Tab through the fields and type the information required in the fields on the user interface pages. You can press Alt then the left arrow key to close the form and return the item to its previous state. 6. Press Tab then Enter on Submit to save your changes or press Tab then Enter on Cancel to exit without saving your changes. Work Views Work Views displays your available work views and the work items listed in that work view. Work views allow you to apply filter and/or sort criteria so that only the desired work items are listed in the work view. A work item represents an action item. It relates to a task in an active process instance. A user manages the work items in their work list by performing some sort of action upon them, such as entering data on a form, forwarding the item to another user or group, saving it and placing it back in the work list for further action at a later time, or by “submitting” it (completing the required action and sending it on to the next task in the process).You can also sort work items so that they are displayed in the order you want them displayed. ● You cannot create work views in Openspace (Accessible) but, work views created in Openspace are displayed in the Work View drop-down list. ● Public work views are only displayed if you have loaded them in Work Views. See TIBCO Openspace User's Guide for more information. From the Work View drop-down list, you can select the work view you want. Selecting a work view displays the list of work items in that view. The first work item in the list is automatically selected. You can specify whether you want your work items in ascending or descending order. By default, work items are sorted in ascending order. Press Enter on Sort Ascending ( ) or Sort Descending ( ), depending on your requirements. You can use the following actions to process your work items. Action Description Displays a summary of the work item details. Opens work items. Open next available work item. Automatically open next work item. Cancel work items. TIBCO® Openspace User's Guide 242 Action Description Skip work items. Pend work items. Change work priority. Allocate work item to yourself. Re-offer work items. Allocate work items to users in an offer set. Displays hidden work items. The work item list that is initially displayed is a snap shot of the work items available at that point in time. You can refresh the list to get the most recent list of work items from BPM, see Refreshing Work Items on page 244. If you have a large number of work items in your list, you can use the search feature to search for a specific work item, see Searching for Work Items on page 244. Work Item Columns Work item columns show you information about the work items in your list. By default, the following columns are displayed: ● Name ● Description ● State ● Id ● Version ● Priority ● Start Date ) in the To display the data in all the columns for a work item, navigate to Work Item Summary ( Action toolbar. See Displaying Work Item Summary. Press Enter to display the Work Item Summary. The following table describes all the work item columns you can view. Column Name Description Name The name of the user task associated with the work item. This is specified in TIBCO Business Studio at design-time. Description The label of the user task associated with the work item. This is specified in TIBCO Business Studio at design-time. ID A unique number identifying the work item. TIBCO® Openspace User's Guide 243 Column Name Description Priority A numeric value indicating the relative importance of the work item. For more information, see Changing Work Item Priority. Version Indicates how many times the work item has changed state. The version number starts at 0 when the work item is created, and is incremented by 1 each time it changes state. State The work item’s current state. See Work Item State. Distribution Strategy Describes the method used to distribute the work item when it was originally created, either offered or allocated. Start Date The scheduled date and time specified for the work item. Example: 2008-08-30 15:00:00. If no scheduled date and time has been specified for the work item, the column is empty. Target Date The date and time the work item is scheduled to be completed. Example: 2012-08-30 15:00:00 Process Name The name of the process from which the work item was created. Process Description A description of the business service from which the work item was created. This is specified in TIBCO Business Studio by defining a data field called AMX_PROCESSDESC and adding it to the process at design-time. Process Instance ID A unique alphanumeric value identifying the process instance from which the work item was created. Attr1 - Attr14 These fields are used to contain data that is associated with a work item. They are specified in TIBCO Business Studio. Once these fields are specified they can be used to filter the work items in your work item list. See the TIBCO Business Studio BPM Implementation Guide for more information about specifying work item attributes. Customizing Work Item Columns You may want to customize the columns that are displayed in the work item list so that only certain columns are displayed, or to change the order in which the columns are displayed. Procedure 1. From Work Views, navigate to Grid Setting ( ) located at the far right of the Search box. 2. Press Enter. The Work Item Summary is displayed. See Work Item Columns for a description of the columns. The columns that are currently displayed in Work Views have a numeric value assigned to them. The numeric values indicate the columns that are displayed and their order, with 1 being the first column and 7 being the last column. 3. You can use the Tab or Up and Down arrow keys to move between the boxes. To change the columns that are displayed, you can: ● Change the existing order of the columns by renumbering them. TIBCO® Openspace User's Guide 244 ● Change the columns that are displayed by deleting a number from a column you do not want to display and typing a number against a new column. ● Enter any value between 0 and 99 and the columns are ordered relatively to the values you enter. A blank or negative value removes the column. 4. Press Tab, Enter on Grid Setting ( ) to save your changes and exit Work Item Summary. Searching for Work Items If you have a large number of work items in your work item list, you can use the search feature to search for a specific work item. For example, you could select a column indicator of State and enter OPENED to search for all work items in your list with a status of OPENED. You must select the Use Page (Search) Filter property in the Grid Setting ( ) to enable this search. Procedure 1. Navigate to the Search box. 2. Use the Up and Down arrows to select a column indicator to search on from the drop-down list. You can search on all the work item columns. See Work Item Columns for more information. 3. Press Tab to move to the next box. Use the Up and down arrows to select an operator that is appropriate for your search. You can select one of the following: Option Description Contains Matches if a specified column contains the search text value (case is ignored). Contains (case sensitive) Matches if a specified column contains the search text value (case sensitive). Exact match Matches if a specified column exactly matches the search text value (case is ignored) Exact match (case sensitive) Matches if a specified column exactly matches the search text value (case sensitive) 4. Press Tab to move to the next box. Type the search criteria you want to search for. 5. Press Tab to and press Enter. Fields that match the search criteria are highlighted. Use the Tab key to move between highlighted fields. 6. Pressing Escape or Enter on the Clear Search icon ( )returns you to your normal view. Refreshing Work Items Your work views that are initially displayed are a snap shot of the work items at that point in time. You can refresh the work view to get the most recent list of work items. Navigate to the Refresh icon ( ) in Work Views. Press Enter and Openspace refreshes. Displaying Work Item Summary You can display a summary of the details of a selected work item. You can view information such as, its priority or state, information about the process instance it was started from and any work item TIBCO® Openspace User's Guide 245 attributes that are set. This is useful because it allows you to quickly and easily access all the work item details, in a single place. Procedure 1. From Work Views, navigate to Summary ( ). 2. Press Enter. The Work Item Summary is displayed. See Work Item Columns on page 242 for a description of the columns. 3. You can use: ● the Up, Down, Left and Right arrow keys to move between the boxes on the Work Item Summary page. ● the Previous and Next arrows to move from one work item to the next. 4. Press Enter or Shift, then Tab to Summary ( ) and press Enter to exit Work Item Summary. Displaying Visible Hidden Work Items There are two reasons why work items in your work item list may be hidden. ● They are work items that are associated with a process instance that has been suspended. Although, you cannot suspend process instances in Openspace (accessible), process instances suspended in Openspace are also hidden in Openspace (accessible). See TIBCO Openspace User's Guidefor more information about suspending process instances. ● They are work items that have been pended, that is, a timer has been set to make them hidden until a specified date/time, or for a specified period of time (see Pending Work Items). You can display hidden work items by navigating to Show hidden ( ) and pressing Enter. Press Enter again to turn the display off. When the icon is greyed out, work items that are not hidden display. When the icon is black, only hidden work items display. Changing Work Item Priority All work items have a priority. Setting the work item priority enables you to sort your work list by priority. Also, scripts and processes can check the priority value and perform actions based on a work item’s priority. The priority is a numeric value indicating the relative importance of the work item. By default, the work item priority is 50. You can change the priority of an individual work item or multiple work items, depending on your requirements. The valid range for work item priority is 0 - 100. You must enter a value in this range or an error is displayed. To change the priority of a work item, you must log in as a user that has a privilege with one or all of the following system actions assigned to it. ● changeAllocatedWorkItemPriority-This system action enables a user to change priority on work items with a status of Allocated and that are allocated to you. ● changeAnyWorkItemPriority-This system action enables a user to change the priority on all work items. This means if you want to change the priority of a work item in your work list whose status is Allocated, but it is not allocated to you, then you must also have authorization for the changeAnyWorkItemPriority system action. System actions are configured in the Organization Modeler in TIBCO Business Studio, see TIBCO Business Studio Modelling Guide for information. TIBCO® Openspace User's Guide 246 Procedure 1. Navigate to work item list. Initially, the focus is on the first work item in the list. You can use Shift with the Up and Down arrows to select multiple work items. 2. Press Enter or Shift, then Tab. The focus changes to the Action toolbar. 3. Press the right arrow key to move to Priority ( ) and press Enter. The Set Priority for Work Item ID: n (where n is the ID of your work item) dialog displays. 4. Type a specific numeric value in the box. You can also use - or + to offset a work item by a specific numeric value. For example, an employee is away on holiday and you want to offset the priority on all their work items by 20, then enter +20. You must set the priority to a numeric value within the valid range for work item priority. The valid range is 0 - 100. 5. Either press Tab, then Enter on Set Priority to accept the value or press Tab, then Enter on Cancel to exit the dialog without saving your changes. Allocating Work Items To Yourself This function allows you to allocate one or more work items to yourself. It changes the work item’s state to ALLOCATED so that only you can work on them. The work items are removed from the lists of all other users. This function can only be used if the work items are currently being offered to you; that is, their state is OFFERED. Procedure 1. Navigate to the work item list. 2. Press Tab to the work item in the work item list that you want to allocate. You can press Shift with the Up and Down arrows to select more than one work item. Press Tab, then Enter on Select Page( ) to select all the work items on the current page. 3. Press Enter to move the focus to the Action toolbar. 4. Press the right arrow key to move to Allocate Self ( ) and press Enter. The work items are now allocated only to you, and are removed from all other user’s work item lists. Allocate Work Items to Offer Set This function allows you to allocate one or more work items to a user from the original offer set, that is, the group of users to which the work items were originally offered. Work items allocated to the original offer set can have a state of OFFERED, ALLOCATED, or PENDED. TIBCO® Openspace User's Guide 247 Procedure 1. Navigate to the work item list. 2. Press Tab to the work item in the work item list that you want to allocate. You can press Shift and use the Up and Down arrows to select more than one work item. 3. Press Shift, then Tab. The focus moves to the Action toolbar. 4. Use Shift, then Tab to move to Allocate OfferSet ( ) and press Enter. The Allocate OfferSet for WorkItem ID dialog displays. The focus is automatically in the Select resource to allocate to: box. 5. Press Shift with the Up and Down arrows to select the user. You can select more than one user. If you have selected multiple work items to allocate, the list of users displayed only includes the users that are in the offer sets of all of the work items you selected. This could possibly include zero users. 6. Either press Tab, then Enter on Allocate to accept the users you selected or press Tab and Enter on Cancel to exit the dialog without saving your changes. Result The work items will appear in the work item list of the user that you selected, with a state of ALLOCATED. Re-Offering Work Items This function allows you to change work items that are currently allocated to you (state = ALLOCATED) or that you have modified (state = PENDED), back to an OFFERED state. They are offered to the users to whom they were originally offered. Procedure 1. Navigate to the work item list. 2. Press Tab to the work item in the work item list that you want to allocate. You can press Shift and use the Up and Down arrows to select more than one work item. 3. Press Shift, then Tab. The focus moves to the Action toolbar. 4. Press right arrow key to move to Re Offer ( ) and press Enter. The work item’s state changes to OFFER, and it reappears in the work item list of the users to whom it was originally offered. If the work item’s state is PENDED, and data had been added/changed on the form when it was open, that data is retained in the work item when it is re-offered. Opening Work Items A work item represents a task in a business service. Typically, a work item has an electronic form associated with it that must be opened and filled out (some forms may only display information and will not have fields to fill out). You can then save the work item in your work item list so that it can be opened again and completed at a later time. When the form is completed, the work item is submitted so that the business service can progress, possibly resulting in another work item that represents the next task in the process. Opening a work item causes the form associated with that work item to be displayed. You can open work items by selecting one or more work items from a work item list. TIBCO® Openspace User's Guide 248 Procedure 1. Press Tab to the work item in the work item list that you want to open. You can press Shift and use the Up and Down arrows to select more than one work item. 2. Press Enter or Shift, then Tab to move the focus to the Action toolbar. 3. Move to Open ( ) and press Enter. The forms associated with the work items are displayed. See Filling in a Work Item Form on page 249. 4. Once you have finished working on the forms, press Enter to move to the action toolbar. Use the arrow keys to move to the Open Next Available icon ( ) in Work Views. This causes the next available work item to be opened in the work item list, where available means a work item that is not locked or suspended. If there is no work item currently selected, the first available work item in the list is opened. If you select , and there are no available work items, a There are currently no available work items to open for resource message is displayed. Opening a work item causes OPENED to be shown in the State column. The work item is allocated to the user who opened it and is removed from the work item lists of other users to whom the work item had been offered. If you open a work item and receive a The selected work item contains a custom form that cannot be displayed in Openspace, it means that the work item has been configured to use a user-defined form. User-defined forms cannot be displayed in Openspace. If you want to use user-defined forms, you must provide your own form identifier and render your own forms. Auto-Repeat Work Views provides an auto-repeat feature that causes the next available work item to be automatically opened after you’ve submitted a work item, where “available” means a work item that is not locked or suspended. This allows you to process work items in succession without manually opening each one. Auto repeat is automatically disabled if you are viewing a work list view. It is only available on your default work list. The auto-repeat feature works as a toggle — successive clicks of the Auto-Repeat-Open icon turns it on and off. When the feature is turned on, the Auto-Repeat-Open icon is highlighted . The auto-repeat toggle is persisted. If you log out and log in again, you do not need to reset autorepeat. To turn the auto-repeat feature on: Procedure 1. Navigate to move to the work item functions. 2. Press Tab to move to Auto-Repeat-Open ( ) and press Enter. Piling When a user task is defined in a process template, the designer specifies whether or not work items generated from that user task should be piled. If they are piled, when you cancel, close, or submit a work item generated by that user task, Openspace searches through your work list to see if there are any other work items from that user task. If it finds one, it automatically opens it. If there are no more work items, you are returned to Work Views. TIBCO® Openspace User's Guide 249 This feature allows the system to be designed so that if your job entails processing a certain type of work item, Openspace automatically opens work items of that type, without requiring you to continually select work items from your work item list — as if you are working on a pile of work items. Filling in a Work Item Form The form that appears when you open a work item is specific to your Openspace. Each company that uses Openspace creates their own forms that relate to their specific business. Your company will instruct you in properly filling out the forms that they have designed for Openspace. The following is an example of what a form may look like: Use the Tab key to move from field to field on the form. All the elements and components in accessible forms work just the same as they do in ordinary forms. However, there are changes for two of the components. You can enable accessible forms runtime during the preview by simply copying the form URL in a browser and appending it with &tibco_a11y=true. The browser then displays the form in accessible mode. A custom client application loading the forms can enable accessible mode by using the following meta definition in the host HTML page: . ● Grid panes in Openspace have an additional column at the left of the grid pane. The column shows radio buttons for single-select grid panes, and checkboxes for multi-select grid panes. When the radio button or the checkbox gains the focus, the screen reader reads out the description or the label you have provided in the form designer for the current row. When a cell in a row gains the focus, the screen reader reads out the row label along with the column heading. ● When a Date, Time, or DateTime control gains the focus, the screen reader reads out the control label along with the format for entering the date or time as applicable. If needed, you can override the default formats in the common resource bundle. For further information on how to override formats, see "Advanced Tasks" in TIBCO Forms User's Guide. For a list of common resource keys and keyboard navigation for regular and accessible forms, see "Reference" in TIBCO Forms User's Guide. Submitting Work Items Submitting a work item means that you have finished with it. If there are any fields on the form designated as “required” when the form was created, they must be filled in before Openspace allows you to submit the work item. Submitting the work item causes any information you’ve entered to be saved, then the work item is closed (and unlocked) and removed from the work item list. The process instance advances to the next task in the process, possibly resulting in another work item appearing in someone’s work item list. To submit a work item from the work item form, press Tab to Submit. TIBCO® Openspace User's Guide 250 Saving Work Items Saving a work item causes any information you have entered in the form to be saved, then the work item is closed (and unlocked) and placed back in the work item list with a state of PENDED. The work item is then available to be opened and completed at a later time. To save and close a work item form, press Tab to Close. Pending Work Items Work items can be pended, which causes them to be hidden in the work item list until a specified date/ time, or period of time has expired. The work item becomes visible again when the date/time occurs, or period of time expires. Work items can be pended only if they have a state of ALLOCATED. Procedure 1. From a work item list, press Tab to a work item that has a state of ALLOCATED. You can press Shift with the Up and Down arrows to select more than one work item. 2. Press Shift, then Enter to move focus to the Action toolbar. 3. Move to Pend ( ). 4. Press Enter. The Pend Work Item ID: n (where n is the ID of your work item) dialog displays. 5. Do the following: ● By default, Pend work item until a specific date and time is selected. If this is the option you require, press Tab to the boxes and type a specific date and time. Press Tab to move between the boxes. ● Use the down arrow to select Pend work item for a period of time. Press Tab to the boxes and type a period of time. Press Tab to move between the boxes. 6. Either: ● press Tab to Pend then press enter to pend the work items. The pended work items become hidden. There is an option to view the work items in pendhidden state, see Displaying Visible Hidden Work Items, ● press Tab, then Enter on Cancel to exist the dialog without saving your changes. TIBCO® Openspace User's Guide 251 Skipping Work Items You can select one or more work items in your work item list and "skip" them. This marks the work items as complete, removes them from the work item list, and causes the process to advance. It has the same affect as opening the work items and submitting them. To be able to skip a work item, the following must all be true: ● the work item cannot have any required data fields that are not filled in ● the work item’s state must currently be ALLOCATED. Procedure 1. Press Tab to select one or more work items that are skippable. You can press Shift with the Up and Down arrows to select more than one work item. 2. Press Shift, then Tab to move to the Action toolbar. 3. Press Shift, then Tab to move to the Skip icon ( ). If the task in the process definition is not skippable, or if the work item does not exist any more (for example, your work item list has not been refreshed since the work item was submitted by someone else), an error message is displayed: Unable to skip all of the selected work items(s). Items may no longer exist or some may not allow skip. Refresh the list to view any changes. When the work item is successfully skipped, it is submitted and removed from your work item list. Canceling Changes Once a work item is opened and data is entered or changed on the work item form, you can cancel those entries/changes and return the work item to the state it was in when the work item was opened. This can be done in two ways: ● From the work item form - press Tab to Cancel. The work item is closed and returned to the work item list without saving the changes. ● From the work item list - To close a work item from the work item list, use Tab to select the work item in the work item list, then press Shift, then Tab to move to the Action toolbar. Press Tab to move to the Cancel icon ( ). ● The intention of Cancel is for an administrator-type user to be able to forcibly close a work item left open by another user. This causes any data entered or changed by the user who opened the work item to be lost. ● The work item form that was opened by the user who originally opened the work item is not closed by using Cancel. The form must be manually closed from the workstation from which it was opened. Work Item Filter Criteria Openspace allows you to configure filter criteria for either/or work items in your work list or work views. This allows you to filter the list of work items in your work list or work view so that only some of the work items are shown, rather than all of them. Filtering allows you to display only the work items you are interested in. For example, you may only be interested in work items that arrived in the work item list after Dec. 15, 2007. You can filter the list so that only those work items are shown. You must deselect the Use Page (Search) Filter property in the Grid Setting ( ) to enable this filter. Filtering work items involves building a “filter expression” that is applied to all work items. If the work item satisfies the filter expression (for example, the work item has a state of OFFERED), it is shown in TIBCO® Openspace User's Guide 252 the work item list; if it does not satisfy the filter expression, it is not shown in the list (and is not downloaded from the server). The way in which you enter a value depends on the data type for the column indicator you have selected. See Value Data Types and DateTime Data Types. Specifying a Work Item Filter Expression You must create a work item filter expression to filter your work items. Prerequisites You must deselect the Use Page (Search) Filter property in the Grid Setting ( item filter. ) to specify a work Procedure 1. Navigate to the Filter box. 2. Use the Up and Down arrows to select a column indicator to search on from the drop-down list. You can search on any work item column. See Work Item Filter Attributes for more information. 3. Press Tab to move to the next box. Use the Up and down arrows to select an operator that is appropriate for your search. 4. Press Tab to move to the next box. Type the search criteria you want to search for. You can use wild card characters and you can use multiple wild card characters. See Wild Card Characters. 5. Press Tab to and press Enter. 6. Pressing Escape or Enter on the Clear Search icon ( )returns you to your normal view. Wild Card Characters The wild card characters ’*’ and ’?’ can be used when filtering on text attributes (work item name, description, etc.) — wild card characters cannot be used with any other attribute type. The ’*’ and ’?’ characters are evaluated as follows: ● ‘*’ matches zero or more of any character. For example: “bo*” matches anything beginning with “bo”. For example, “bo”, “bobbl”, “boulton_anne”, etc. “s*s” matches anything beginning with “s” and ending with “s”. For example, “ss”, “sues”, sid_lewis”, etc. “*s” matches anything ending with “s”. For example, “franks”, “ls”, “martha_lyons”, etc. ● ‘?’ matches any single character. For example: “bill?” matches anything beginning with “bill”, plus one more character. For example, “bills”, “bill5”, “billh”, etc. “c?ndy” matches “cindy”, “candy”, “c3ndy”, etc. Also note that: ● all character matching is case sensitive. ● you can use multiple wild card characters. Work Item Filter Attributes Selecting filter attributes involves choosing the attributes upon which you want to filter the items, then entering a value for each attribute. For example, you could select the priority attribute when filtering TIBCO® Openspace User's Guide 253 work items, then enter a value of 1 - all work items with a priority of 1 are returned from the server and displayed in the work item list. The following table describes the work item attributes you can filter on. Attribute Name Description Data Type Name The name of the user task associated with the work item. This is specified in TIBCO Business Studio at design-time. Text Process ID A unique alphanumeric value identifying the process which is generated when a process is created. Text Process Name The name of the process from which the work item was created. Text Process Instance ID A unique alphanumeric value identifying the process instance from which the work item was created. Text Process Description A description of the business service from which the work item was created. This is specified in TIBCO Business Studio by defining a data field called AMX_PROCESSDESC and adding it to the process at design-time. Text Description The label of the user task associated with the work item. This is specified in TIBCO Business Studio at design-time. Text State The work item’s current state. See Work Item State. Enumeration ID A unique number identifying the work item. Text Priority A numeric value indicating the relative importance of the work item. For more information, see Changing Work Item Priority. Numeric Start Date The scheduled date and time specified for the work item. Example: 2008-08-30 15:00:00. If no scheduled date and time has been specified for the work item, the column is empty. DateTime Target Date The date and time the work item is scheduled to be completed. Example: 2012-08-30 15:00:00 DateTime Distribution Strategy Describes the method used to distribute the work item when it was originally created, either offered or allocated. Enumeration TIBCO® Openspace User's Guide 254 Attribute Name Description Data Type Attr1 - Attr14 These fields are used to contain data that is associated with a work item. They are specified in TIBCO Business Studio. Once these fields are specified they can be used to filter the work items in your work item list. See: #1, #5: Numeric #6, #7: DateTime All others: Text ● the TIBCO Business Studio BPM Implementation Guide for more information about specifying work item attributes. ● Localizing Work Item Attribute Display Names for information about localizing work item attributes. Value Data Types When configuring filter critera for specific attributes, the value entered in the Value field must match the data type for the attribute selected. The following describes the valid data types: Data Type Description Numeric Consists of one or more of the numbers 0-9. Used for things like work item ID and priority. The data entry field for numeric values will not allow you to enter any characters other than numbers. Text Consists of any number of letters, numbers, or special characters (e.g., #, $, etc.). Used for things like process instance ID and work item description. Filtering on text is case sensitive. Note that text attributes are the only attribute types with which you can use wildcard characters. For more information, see Wild Card Characters on page 252. DateTime Data Types When configuring filter criteria for dates and times attributes, they must be specified a certain way. ● Dates can be entered using the date picker, which is the Calendar icon to the right of the date field. Clicking on the Calendar icon displays a calendar from which you can choose the desired date — the selected date is automatically entered in the date field. ● Times are optional. If entered, they must be entered manually, in the following format: hh:mm:ss.nnn where: ● hh = hour (using the 24-hour clock) ● mm= minute ● ss = second For example: 15:30:00 If the time is not specified, Openspace assumes “all times” for the specified date. For example, if you specified “Start Date = 2008-10-04”, with no time, it will return all work items that were started on Oct. 4, 2008, regardless of the time they were started. TIBCO® Openspace User's Guide 255 If desired, you can enter just a portion of the time, starting from the left. For instance, you can enter just "10" in the first of the time fields — this means "all times that begin with 10 o’clock". Process Views Process Views displays columns that show you information about the process templates and process template instances in your list. From Openspace (accessible) you can do the following: ● view the process templates and process template instances ● audit the process template instances ● filter your list of process templates You cannot start, suspend, migrate, cancel or administer process instances from Openspace (accessible). The left-hand column lists the process templates and the right-hand column displays the details about the process instances started from the selected process template. Initially, the focus is on the first process instance in the list. Press Enter on the process template to display the process template details. Process Views Columns describes the information that is displayed about process templates and process instances, by default. The status of a process determines what stage it has reached in the process. A process can have various states. For example, if a process has been started it will have a status of pi_started. For an explanation of each of the possible states of a process, see Process Instance State. You can specify whether you want your process instances are in ascending or descending order. By default, process instances are sorted in ascending order. Press Enter on Sort Ascending ( ) or Sort Descending ( ), depending on your requirements. The process template list that is initially displayed is a snapshot of the process templates available at that point in time. You can refresh the list to get the most recent list of processes from BPM, see Refreshing the Process Template List. If you have a large number of processes in your list, you can use the search feature to search for a specific process, see Searching for Process Templates. Process Views Columns The Process Views page is divided into columns that show you information about your process templates and process instances started from the process templates. The following table describes the information that is displayed by default about process templates: Column Name Description Description A description of the process template. This is defined in TIBCO Business Studio at design-time. Version Identifies the version of the process template. Module Identifies the module name. You can sort and filter the list of process templates using Description or Version. See Process Templates Filters and Configuring Sort Criteria for more information. If an instance of a process is started, the columns in the right-hand pane show you information about the process instances in your list. TIBCO® Openspace User's Guide 256 Column Name Description Id A unique alphanumeric value identifying this particular process instance. State Indicates the current status of the process instance, see Refreshing the Process Template List . Priority This is a numeric value that has been assigned to the process instance by an administrator. The numeric value assigns a relative importance to the process instance, which allows users to prioritize their work. Starter The username of the Openspace user who started this particular process instance. Start Time The date and time the process instance started. Process Instance State The state of a process determines what stage it has reached in the process. A process instance can have various states. The State column in Process Views indicates the process instance’s current state. The following table describes the possible states and their meanings: State Description pi_starting This is a transitory state between the time a process instance start has been initiated and the actual starting of the process instance. The amount of time it takes to start a process instance depends on the amount of system resources available and the current load on the system. pi_started The process instance has started. pi_completed The process instance has been completed. pi_suspending This is a transitory state between the time a process instance suspension has been initiated and the actual suspension of the process instance. The amount of time it takes to suspend a process instance depends on the amount of system resources available and the current load on the system. pi_suspended The process instance has been suspended. pi_resuming This is a transitory state between the time a process instance resume has been initiated and the actual resumption the process instance. The amount of time it takes to resume a process instance depends on the amount of system resources available and the current load on the system. pi_cancelling This is a transitory state between the time a process instance cancel has been initiated and the actual cancellation of the process instance. The amount of time it takes to cancel a process instance depends on the amount of system resources available and the current load on the system. TIBCO® Openspace User's Guide 257 State Description pi_active_while_cancelling* The sub-process instance was active when its cancellation was initiated by a cancellation event handler, and is now waiting for the cancellation to complete. (There may also be compensation handlers that are reversing or undoing previously executed activities before the status can be changed to pi_cancelled.) pi_suspended_while_cancelling* The sub-process instance was suspended while it was being cancelled by a cancellation event handler. Typically, a sub-process instance has a state of pi_active_while_cancelling upon initiation of the cancellation event handler, but at that point you can suspend the sub-process instance with the intention of fixing a possible error before the sub-process instance changes to the pi_halted_while_cancelling state (see below). And of course, if the sub-process instance is suspended (and an issue resolved), it must be resumed so the graceful cancellation of the sub-process can continue to completion. pi_halted_while_cancelling* The sub-process instance was halted due to a failure in the cancellation event handler business logic. Typically, a sub-process instance has a state of pi_active_while_cancelling upon initiation of the cancellation event handler, but then may fail (for example, the handler cannot find an external resource or a dynamic sub-process), at which point its state changes to pi_halted_while_cancelling. If the state changes to pi_halted_while_cancelling, you can use one of the available functions to progress a halted process instance (for information about those functions, see Progressing Halted Processes), and ideally get back to a pi_active_while_cancelling state so that the graceful cancellation of the sub-process can continue to completion. pi_cancelled The process instance has been cancelled. pi_halted The process instance has halted. pi_failed The process instance has failed. *Sub-processes instances can be cancelled in a "cascading" fashion, which causes them to be cancelled from the "bottom up". This is done using a "cancellation event handler." When cancelled in this way, the sub-process instances can take on one of the following states as described above. For more information about cancellation event handlers, see the TIBCO Business Studio Modeling User's Guide. ● pi_active_while_cancelling ● pi_suspended_while_cancelling ● pi_halted_while_cancelling TIBCO® Openspace User's Guide 258 Refreshing the Process Template List The Process Template list that is initially displayed is a snap shot of the process templates available at that point in time. You can refresh the list to get the most recent list of process templates from BPM. Navigate to the Refresh icon ( ) in Process Views. Press Enter and Openspace refreshes. Searching for Process Templates If you have a large number of process templates in your list, you can use the search feature to search for a specific process template instance. Procedure 1. Ensure the focus is on the Process Template list. 2. Press Enter to move to the Action toolbar. 3. Press Tab to move to the Search box. 4. Press the Up and Down arrows to select a column indicator to search on from the drop-down list. You can search on ID, State, Priority, Starter or Start Date. See Process Views Columns for more information. 5. Press Tab to move to the next box. Use the Up and down arrows to select an operator that is appropriate for your search. Option Description Contains Matches if a specified column contains the search text value (case is ignored). Contains (case sensitive) Matches if a specified column contains the search text value (case sensitive). Exact match Matches if a specified column exactly matches the search text value (case is ignored). Exact match (case sensitive) Matches if a specified column exactly matches the search text value (case sensitive). 6. Press Tab to move to the next box. 7. Tab to the Search icon ( ) and press Enter. Fields that match the search criteria are highlighted. Use the Tab key to move between highlighted fields. 8. Pressing Escape or Enter on the Clear Search icon ( )returns you to your normal view. Customizing Process Instance Columns You may want to customize the columns that are displayed in the process instance list so that only certain columns are displayed, or to change the order in which the columns are displayed. Procedure 1. Navigate to Grid Setting ( ). 2. Press Enter. The Process Instance Summary is displayed. See Process Views Columns for a description of the columns. The columns that are currently displayed in Process Views have a numeric value assigned to them. The numeric values indicate the columns that are displayed and their order, with 1 being the first column and 5 being the last column. You can display a maximum of 5 columns at any one time. TIBCO® Openspace User's Guide 259 3. To change the columns that are displayed, you can: ● Change the existing order of the columns by renumbering them. ● Change the columns that are displayed by deleting a number from a column you do not want to display and typing a number against a new column. ● Enter any value between 0 and 99 and the columns are ordered relatively to the values you entered. A blank or negative value will remove the column. 4. Press Tab, then Enter on Grid Setting ( Summary. ) to save your changes and exit Process Instance Auditing Instances of Process Templates Overview Events that take place in Openspace are recorded in the audit trail. The audit trail displays a list that contains the events for the currently selected process instance. It allows you to see the events that have taken place for that process instance since it was created. The type of events that are audited are, opening a work item, submitting a work item, suspending a process instance, and so on. Events have attributes that contain information about the event. Some examples are Creation Time and Description. Some attributes are common to all events, and some are unique to a particular type of event. The columns that are shown by default in the audit trail are those attributes that are common to all events. Displaying an Audit Trail Procedure 1. From Process Views, navigate to Template and press Enter. The process templates are displayed. The focus is automatically on the first process template in the list. 2. Use the Up and Down arrows to move to the process template whose process instances you want to display. 3. Press Enter on the process template you have selected. The process instances for the process template are displayed in the right-hand pane. Automatically, the focus is on the first process instance. 4. You can use the Up and Down arrows to select the process instance whose audit trail you want to view. 5. Press Enter to move to Open ( ). 6. Press Enter on Open ( ). The audit trail provides a chronological list of events for the process instance, see Audit Trail Columns. 7. To go back to the list of process instances, press Enter to move to the Close Audit icon ( ). 8. To go back to the list of process templates, press Enter to move back through the controls back to the process template list. TIBCO® Openspace User's Guide 260 Audit Trail Columns The audit trail pane is divided into columns that display information about the events for the selected process instance. The following columns are displayed by default: Column Name Description Creation Time The date and time the event occurred. Description Describes the event that triggered the item. Name The name of the user task. Principal Name The username of the user that carried out the event. Message ID A unique identifier for the event. You can choose to display some or all of the above columns, depending on your requirements. See Customizing Process Instance Columns for more information. Process Templates Filters Filtering a list of process templates involves entering filter criteria so that only some of the process templates are shown in Process Views, rather than all of them. This allows you to display only the process templates you are interested in. For example, you may only be interested in process templates with a version number later than 2.0. You can filter the list so that only those are shown. You can only configure a filter for process templates. The Configure Filter dialog allows you to build a “filter expression” that is applied to all process templates. If the process template satisfies the filter expression (for example, the process template has a version number of 2.5), it is shown in the process template list; if it does not satisfy the filter expression, it is not shown in the list (and is not downloaded from the server). The left hand side of the Configure Filter dialog displays the column indicators you can filter on. Each column indicator has a drop-down list that allows you to select a logical operator. Logical operators allow you to choose how the specified value is to be compared to the actual values in the column. You can specify equal to, not equal to, less than, and so on. For each column indicator there is a value field where you can enter the value for the items you want returned. The way in which you enter a value depends on the data type for the column indicator you have selected. See Process Template Filter Criteria and Value Data Types. TIBCO® Openspace User's Guide 261 Process Template Filter Criteria From Templates, specific column indicators are available to filter on. Column indicators have specific data types. Name Description Data Type Name The name of the process template. This is specified in TIBCO Business Studio at design-time. Text Description The description of the process template. This is specified in TIBCO Business Studio at design-time. Text Version Identifies the version of the process template. Text Specifying a Filter Expression The Configure Filter dialog allows you to build a “filter expression” that is applied to all process templates. Procedure 1. From Process Views, navigate to Filter. 2. Press Enter. The Configure Filter dialog is displayed. 3. Press Tab to move between the fields. Use the Up and Down arrows to select a logical operator. See Process Template Filter Criteria and Value Data Types for more information. 4. Once you have set the filter expression in the Config Filter dialog, press Tab to OK, then press Enter. 5. To close the Configure Filter dialog without setting the filter, press Tab to Cancel, then press Enter. 6. To reset the Configure Filter to its default settings, press Tab, to Reset and then press Enter. TIBCO® Openspace User's Guide 262 Configuring Sort Criteria Openspace allows you to sort the information in the process template list so that they are listed in a desired order. The sort function allows you to choose which columns in the process template list to sort on and the sort direction. Name Description Name The name of the process template. This is specified in TIBCO Business Studio at design-time. Description The description of the process template. This is specified in TIBCO Business Studio at design-time. Version Identifies the version of the process template. Specifying a Sort Direction You can specify that items in a list be sorted in either ascending or descending order. You can specify a sort direction for the business services in the list. They are sorted by Name Ascending order by default. Procedure 1. Navigate to Template. 2. Press Tab to Sort and then press Enter. You can choose one of the following: ● Name Ascending. ● Name Descending ● Description Ascending ● Description Descending ● Version Ascending ● Version Descending See Configuring Sort Criteria. 3. Press the Up and Down arrows to move through the list. 4. Press Enter on the sort direction you require. TIBCO® Openspace User's Guide