TIBCO XML Canon™ User’s Guide

Software Release 3.2 February 2010

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 LICENSE.PDF) 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. TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix BusinessWorks, TIBCO XML Canon, TIBCO Turbo XML, TIBCO XML Transform, TIBCO Administrator are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. 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.TXT 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 © 1998-2010 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvii Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xix
Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxi TIBCO XML Canon Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxi Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxi Third-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xxi Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii How to Contact TIBCO Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxv

Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
TIBCO XML Canon Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Features. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Manage XML Schema Documents and Their Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 Distributed Collaboration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Enterprise-Level Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 Client Interfaces—TIBCO Product Family . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2 Running TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7
Starting the TIBCO XML Canon Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Starting TIBCO XML Canon on Windows. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Starting TIBCO XML Canon on Unix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Connecting to the TIBCO XML Canon Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Using TIBCO XML Canon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Managing Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Manage Database Transaction Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Chapter 3 Quick Tour of TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Quick Tour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Administering a Simple Program — Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Log in to TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

TIBCO XML Canon User’s Guide

iv

| Contents
Create a Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create a New User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Define Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create a Role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upload Documents Using WebDAV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 20 22 25 29

Checking Your Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Chapter 4 TIBCO XML Canon Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Web Interface Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Menu Bar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Browse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Home . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure (For ADMINISTRATOR Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO XML Canon Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Recent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DAV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Personal Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 35 36 36 37 37 39 39 40 41 41 43 44

Chapter 5 Categories, Namespaces, and Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Browsing Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Child Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Renaming Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Moving Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Working with Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Browsing Namespaces for Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching Namespaces. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Browsing and Editing DOCTYPE Public IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reports Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding Information on Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Queued and Available Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 46 46 47 48 48 51 52 53 54 56 56 57 59 61 61 62 63

TIBCO XML Canon User’s Guide

Contents v

|

Configuring a New Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Searching Documents for a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Navigating the Report Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Setting Report Display Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Running or Scheduling the Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 Using an XSLT Document as a Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Chapter 6 Using Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75
Documents Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Document Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Properties Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 History Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Relations Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Update Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Viewing Different Document Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Uploading Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Downloading Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Moving Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Deleting Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Locking and Unlocking Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Locking Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Unlocking Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Updating Document Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Managing Documents with Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Viewing Document Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Quick View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Detailed View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Validating Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Using the Differencing Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Notification Subscription . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Subscribing to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Subscribing to Stages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Viewing Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Searching for Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Accessing Documents via URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Un-authenticated URL Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Chapter 7 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115
Components Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Component Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116
TIBCO XML Canon User’s Guide

vi

| Contents
TIBCO ActiveMatrix BusinessWorks and WSDL Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Component Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Component Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Component Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Component Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120 120 121 122

Viewing Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Viewing Components in Different Document Versions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124 Searching for Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125 Editing Custom Properties for Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128

Chapter 8 Using Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Tags Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Tag Nomenclature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Tag Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Tags in the Category Detail View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Tags to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Making a Previous Document Tag Current . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reassigning Tags to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Tags to Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 131 131 132 134 134 136 138 139

Browsing By Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Browsing Categories by Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140 Tags and Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Viewing Documents via URL with Tagging Information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Category Depth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Hints for Using a URL with Tagging Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Removing Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Removing Tags from Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145 Removing Tags from Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146

Chapter 9 Working with WebDAV Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
WebDAV Support in TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 WebDAV and Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 WebDAV and Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149 WebDAV Client Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Tips for Using WebDAV Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151 Using TIBCO XML Canon with WebDAV Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Specifying a Default Upload Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Managing WebDAV Uploads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 Using Windows Web Folders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
TIBCO XML Canon User’s Guide

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Default Administrator Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Saving New Documents to TIBCO XML Canon . . . . . . . . 164 Additional Notes . . . . 162 Checking-in Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184 Chapter 11 Administering Namespaces . . . . . . . . . . . . . . . . . . . 186 DTD Doctype Public IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents vii | Configuring a Windows Web Folder . . . . . . . . . 187 Adding Namespace Presentations. 160 Using TIBCO Designer as a WebDAV Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Managing DTD DOCTYPE Public IDs . . . . . . . . . . . . 177 Purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170 Chapter 10 Administering Categories and Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 Editing Document Properties . . . . 184 Default User Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162 Checking-out Project Resources for Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189 Notes on Building XSLT Stylesheets .171 Overview . . . . . . . . . . . . . . . . . . . . . . . . . 172 Managing Categories. . . .185 Namespace Administration Overview . . . . . . . . . 173 Configuring Category Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Opening Documents from TIBCO XML Canon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173 ADMINISTRATOR Category Details panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181 Analyzing Documents for Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Purging Deleted Categories and Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 Managing Categories and Documents in the Web Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Opening Existing Projects in Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Adding Metadata to Documents . . . . . . . . . 182 Understanding Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186 Namespace Presentation . . . . . . . . . . . . . . 165 Using XMLSpy as a WebDAV Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Opening New Projects in Designer. . . . . . . . . . . . . . 183 Default Role Permissions . . . . . . . . . . . . . . . . . 177 When / Why Perform the Purge Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Synchronizing a TIBCO ActiveMatrix BusinessWorks Project . . . . . . . . . . . . . . . . . . . . . 193 TIBCO XML Canon User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 Editing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 Cloning Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Controlling Non-Authenticated URL Access to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO Administrator Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Role Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 TIBCO XML Canon User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Category. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Normal Users. . . . . . . . .and Stage-specific Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web (Un-authenticated) User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 Chapter 13 Configuring Users. . . . . . . . . . . . . . . Role Details Page in LDAP Authentication Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229 Stages Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216 217 217 218 219 219 Creating a New User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195 Roles Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii | Contents Chapter 12 Configuring Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Activating and Deactivating Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stages Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Role Members . . . . . . . . . 225 Chapter 14 Configuring Stages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Testing LDAP Queries for Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223 Managing Existing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Portal Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TIBCO Authorization Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Managing TIBCO Administrator Roles . . . . . . . . . . Assigning LDAP Users to Roles . . . . . . . . . . . 221 Creating Portal Users . . . . . . 230 230 231 232 Creating Stages . . . . . . . . . . . . . . . . Portal . . . 196 Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212 Importing TIBCO Administrator Roles Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Roles . . . . . . . . . . . . . . . . . Configuring LDAP Queries. . . . . . . . . . . . . . . . . . . . . LDAP Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Existing Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199 199 199 200 200 201 205 206 206 207 207 208 209 209 210 211 Adding New Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Default Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Users Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . LDAP Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198 Default Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stage Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . 236 Notes on Deleting and Deactivating Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269 TIBCO XML Canon User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 LDAP Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262 Managing Existing Memo Properties . . . . . . . . . . . . . . . . . . . . . . . . . 241 Authentication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents ix | Configuring Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251 Checking Database Consistency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 TIBCO Administrator Authentication. . . . . . . . . . . . . . . . . 266 JVM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248 Install Tab. . . . . . . . . 250 Server Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256 Configuring New Enumeration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Managing Existing Enumeration Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266 Specify JVM Options . . . . . . . . . . . . . . . . . . . . . . . . 237 Chapter 15 Configuring Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Internal TIBCO XML Canon Authentication Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255 Custom Properties Overview . . . . . . . . . . . . . . . . . . . . . 260 Adding New Memo Properties . . . . . 266 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240 General Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263 Appendix A Java Virtual Machine Options . . . . .265 Configuring the Java Virtual Machine . . . . . . . . .239 Policies Page Overview . . . . . . . . . . . . . . . . 252 Chapter 16 Configuring Custom Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

x | Contents TIBCO XML Canon User’s Guide .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Category Details. . . . . . . . . . . . . . . . . . . . . . . 18 The Category Tree . . . . 22 The Active and Inactive Stage’s List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Role Membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Menu Bar — Configure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Role Setup Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Stage Details Page . . . . . . . . . 19 The Company Standards Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 User Settings Section of Add New User Page . . . . . . . . . . . .Figures xi | Figures Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 Figure 15 Figure 16 Figure 17 Figure 18 Figure 19 Figure 20 Figure 21 Figure 22 Figure 23 Figure 24 Figure 25 Figure 26 Figure 27 Figure 28 XML Canon Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 WebDAV Connection Browser . . . . . . . . . . . . . . . . . . .the Configure Button . . . . . . . . . . 20 The Users Browser and Configuration Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 Active Role List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 TIBCO XML Canon Menu Bar . . . . . . . . . . . . . 27 The Rule Permissions Area . . . . . . . . . . 24 Stage List . . . . . . . . . . . . . . . . . . . . 37 Menu Bar — Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 TIBCO XML Canon Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . .the Configure Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 Rename the Stage Default . . . . . . 30 The DAV Tab . . . . . . . . . . . . . . . . . . . . . . . .the Configure Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Menu Bar — Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Menu Bar — Browse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Menu Bar — CONNECT Capability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 The Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 The Industry Standards Category . . . 19 TIBCO XML Canon Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 TIBCO XML Canon User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 Stage Transitions Example Settings . . . . . . . . . . . . . . . . . . . . 31 TIBCO XML Canon User Interface Overview. . . . . . . . . . .

. . . . . . . . . . . . . 40 Web Report Tab in the TIBCO XML Canon Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Report Display Parameters — Configure report data . 54 Moving a Category . . . . 48 Category Details Panel . . . 67 Report Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 The Namespaces Menu Bar in TIBCO XML Canon . . . . . . . . . 44 The TIBCO XML Canon Menu Bar . . . 61 Browse Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68 Report Display Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Category Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Before Selection. . . 71 Summary of Report Configuration and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Report Search Criteria. . . . . . . . . . . . . . . . 59 Report Tab on the TIBCO XML Canon Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 The Namespace Details Page. . . 65 Documents Selected for the Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Renaming a Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54 Moving a Category . . . . . . . . . 58 Editing DOCTYPE Public IDs . . . . . . . . . . . . . . 41 Personal Options Tab in the TIBCO XML Canon Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .After Selection . . . . . . . . . . . . . . . 50 Creating a Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71 TIBCO XML Canon User’s Guide . . . . . . . . . . . . . . . . . . . . 52 Category Must Be Empty Warning Message. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xii | Figures Figure 29 Figure 30 Figure 31 Figure 32 Figure 33 Figure 34 Figure 35 Figure 36 Figure 37 Figure 38 Figure 39 Figure 40 Figure 41 Figure 42 Figure 43 Figure 44 Figure 45 Figure 46 Figure 47 Figure 48 Figure 49 Figure 50 Figure 51 Figure 52 Figure 53 Figure 54 Figure 55 Figure 56 Figure 57 Figure 58 Figure 59 Figure 60 The Recent Tab in the TIBCO XML Canon Home Page . . . . . . . . . . . 69 Schedule Report Example. . . . . . . . . . . . . . . . . . . . . . . . . . . 57 The Namespaces Search Page . 39 The DAV Tab in the TIBCO XML Canon Home Page . . . . . . . . . . 43 The Account Tab in the TIBCO XML Canon Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62 Default Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Namespace Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66 Report Navigation Buttons . . 66 Report Navigation Position . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Default Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 The Reports Tab in the TIBCO XML Canon Home Page . . . . . . . . . . . . . . . . . . . . . . .

. . . .the History Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 A Document Locked by Pat . . . . . . . . . . . . . . . . . 109 The History Tab of root. . . . . . . . . . . . . . 85 Document Details Page . . . . . . . . . . . . . . . .the Relations Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Document Relationships Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Document Quick View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Component Detail Page . . . . . . . . . . . . . 80 Document Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Document Details Page . . . . . . . . . . . The Component Relationships Tab . . . . . . . . . . . . . . . . . . 120 Component Details Page . . . . . . . . 107 Document Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 The XSLT Style Sheet for Report. . . . . . . . . . . . . 126 Editing Custom Properties for Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Before Clicking on a Document To Be Moved . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Viewing Web Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 XML Differencing Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Updating Document Properties . . . . . . . . . . . . . . . . . . . . . . . . . .xsd . . . . . . . . . . . . . . . . . . . . 125 Search Results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Component Details Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .the Properties Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Figures xiii | Figure 61 Figure 62 Figure 63 Figure 64 Figure 65 Figure 66 Figure 67 Figure 68 Figure 69 Figure 70 Figure 71 Figure 72 Figure 73 Figure 74 Figure 75 Figure 76 Figure 77 Figure 78 Figure 79 Figure 80 Figure 81 Figure 82 Figure 83 Figure 84 Figure 85 Figure 86 Figure 87 Figure 88 Figure 89 Figure 90 Figure 91 Figure 92 Browsing Categories for Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128 The Tag Property in the Category Details View . . . 87 The Add Document Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Upload Document Page . 92 After Clicking on a Document To Be Moved . . . . . . . . . . . . . . . . . . . . . . . . 72 the Quick View Button under the Properties Tab . . . . . . . . . . . . . . . . . . . 99 The SchemaDOC View . . . . . . . . . . . . . . . . . 100 Viewing Differences Between Revisions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84 Document Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Function Buttons under the Properties Tab . . . . . . . . . 73 Document Details Page .The Component Metadata Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 TIBCO XML Canon User’s Guide . . . .the History Tab . . . 108 Search Results . . . . . . . . . . . . . . . . . . . . . . . . . 77 Document Details Page . . . . . . . . . . . . . . . .the Update Tab . . . . . . 122 Component Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 A Component Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . 179 The Namespace Presentation Tab . . . . . . . . . . . . . . . . . . 211 The List of Roles Including TIBCO Administrator Roles in The Roles Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205 The Membership Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Tags View in Windows Web Folder. . . . 187 Doctype Listing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Document History in TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166 The TIBCO XML Canon Category Tree in XMLSpy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 The Tag Folder under the Root Directory . . . . 196 Add New Role . . . . . . . . . 204 The Role Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 Managing WebDAV Uploads. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161 Checking-in Documents with TIBCO Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 After Clicking the Make Selected Revision Latest Button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174 The Policies Menu Bar in TIBCO XML Canon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 The ADMINISTRATOR Category Details Panel . . . . . . . . . . . . . . . 152 Specifying a Default Upload Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 Purging Selected Documents . . . . 187 The Role Details Panel — Permissions. . . . . . 165 XMLSpy Open Dialog — Switch to URL . . . . . . 173 Role Permissions of a Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 The Membership . . . . . . . . . . . . . . . . . . 186 Administrators — Namespace Browser. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133 Three Revisions under the History Tab . . . . . . . . . . . . . . . . . . . . .xiv | Figures Figure 93 Figure 94 Figure 95 Figure 96 Figure 97 Figure 98 Figure 99 Figure 100 Figure 101 Figure 102 Figure 103 Figure 104 Figure 105 Figure 106 Figure 107 Figure 108 Figure 109 Figure 110 Figure 111 Figure 112 Figure 113 Figure 114 Figure 115 Figure 116 Figure 117 Figure 118 Figure 119 Figure 120 Figure 121 Figure 122 Figure 123 Figure 124 The Tagging Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207 Role Details Page in LDAP Authentication Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158 The XML Canon Tab in TIBCO Designer . . . . . 212 TIBCO XML Canon User’s Guide . . . . . . . 135 Before Clicking the Make Selected Revision Latest Button. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 Purge Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209 The LDAP Query Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 Synchronizing a BusinessWorks Project . . . . . . . . . . . . . . . . . . . . . . . . . . 135 Select the First Revision Under the History Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163 The XML Canon Properties Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . 258 The Enumeration Property Details Page . . . . . . 224 The User Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236 The Policies Tab in the Policies Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 The Authentication Tab — LDAP Authentication . . . . . . 223 Create a Portal User in the TIBCO XML Canon Portal User Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232 The Stages Browser. . . . . . . . . . . 251 The Inconsistency Error Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250 The Status Tab in the Policies Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233 The Stage Details Page . . . . . . . . . . . . . . . . . . . . . . . 216 The Create New Portal Account Link . . . . . . . . 248 The Available Roles Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 The Custom Properties Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225 The TIBCO Administrator User Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 The Users Button in the Menu Bar . . . . . . . . . . . . . . . . . . . . . . . . 245 The Authentication Tab — TIBCO Administrator Authentication . . . . . . . . . . . . . . 241 The Authentication Tab in the Policies Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260 The Memo Property Details Page . . . . . . . . . . . . . . . . . . . . 232 The Add New Stage Page . . 263 TIBCO XML Canon User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257 The Add New Enumeration Property Page . . . . . . . . . . . . . . . . . . . . . . . . 245 The List of Candidate Organization Roots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Figures xv | Figure 125 Figure 126 Figure 127 Figure 128 Figure 129 Figure 130 Figure 131 Figure 132 Figure 133 Figure 134 Figure 135 Figure 136 Figure 137 Figure 138 Figure 139 Figure 140 Figure 141 Figure 142 Figure 143 Figure 144 Figure 145 Figure 146 Figure 147 A TIBCO Administrator Role (CanonDev) under the Membership Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249 The Install Tab in the Policies Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226 The Stage Button in the Menu Bar . . . . . . . . . . . .

xvi | Figures TIBCO XML Canon User’s Guide .

. . . . . . . . . . . . . . . . . . . . 150 Namespace Presentation Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127 URL Access to Documents . . . . . 122 Metadata for All Components that Use the Current Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Indexed Components in TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 Search Criteria . . . . . . . . . . . . . . . . . . . . 120 Metadata for All Components that are Used by the Current Component. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190 Error Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192 TIBCO XML Canon User’s Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Tables xvii | Tables Table 1 Table 2 Table 3 Table 4 Table 5 Table 6 Table 7 Table 8 Table 9 Table 10 Table 11 Table 12 Table 13 Table 14 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Component Metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Mapping WebDAV Properties to TIBCO XML Canon Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxiii Document Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Component Search Criteria . . . . . . . . . . . . . . . . . . . . . . . . 149 TIBCO XML Canon Properties . . . . . . .

xviii Tables | TIBCO XML Canon User’s Guide .

| xix Preface TIBCO XML Canon™ is a comprehensive development platform for storing and managing XML schemas and related documents such as XML. XSLT and other document types. page xxv TIBCO XML Canon User’s Guide . page xxi Typographical Conventions. page xxii How to Contact TIBCO Support. While you can store any type of document in XML Canon. Topics • • • • Changes from the Previous Release of this Guide. its integration with TIBCO Designer makes TIBCO XML Canon an ideal source control repository for TIBCO ActiveMatrix BusinessWorks projects. Additionally. it primarily serves as a central repository for developing and testing XML Schemas. page xx Related Documentation.

Information that described the installation process has been moved from the TIBCO XML Canon User’s Guide to the TIBCO XML Canon Installation guide.xx | Preface Changes from the Previous Release of this Guide This section itemizes the major changes from the previous release of this guide. see Purging on page 177. Java Virtual Machine Options. See Managing Log Files on page 12. • Installation Guide This release of TIBCO XML Canon adds a separate guide describing the installation and initial database configuration of XML Canon. • TIBCO XML Canon User’s Guide . which can be used to modify the default Java Virtual Machine (JVM) options. See Understanding Permissions on page 183 and Stage Transitions on page 230. Managing Log Files A new section details the log files associated with TIBCO • • • XML Canon. For more information. Java Virtual Machine Options Appendix A. on page 265 documents the setenv script. respectively. Expanded Permissions and Stages Documentation Two new sections give more information on how permissions function in TIBCO XML Canon and the use of transitions between stages. Purge All Administrators can now use the Purge All button to permanently remove both tagged and untagged deleted documents.

and XML schemas.w3.html http://www.org http://www.w3.org/TR/xmlschema-0/ http://www.w3.w3. For further information about these formats.Related Documentation xxi | Related Documentation This section lists documentation resources you may find useful. This document also contains lists of known issues and closed issues for this release. TIBCO XML Canon Documentation The following documents form the TIBCO XML Canon documentation set: • • TIBCO XML Canon Installation Read this manual for instructions on site preparation and installation. • Other TIBCO Product Documentation You may find it useful to read the documentation for the following TIBCO products: • TIBCO ActiveMatrix BusinessWorks™ software Third-Party Documentation TIBCO XML Canon supports WSDL documents and XSLT. TIBCO XML Canon User’s Guide Read this manual for instructions on using the product as an XML schema repository and a version controller for XML source codes. XML. TIBCO XML Canon Release Notes Read the release notes for a list of new and changed features. see: http://www.org/TR/REC-xml/ http://www.org/TR/XSLT.org/TR/wsdl/ TIBCO XML Canon User’s Guide .w3.

bold code font Bold code font is used in the following ways: • • • In procedures.2. The value of TIBCO_HOME depends on the operating system. For example: Type admin. pathnames. For example. For example on Windows systems. to indicate what a user types. to indicate the parts of the sample that are of particular interest. to indicate the default parameter for a command. MyCommand is enabled: MyCommand [enable | disable] TIBCO XML Canon User’s Guide . The value of XMLCANON_HOME depends on the operating system. on Windows systems. Incompatible products and multiple instances of the same product are installed into different installation environments. In command syntax. code examples. and output displayed in a command window. This directory is referenced in documentation as TIBCO_HOME. The value of ENV_HOME depends on the operating system. For example: Use MyCommand to start the foo process. This directory is referenced in documentation as XMLCANON_HOME. on Windows systems the default value is C:\tibco. the default value is C:\tibco. Other TIBCO products are installed into an installation environment. if no parameter is specified. the default value is C:\tibco\xmlcanon\3. For example.xxii | Preface Typographical Conventions The following typographical conventions are used in this manual. In large code samples. code font Code font identifies commands. For example. TIBCO XML Canon installs into a directory within TIBCO_HOME. Table 1 General Typographical Conventions Convention TIBCO_HOME ENV_HOME XMLCANON_HOME Use Many TIBCO products must be installed within the same home directory. filenames. The directory into which such products are installed is referenced in documentation as ENV_HOME.

Typographical Conventions xxiii | Table 1 General Typographical Conventions (Cont’d) Convention italic font Use Italic font is used in the following ways: • • • To indicate a document title. For example: Ctrl+C. The tip icon indicates an idea that could be useful. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. To introduce new terms For example: A portal page may contain several portlets. for example. For example: MyCommand [optional_parameter] required_parameter | A logical OR that separates multiple items of which only one may be chosen. The note icon indicates information that is of special interest or importance. you can select only one of the following parameters: MyCommand para1 | param2 | param3 TIBCO XML Canon User’s Guide . For example: Esc. The warning icon indicates the potential for a damaging situation. data loss or corruption if certain steps are taken or not taken. For example: MyCommand PathName Key combinations Key name separated by a plus sign indicate keys pressed simultaneously. For example. Portlets are mini-applications that run in a portal. an additional action required only in certain circumstances. for example. Key names separated by a comma and space indicate keys pressed one after the other. Table 2 Syntax Typographical Conventions Convention [ ] Use An optional item in a command or code syntax. for example. To indicate a variable in a command or code syntax that you must replace. a way to apply the information provided in the current section to achieve a specific result. Ctrl+Q.

which can be either the pair param1 and param2. or the pair param3 and param4. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 | param2} {param3 | param4} In the next example. MyCommand param1 [param2] {param3 | param4} TIBCO XML Canon User’s Guide . the command requires two parameters. For example. the following command requires two parameters. MyCommand {param1 param2} | {param3 param4} In the next example.xxiv | Preface Table 2 Syntax Typographical Conventions Convention { } Use A logical group of items in a command. And the last parameter is either param3 or param4. You can optionally include param2 as the second parameter. The first parameter must be param1. Other syntax notations may appear within each logical group. the command can accept either two or three parameters.

• For an overview of TIBCO Support.com Entry to this site requires a user name and password. and information about getting started with TIBCO Support.tibco. visit this site: http://www. visit this site: https://support.com/services/support • If you already have a valid maintenance or support contract. TIBCO XML Canon User’s Guide . you can request one. If you do not have a user name. please contact TIBCO Support as follows.tibco.How to Contact TIBCO Support xxv | How to Contact TIBCO Support For comments or problems with this manual or the software it addresses.

xxvi | Preface TIBCO XML Canon User’s Guide .

page 2 Features. page 3 TIBCO XML Canon User’s Guide .|1 Chapter 1 Introduction This chapter includes an overview of TIBCO XML Canon. Topics • • TIBCO XML Canon Overview.

and centralized administration. TIBCO XML Canon User’s Guide .2 | Chapter 1 Introduction TIBCO XML Canon Overview The XML specification is used in all areas of data exchange and in many applications. facilitate collaboration. including: • • • • XML schemas DTDs Instance documents XSLT documents Documents are stored in a secure. you can improve productivity. The document management features in TIBCO XML Canon provide control of the development process. TIBCO XML Canon allows organizations to store and manage their XML documents. enabling distributed collaboration. and maintain a competitive advantage in XML use and development. or both—to increase efficiency and reduce development time. Through XML Canon. centralizing development. schema authors can re-use existing schemas—be it entire documents. Using XML Canon. components within documents. reuse. The TIBCO XML Canon server is a comprehensive development platform that provides enterprise-level control of XML assets. collaboration. and leveraging industry standards of XML vocabularies to improve efficiency and increase productivity. share business processes with partners. The TIBCO XML Canon server’s administration domain encompasses XML developers and consumers throughout the enterprise and beyond. central repository that facilitates adaptability.

0. Administer XML documents used at the enterprise level.4 with version 3. and reuse. • Differencing creates the ability to track changes between different revisions of a document. • Staging allows an administrator to define the stages that a document will move through during its life cycle. Searching allows you to filter and gather XML documents and components. You can implement rules of acceptance to manage transitions from one stage to another. development. searching.Features 3 | Features TIBCO XML Canon features enable you to: • • • • Manage XML schema documents and their components. TIBCO XML Canon also enables you to compare revisions between any stages of a document's evolution. Manage XML Schema Documents and Their Components • Indexing automatically creates a registry of XML documents and components. attributes. You can also graphically view the relationships between elements of a TIBCO ActiveMatrix TIBCO XML Canon User’s Guide • . • Namespace Management provides a registry of corporate and industry standard namespaces. Integrate with other interfaces available in the TIBCO product family. For example. TIBCO XML Canon streamlines development by creating a registry of these documents and their components to enable browsing. allowing authorized users to approve or reject changes made to a document. TIBCO Turbo XML SchemaDOC graphically displays the structure of DTDs and XSDs. you can quickly query for vital document and component information. ensuring a smooth transition through life cycle stages. For example. Schema and Process Documentation represents the data structure of DTDs and XSDs and BusinessWorks process definitions in an intuitive and comprehensive hierarchical format. and production. and types). This feature also provides URL mapping and resolution of XML vocabularies. Changes are highlighted or underscored. Indexing is performed at two levels: the document level (schemas and DTD files) and the component level (elements. These features are discussed in sections below. you can easily compare version 1. defined stages can include testing. such as TIBCO Designer. Collaborate in a distributed development environment. • Using metadata captured by the indexing feature.

to read. remove. and access permissions are granted based on the stage and/or role. Automated Notification allows you to subscribe to relevant documents. and be automatically notified by email or on your TIBCO XML Canon home page when documents you are subscribed to change or transition a new stage. You can also customize the web interface TIBCO XML Canon User’s Guide . That is. such as • XSD schemas. check-out. administrators can set permissions to control access from both development and production perspectives. write. across your network. and versioning. and add categories as desired. Administrators can rename. In XML Canon. Web-based User Interface allows anytime and anywhere access to TIBCO • XML Canon. • Permissions enable administrators to define and regulate the life cycle requirements for documents internally and externally. The schema and process documentation is a powerful communication tool which connects different project teams and can be shared internally or published on the Internet. • • Distributed Collaboration • Collaborative Repository provides XML-centric source management. with more detail. • Reporting generates customized reports using filtering criteria and configuration capabilities. These reports can be permission-controlled or made public to all users. search.4 | Chapter 1 Introduction BusinessWorks project. • Categories offer a hierarchical perspective that visually represents and analyzes the structure and status of documents within the repository. Unix. permissions are set based on the life-cycle stage or on the category level. and Linux platforms. along with control of XML documents that includes check-in. or a combination of rights. Document and Component Relationship Tracking allows you to track and view the relationships between documents and their components. the relationships between components within a schema as well as their relationships to other documents. and delete documents based on the permissions set by the administrator. and reuse schema components that are part of corporate vocabularies and industry standards. • Standards Support for WebDAV (Web-based Distributed Authoring and Versioning) allows you to access TIBCO XML Canon category and directory structure with a variety of DAV-enabled third party applications across Windows. Mac OS X. Data Dictionary and Type Management provides tools to manage.A user may have a right. index. TIBCO XML Canon also tracks.

Features 5

|

using Cascading Style Sheets, creating a familiarized working environment to suit the needs of organization. •
Detailed Document View shows document histories and compares versions of

the document.

Enterprise-Level Administration

Management and Administration Platform provides centralized control across

the TIBCO XML Canon enterprise, allowing administrators to customize the web-based interface; coordinate policies for document management; create users and roles; control permissions, email and web notifications; manage configurable metadata; control document and component searches; and configure secure access. TIBCO XML Canon easily stores and manages all enterprise XML vocabularies and XML-based projects. •
Security gives the TIBCO XML Canon administrator the ability to manage

authentications and authorizations, permissions, and user roles at the administration level. Individual users are assigned to roles, which have associated read, write, and delete permissions for documents within a particular stage and/or category. •
Customization allows you to brand and implement TIBCO XML Canon to reflect the needs of an organization.

Client Interfaces—TIBCO Product Family
TIBCO XML Canon works with TIBCO ActiveMatrix BusinessWorks, easily integrating with the TIBCO Designer™ environment. TIBCO Designer is an easy to use graphical user interface for designing and creating integration project configurations. TIBCO Designer uses a WebDAV plug-in to store and open projects from TIBCO XML Canon. When you check a document into XML Canon using TIBCO Designer, you can associate additional metadata (such as a revision label, stage, or comment) that is used with TIBCO ActiveMatrix BusinessWorks project documents. For more information about using TIBCO XML Canon with TIBCO Designer, see Using TIBCO Designer as a WebDAV Client on page 161.

TIBCO XML Canon User’s Guide

6

| Chapter 1

Introduction

TIBCO XML Canon User’s Guide

|7
Chapter 2

Running TIBCO XML Canon

This chapter describes the steps used to start and run TIBCO XML Canon for the first time, and how to connect to the web interface.

Topics
• • • Starting the TIBCO XML Canon Server on page 8 Connecting to the TIBCO XML Canon Web Interface on page 10 Managing Log Files on page 12

TIBCO XML Canon User’s Guide

8

| Chapter 2

Running TIBCO XML Canon

Starting the TIBCO XML Canon Server
TIBCO XML Canon acts as a Windows service or Unix daemon. You connect to the TIBCO XML Canon using a web browser.

Starting TIBCO XML Canon on Windows
There are three ways to start the TIBCO XML Canon service on Windows: from the Start menu link, the command prompt, or the Services tool.
Start Menu

To start TIBCO XML Canon from the Start menu, apply steps below: Start > Programs > Tibco > TIBCO XML Canon 3.2 > Start TIBCO XML Canon 3.2

Command Prompt

To start TIBCO XML Canon from a command prompt, type the following command:
net start xmlcanonENV_Name

where ENV_Name is the environment name (selected during the TIBCO XML Canon installation). For example:
net start xmlcanonTIBCO

To start TIBCO XML Canon from a command prompt, go to the installation directory and start the TIBCO XML Canon executable file:
>cd

TIBCO_HOME\xmlcanon\3.2\tomcat\bin

>startup.bat

Services

To start TIBCO XML Canon using the Services tool, follow the instructions below: a. Go to Control Panel > Administrative Tools > Services. b. Right-click the service name Apache Tomcat XMLCanon and select Start. The environment name (selected during the TIBCO XML Canon installation) is appended to the end of the XML Canon service name. For example, Apache Tomcat XMLCanonTIBCO.

TIBCO XML Canon User’s Guide

Starting the TIBCO XML Canon Server 9

|

Starting TIBCO XML Canon on Unix
Follow the instructions below to start TIBCO XML Canon on Unix platforms: 1. Log in to a Unix server as root. 2. Run the following script:
TIBCO_HOME/xmlcanon/3.2/tomcat/bin/startup.sh

Starting XML Automatically To start TIBCO XML Canon on Unix automatically when booting, follow the instructions below: 1. Log in to a Unix server as root. 2. Run the following script:
TIBCO_HOME/xmlcanon/3.2/tomcat/bin/xcdsetup

3. Follow the prompts. The setup script xcdsetup will install TIBCO XML Canon start-up scripts under the init.d directory of your system.

TIBCO XML Canon User’s Guide

10

| Chapter 2

Running TIBCO XML Canon

Connecting to the TIBCO XML Canon Web Interface
Follow these instructions to connect to TIBCO XML Canon from a web browser: 1. Launch a web browser. 2. Specify the URL of the TIBCO XML Canon server in the following format:
http://<hostName>:<portNumber>

where <hostName> is the name of the machine which hosts TIBCO XML Canon, <portNumber> is the Tomcat server port number that you specified during the database configuration (8080 is the default port). For example:
http://xmlcanon:8080

When accessing TIBCO XML Canon from the outside of the same subnet, use:
http://xmlcanon.example.com:8080

The port number is not required by XML Canon URL if it is set to 8080.

3. Use the XML Canon administrator user credentials created during the database configuration to get initial access to the server. See Configuring the Database in TIBCO XML Canon Installation. Note that the administrator credentials can be changed after the initial login. The user name and password entries are case-sensitive.

Figure 1 XML Canon Login

The next section gives a quick glance at the TIBCO XML Canon user interface.
TIBCO XML Canon User’s Guide

password and the user’s role membership. Quick Tour of TIBCO XML Canon. Working with WebDAV Clients. • • • • • Go to Chapter 3. • TIBCO Designer automates the locking and unlocking tasks during the check-out and check-in processes.Connecting to the TIBCO XML Canon Web Interface 11 | Using TIBCO XML Canon Explore some of the features offered by the TIBCO XML Canon user interface: • After login. This includes username. and types if a document is in an XML schema format. and uploaded to XML Canon using a WebDAV client. TIBCO XML Canon User’s Guide . The lock and unlock process can be handled directly from the WebDAV client if this WebDAV client has a lock feature. on page 147 for more information on WebDAV clients. See Chapter 9. such as DTD (Document Type Definition) or XSD (XML Schema Definition). you will see a menu of options at the top of your XML Canon home page. You must lock a document from the XML Canon web interface before downloading it and making changes using a WebDAV (Web-based Distributed Authoring and Versioning) enabled client. Working with WebDAV Clients. You can view. validate. attributes. you can simply edit the content of the document and check it back into XML Canon when you are finished editing. saved. Grant access to other users. and download documents within TIBCO XML Canon categories by searching and browsing or through a category browser. Select Browse > Categories from the menu bar to open the XML Canon category browser. You can also search and browse its components such as elements. Remember to unlock the document from the XML Canon web interface again once all the changes have been made. You can define or create categories in the category browser. See Locking and Unlocking Documents on page 94 for more information on document locking. on page 15 for a tutorial on TIBCO XML Canon. log in as an administrator and select Configure > Users from the menu bar to create new user profiles. After defining the categories. After you check-out a document in one of these applications. on page 147 for more information on WebDAV clients. Such features can be applied in TIBCO Designer. See Chapter 9. you can add documents the XML Canon web interface or a WebDAV-enabled client such as TIBCO Designer or a third-party WebDAV client. The category browser serves as containers for assets (documents and child categories) stored in XML Canon and are the equivalent to directories on a local file system.

For more information.0-doc/logging.org/logging-log4j/Log4jXmlFormat.properties file.html.apache. see http://wiki.log file contains messages related to security in TIBCO XML Canon. obfuscation.date.properties file. depending on the message type.log. Security Messages The canon_security_info. and contains all messages related to the XML Canon server: XMLCANON_HOME\tomcat\work\Standalone\localhost\_\log\xmlLog. TIBCO XML Canon Messages The webLog.xml file is the primary log file for the XML Canon server. and SSL: XMLCANON_HOME\tomcat\logs\canon_security_info.org/tomcat-6.date. Apache Tomcat Messages Apache Tomcat prints status messages to its catalina logger.log The content and settings of the canon_security_info. By default. see http://tomcat.xml file is determined by the configuration settings in XMLCANON_HOME\tomcat\webapps\ROOT\WEB-INF\web. For help configuring this file. contact TIBCO Support.xml.log are configured in the XMLCANON_HOME\tomcat\lib\log4j. Log files take the format of catalina. Catalina log files are located in: XMLCANON_HOME\tomcat\logs\catalina. logging to webLog.apache.12 | Chapter 2 Running TIBCO XML Canon Managing Log Files TIBCO XML Canon log messages are printed to one of several log files.xml is not enabled. such as encryption. For more information.log The content and settings of the catalina log files are configured in the XMLCANON_HOME\tomcat\conf\logging.xml The content of the webLog. TIBCO XML Canon User’s Guide .

Set the transaction log recovery model to SIMPLE.Managing Log Files 13 | Manage Database Transaction Logs Databases often keep transaction logs. they may become unmanageable in a short period of time. Back-up and checkpoint the transaction log. otherwise. TIBCO XML Canon User’s Guide . You need to perform one of the following tasks to manage the transaction log: • • • Intermittently run an SQL script to prune the transaction logs. They need to be managed appropriately.

14 | Chapter 2 Running TIBCO XML Canon TIBCO XML Canon User’s Guide .

Topics • • Quick Tour. page 16 Checking Your Work.| 15 Chapter 3 Quick Tour of TIBCO XML Canon This chapter provides a tutorial on using and administering TIBCO XML Canon. page 32 TIBCO XML Canon User’s Guide .

and stages. page 22 Create a Role. It goes through each task on the list above with a simple example program scenario. page 29 You must complete the tasks in the order presented here. page 20 Define Stages. you must have a valid administrator username and password. categories. TIBCO XML Canon User’s Guide . These tasks include: • • • • • Creating categories with XML documents or child categories Creating users Using stages to manage the document development life cycle of documents stored in the server Creating user roles for access control Uploading documents to the TIBCO XML Canon server using a WebDAV client This tutorial takes approximately 30 minutes to complete. This setup process is divided into the following tasks: • • • • • • Log in to TIBCO XML Canon. This exercise is designed for users who belong to the TIBCO XML Canon administrators role. This walk-through teaches you how to carry out basic tasks as an XML Canon administrative user. page 17 Create a Category. Administering a Simple Program — Overview This exercise is intended for TIBCO XML Canon administrators. You will assign roles and permissions in order to control access to documents and administrative tasks. you will configure XML Canon through the creation of users. In this example program. page 17 Create a New User. If you are logging in to the TIBCO XML Canon server for the first time. page 25 Upload Documents Using WebDAV. roles. then you must use the administrative credentials that you created during software installation.16 | Chapter 3 Quick Tour of TIBCO XML Canon Quick Tour The step by step exercise provided in this chapter familiarizes you with the main features and functions of TIBCO XML Canon. Before you begin.

— When accessing XML Canon outside the subnet of NetBIOS.Quick Tour 17 | Log in to TIBCO XML Canon Log in to the XML Canon web interface: 1.com:8080 — When accessing XML Canon from the same subnet as the NetBIOS domain. the port is 8080). To connect to TIBCO XML Canon for the first time. Open a web browser and enter the URL of your TIBCO XML Canon server login page: http://HostName:Port where HostName is the name of your XML Canon server. Create a Category Categories are the primary organizational unit within the TIBCO XML Canon server. The XML Canon Login page appears. you will create two categories. A menu of options appears at the top. When uploading a document into TIBCO XML Canon. the Home Page opens. Hover the mouse pointer over the Browse button in the menu bar. you must select the category in which it will be stored. Three options appear below Browse. In this example program.com.example. Click the Categories option (see Figure 2). xmlcanon. Note that the username and password are case-sensitive Click the Submit button. Upon successful login. and Port is the port used to access the server. enter the administrator username and password you established during the installation. 1.example. the HostName is the name of the computer where XML Canon is installed. They are analogous to directories in a file system. For example. the HostName is an IP address or fully qualified host name. specified during installation (by default. 2. For example: http://xmlcanon. TIBCO XML Canon User’s Guide .

Figure 3 The Category Tree In the upper-right-hand corner of the category tree frame. see Chapter 8. For more information on tags. Because you are using TIBCO XML Canon for the first time after installation. You can manage categories and documents from this frame. This is the server’s root category (see Figure 3). click the default category named Categories. Using Tags. Figure 4 Category Details 3. "Latest" refers to the current document version in TIBCO XML Canon. enter the name Industry click the Add child button. 2. Standards Standards and category in the category tree (see TIBCO XML Canon User’s Guide . You can now see the Industry Figure 5). To create a new category. A category details dialog opens in the right panel (see Figure 4). XML Canon allows you to tag or label particular revisions of a document at a specific point in time. on page 130. note the phrase by tag="Latest".18 | Chapter 3 Quick Tour of TIBCO XML Canon Figure 2 TIBCO XML Canon Menu Bar The category tree appears in the left-hand frame. In the New child category field. named Categories. only a single category exists. The most recent version of every document stored in TIBCO XML Canon has the Latest tag. As a revision control system.

Categories.Quick Tour 19 | Figure 5 The Industry Standards Category 4. Namespaces. see Chapter 5. From there. TIBCO XML Canon User’s Guide . which opens the Category Details panel. The category tree should now look like the example shown in Figure 6: Figure 6 The Company Standards Category Exploring Categories You can see details about the newly created categories by clicking the category name. Click the Categories folder again to add another category called Company Standards following the process described above in step 3. you can: • • • • • • • • • Rename the category Add a child category Delete the category Clone the category View category statistics Add documents from your local file system to the category Validate documents from your local file system Customize the role-level permissions associated with the category Tag the category For more information on categories. You have completed the first task of the tour. and Reports.

see Authentication Configuration on page 244. 1.the Configure Button The users browser and configuration panel appears in the left-hand frame (see Figure 8). For more information on configuring server authentication. the web user is also created by the installer. You can also configure TIBCO XML Canon to use either an LDAP server or TIBCO Administrator for user authentication. you create a new TIBCO XML Canon user. Hover your mouse pointer over the Configure button in the menu bar and click the Users button from the sub-menu (see Figure 7). see LDAP Users on page 218. TIBCO XML Canon User’s Guide . Figure 8 The Users Browser and Configuration Panel An LDAP tab appears only if you have configured LDAP authentication for your users. The new user will be able to use the TIBCO XML Canon server to develop assets for a project. This panel divides users into two categories.20 | Chapter 3 Quick Tour of TIBCO XML Canon Create a New User In this step. For more information. The admin user is set by the person who configured the server during installation. active and inactive users. Two default users are created during the installation process. Figure 7 TIBCO XML Canon Menu Bar .

Configuring Users. You are now warned that the user cannot perform an initial upload. You have now completed the task of creating a new user and are ready to move on to the next task. A warning message appears. 5. see Chapter 13. TIBCO XML Canon User’s Guide . Click the Add user button. and Password fields. For more information on user configuration. Figure 9 shows an example user profile. Figure 9 User Settings Section of Add New User Page Ignore the role membership selection for now. Click the Add New User button to create a new user profile. Email Address. Re-enter the password in the Confirm Password field. Click OK to dismiss the warning message. Define Stages for life cycle management. on page 215. notifying you that the user is not associated with a role. Full Name. 4. The Add new user page appears in the right-hand frame.Quick Tour 21 | 2. Ignore this warning and click the Continue button to finish the creation. 3. Fill in the Username. You will define a new role later in this exercise.

1. A stage represents the status of a document at a given point during its life cycle. Hover your mouse pointer over the Configure button in the menu bar and click the Stages button from the sub-menu (see Figure 10). Click on Default in the Stages panel to load its stage details page in the right-hand frame of the browser window (see Figure 12). The document can move from one stage to another stage once it meets the criteria of the entry level. You can have different revisions of a document within a stage. A Default stage is already created by the installer so that documents can be added into an initial stage if no specific stages are dedicated to the document. Figure 10 TIBCO XML Canon Menu Bar . TIBCO XML Canon User’s Guide . A TIBCO XML Canon server administrator can assign each stage with a customized role permission to control which users can access and edit documents within each stage. Figure 11 The Active and Inactive Stage’s List 2.the Configure Button You will now see a list of active and inactive stages in the Stages panel in the left-hand frame of the browser window (see Figure 11). For your pilot program. TIBCO XML Canon server provides a Stage function to facilitate the workflow and manage the life cycle of stored assets.22 | Chapter 3 Quick Tour of TIBCO XML Canon Define Stages A document (such as an XSD file) can go through numerous revisions during its life cycle. you will create two stages in TIBCO XML Canon: Development and Production.

select the radio button for Documents do not need to be well-formed. 7. After the stage is updated. leave the Default checkbox as checked. The Conformance Rules area specifies the criteria that XML documents must meet before entering into this stage. 8. In the Conformance Rules area. The Documents do not need to be well-formed option is checked by default. In the Stage name field. Select the Yes radio button next to the Active option to ensure this stage could be employed. 6.Quick Tour 23 | Figure 12 Stage Details Page 3. You can now see that the name of the Default stage has been changed to Development in the Stages panel at the left-hand frame as shown in Figure 13. This check ensures that documents edited while in the Default stage can be placed back into the Development stage. 5. In the Documents May Transition To area. Default listed in this section will be renamed Development. 4. change the name Default to Development. This means that XML documents are not required to be well-formed or valid in order to move to the stage. TIBCO XML Canon User’s Guide . Click the Update button at the bottom of the panel to save the new stage configuration. Ignore the Namespace Resolution option for now.

Click the Add New Stage button at the bottom of the right-hand frame to add the Production stage to the Active stage list. TIBCO XML Canon User’s Guide . documents need to be valid before they can enter this stage. To add another stage. Check the Development checkbox in the Documents May Transition From area. click the Add New Stage button to load the Add New Stage page in the right-hand frame. This allows documents to move from the Development stage to the Production stage when an XML document is ready for production. 14. 12. 13. 11. Because this stage will hold documents available for production.24 | Chapter 3 Quick Tour of TIBCO XML Canon Figure 13 Rename the Stage Default 9. Name the new stage as Production. 10. Click the Development stage in the Stages panel. as shown in Figure 14. Figure 14 Stage List 15. Check the Development checkbox in the Documents May Transition To area. This allows documents in the Production stage to remain in the Production stage or move back to the Development stage. You can do this by selecting the Documents must be valid radio button under the Conformance Rules area.

1. The Development stage transition settings should look like: Figure 15 Stage Transitions Example Settings For more information on stage configuration. Hover your mouse pointer over the Configure button in the menu bar and click the Roles button from the sub-menu. A role determines the member’s ability to access resources and perform functions within the server. The Active list of roles contains pre-defined roles only. LDAP Default. TIBCO Authorization Default. Configuring Stages. TIBCO XML Canon User’s Guide . These roles are created by the installer during setup and include Administrators. This configuration is done automatically. Figure 16 The Menu Bar . as shown in the figure below. Create a Role. and Web roles. as shown below. You have completed the task of creating a new user setting up stages and now you are ready to move on to the next task. They are analogous to groups in network administrative domains and LDAP. on page 229. Create a Role Roles play a crucial part in TIBCO XML Canon.the Configure Button The current roles list appears in the left-hand frame. see Chapter 14.Quick Tour 25 | You will now see that the Production stage has been checked under both Documents may transition to and Documents May Transition From areas. Portal.

Click the Add New Role button to load the Add new role setup page in the right-hand frame. users belonging to this role may belong to outside companies. In this case.26 | Chapter 3 Quick Tour of TIBCO XML Canon Figure 17 Active Role List For the purposes of this exercise. 2. you will create a role appropriate for users working on a pilot program to develop industry-wide standards. which is shown here: Figure 18 Role Setup Page TIBCO XML Canon User’s Guide .

and custom properties. Figure 19 Role Membership TIBCO XML Canon User’s Guide . — Leave the Stage-specific permissions as Default. — Set the Default category permission to Read. The Stage Specific Permissions section is used to change the role permissions for a particular stage from the default settings. Select the user created in Create a New User. select Development.Quick Tour 27 | 3. stages. Click the Add role and set members button to add Pilot as a new role in the Active list and switch to the Membership tab automatically. you would set those permissions in this section. — In the Initial Stage drop-down list. Because this role may include people from outside companies. or delete a document. policies. select CONNECT. the role must be granted with appropriate permissions on both the document's stage and the category it belongs to. write. users. from the list of available users. — Set the Tagging permission to Assign. Note that in order to read. — Set the Default stage permission to Read. 5. you do not want to grant this role the permission to delete documents in any categories. — In the Capability drop-down list. 4. If you have a stage for which you want to apply either more or less restrictive permissions. Enter information about the new role: — Enter Pilot in the Name field as the name of this role. This option prevents users in this role from carrying out administrative tasks such as configuring roles. write. write.

delete. In the Pilot role permissions drop-down list. You have now completed the task of creating a new role and are ready to move on to the final task in the quick tour. Figure 20 The Rule Permissions Area 10. You will see three pop out options. Configuring Roles. you can modify the default permissions on a category basis using the Category Details page. Click the Industry Standards category in the Category tree to open the Category Details panel in the right-hand frame. Based on the current configuration (specifically. see Chapter 12. select Read. the default category permissions). 8. However. Also see Chapter 10.28 | Chapter 3 Quick Tour of TIBCO XML Canon 6. Hover the mouse pointer over the Browse button in the menu bar. write. Click the Update permissions button to update this set of new permissions. the Pilot role has limited ability to view or work with documents stored in the Development stage in XML Canon. as shown in Figure 20. TIBCO XML Canon User’s Guide . Standards The next step is to give the Pilot role full access to documents in the Industry category. Click Update. For more information on configuring roles and administering access to documents. on page 171. 9. Click the Categories button. 7. The default category permission settings (read and write. Administering Categories and Documents. as previously defined in the Add new role page) have now been modified to grant the Pilot role complete control over documents in the Industry Standards category. Upload Documents Using WebDAV. on page 195.

the paradigm for all WebDAV tools used with TIBCO XML Canon is essentially the same: you use the tool to create a connection and then drag-and-drop files to TIBCO XML Canon server.org site: http://webdav. d. Click the Next button. Specify a name for this WebDAV connection and click the Next button. Enter your TIBCO XML Canon administrative user’s credentials and click the Ok button. g. To configure a Windows Web Folder in Windows as a WebDAV client: a. For example: http://xmlcanon. However. There are several resources describing WebDAV. including Microsoft network connection tools. One of the best resources is a FAQ at the WebDAV. It is very easy to populate a TIBCO XML Canon server with existing documents. TIBCO XML Canon User’s Guide .com:8080 e. c. Type the TIBCO XML Canon server URL. To create a connection using Microsoft network connection tools: 1.org/other/faq. which we will use in this exercise to create a connection. Select My Network Places in the Windows Start menu. Click the Next button.example. WebDAV is a set of extensions to the HTTP protocol which allows users to collaboratively edit and manage files on remote web servers. Click the Finish button. h.Quick Tour 29 | Upload Documents Using WebDAV TIBCO XML Canon uses WebDAV for communication with all clients. WebDAV stands for Web-based Distributed Authoring and Versioning. f. b.html This document answers questions such as: • • Is WebDAV an API or a protocol? Does WebDAV provide document management or workflow capabilities? There are several WebDAV tools available. Click Add a network place under Network Tasks in the left pane of the window to launch the Add Network Place Wizard.

In the TIBCO XML Canon web interface. Scroll down to the bottom of the page and click the Check All button. In the Revision label field. click the Home button in the menu bar to open your TIBCO XML Canon home page. You can include Comments and the Revision Label in these fields for now. For example. Open another Windows Explorer window in your local file system. Use the Attribute area to add metadata to documents uploaded to the server through WebDAV. 4. 6. Right-click on a local directory and select Copy from the pop-up menu. You will now see a new window showing all categories under the root category of the TIBCO XML Canon server (see Figure 21). see Browsing By Tags on page 140. enter 1. TIBCO XML Canon User’s Guide . as shown in the example below. Figure 21 WebDAV Connection Browser 2. 9.0. 3. Documents uploaded with webDAV. Click the DAV tab under your TIBCO XML Canon home page to view a list of documents uploaded through the means of the Web Folder. 8. 7. 5. For more information on the tag directory.30 | Chapter 3 Quick Tour of TIBCO XML Canon Microsoft Windows has now set up a WebDAV connection to the TIBCO XML Canon server. Note that there is also a tag directory which allows you to browse through all resources with assigned tags in XML Canon. You can find all the files you just copied from the local directory using Windows WebDAV through the means of the Web Folder under the Recent tab. Right-click on the Industry Standards directory in the WebDAV folder and select Paste from the pop-up menu.

see Chapter 6. You can now see the files uploaded with WebDAV include both a revision label and the comment you specified. You have now completed the task of uploading documents with a WebDAV client. on page 75 and Chapter 9. Working with WebDAV Clients. Return to the Recent tab. TIBCO XML Canon User’s Guide .Quick Tour 31 | Figure 22 The DAV Tab 10. 11. Using Documents. Click the Update Attributes button. on page 147. For more information about managing documents and WebDAV clients.

You can check your work now by logging out of the administrative user and logging in as a new user which you have just created in the previous exercise. you will not be able to see the Configure button in the menu bar because only the Administrator role has the privilege to configure the server. TIBCO XML Canon User’s Guide . This can only be done if the document can be validated by the TIBCO XML Canon. you can upload documents from your local file system to both Industry Standards and Company Standards categories and delete them again. To learn more about how to move documents between stages. Under the Pilot account. see Managing Documents with Stages on page 97. You can only delete documents under the Industry Standards category and cannot delete anything in the Company Standards category if you have successfully completed the previous exercise. You can also try to move a document from the Development stage to the Production stage.32 | Chapter 3 Quick Tour of TIBCO XML Canon Checking Your Work Congratulations! You have completed this tutorial. If you configured the Pilot role correctly.

Topics • • • Web Interface Overview. page 35 TIBCO XML Canon Home Page. page 39 TIBCO XML Canon User’s Guide . page 34 Menu Bar.| 33 Chapter 4 TIBCO XML Canon Web Interface This chapter describes the TIBCO XML Canon user interface.

34 | Chapter 4 TIBCO XML Canon Web Interface Web Interface Overview TIBCO XML Canon server has a user-friendly web interface. The frame on the right hand side displays the function in detail if a link has been clicked on the left hand frame. The menu bar is located at the top of the browser. Figure 23 shows the TIBCO XML Canon web interface. The display contents of these two frames depend on the function you chose. Understanding this interface helps you to carry out various functions and retrieve information within XML Canon rapidly and efficiently. The example below shows the properties page of the Industry Standards category in the right hand frame and a hierarchical structure of XML Canon categories. This interface consists of three parts: a menu bar and two frames. The frame on the left hand side gives an overview of the chosen function by giving its description link. Figure 23 TIBCO XML Canon User Interface Overview TIBCO XML Canon User’s Guide . and contains large buttons that access the most common tasks.

You can grant different permissions for categories and TIBCO XML Canon User’s Guide . you will see three options appear below this button. If your role is assigned with a CONNECT capability. For example. Figure 24 Menu Bar — CONNECT Capability Some options in the menu provide more than one function for users to choose from by providing a submenu. You can hover your mouse over the Browse button and click on one of the three options to access its functions (see Figure 25). Browse There are three options under the Browse button: Categories. It uses a hierarchical structure to visually display categories and subcategories. Figure 25 Menu Bar — Browse • The Categories button opens the Category tree which enables you to browse and manage categories and documents in the TIBCO XML Canon repository. which means you have no privilege to create a new user account and grant permissions to users. and Reports. If your role is assigned with an ADMINISTRATOR capability. You can browse the submenu by hovering your mouse over a button under the main menu. Namespaces.Menu Bar 35 | Menu Bar The menu bar always displays at the top of the web interface in TIBCO XML Canon. you will also see a button called Configure on the menu bar (see Figure 27 on page 37). You can use the menu bar to navigate within the application and start a new activity at any point in time regardless on the activity you are performing at that time. your menu bar will look like Figure 24. if you hover your mouse over the Browse button.

see Using Categories on page 48. For more information on reports. see Reports Overview on page 61. see Working with Namespaces on page 56. For more information on namespaces. • Home This option has no submenu. This functions allows you to view the public identifiers associated with doctype (Document Type) declarations in DTD documents in the repository. You can hover your mouse over the Search button and click on one of the two options to explore their functions. Click the Home button to visit the TIBCO XML Canon home page or to customize your personal settings. • The Namespaces button opens the namespace tree. see Searching for Documents on page 108. For more information on searching for components. See TIBCO XML Canon Home Page on page 39 for more information. For more information on searching for documents. The Reports button opens the report viewer. which enables you to view target namespaces associated with XSD schemas in the repository and their defining schemas.36 | Chapter 4 TIBCO XML Canon Web Interface documents within the repository for different users. and namespaces. see Searching for Components on page 125. which enables you to generate customized reports on documents and components in the TIBCO XML Canon repository. TIBCO XML Canon User’s Guide . Figure 26 Menu Bar — Search • The Components button enables you to search the documents in the TIBCO XML Canon repository for specific components such as elements. attributes. For more information on categories. There are two options under the Search button: Components and Documents. The Documents button enables you to search for specific documents stored in TIBCO XML Canon. • Search The Search utility provides an efficient way to find documents and components stored in TIBCO XML Canon.

see Chapter 16. on page 215. This data will be associated with components if the document types are XSD or DTD. The Custom Properties button enables you to define additional metadata for documents. you will see the Configure button in your menu bar. on page 195. see Chapter 14. Configuring Policies. For more information on stages. on page 229. review your installation parameters. Configuring Stages. Configuring Roles. purge documents from the repository. Access the help documentation by hovering your mouse over the Help button and select either the Help format that you prefer. • • • • Help Help gives you a quick overview of how to use TIBCO XML Canon. For more information on roles. see Chapter 12. The Users button enables you to create and manage users within a role. Figure 27 Menu Bar — Configure • The Roles button enables you to create roles and designate their capabilities and permissions. The Stages button enables you to define stages which are then applied to a document’s development cycle. Hover your mouse over the Configure button and click on one of the five options to explore its functions. set up authentications of internal and external users. There are five options under the Configure button: Roles. For more information on users. on page 255. and Custom Properties. Stages. Users. and review the server’s log and status. You will set the entry level requirement for each active stage.Menu Bar 37 | Configure (For ADMINISTRATOR Only) If you logged in to TIBCO XML Canon as an ADMINISTRATOR. see Chapter 15. Configuring Users. Configuring Custom Properties. The Policies button enables you to change the server’s behavior. For more information on policies. TIBCO XML Canon User’s Guide . For more information on custom properties. Policies. see Chapter 13. on page 239.

• • Log Out Click the Log Out button to log out of the TIBCO XML Canon web interface. The Release Notes button opens the PDF TIBCO XML Canon Release Notes.38 | Chapter 4 TIBCO XML Canon Web Interface Figure 28 Menu Bar — Help • The HTML User Guide button opens the HTML version of the TIBCO XML Canon documentation in your web browser. TIBCO XML Canon User’s Guide . The PDF User Guide button opens the PDF version of the TIBCO XML Canon User’s Guide. The HTML includes both the TIBCO XML Canon User’s Guide and the TIBCO XML Canon Installation.

You can specify the number of days a document may remain on this list or set a maximum limit on the number of documents on the list under the Personal Options tab. You can also access the home page by clicking the Home button in the menu bar at any time.TIBCO XML Canon Home Page 39 | TIBCO XML Canon Home Page The TIBCO XML Canon home page is the first page displayed after logging into the server through the web interface. you can conveniently locate your project files under this tab when logging in to TIBCO XML Canon. The TIBCO XML Canon home page provides a summary of recent activities and customizations under six different tabs. you will not have access to the Recent tab. If you are in the middle of a project. Figure 29 The Recent Tab in the TIBCO XML Canon Home Page TIBCO XML Canon User’s Guide . It also provides easy access to works in progress. Recent If you logged in as a Portal user. See Users Overview on page 216 for more information about Portal users. The Recent tab (see Figure 29) shows a list of recently added or modified documents in TIBCO XML Canon.

The asterisk before a document name indicates that the document has been logically analyzed. Figure 30 The DAV Tab in the TIBCO XML Canon Home Page TIBCO XML Canon User’s Guide . and transit documents between stages in this page. Note that this only applies to schemas (XSD and DTD). see Document Details Page on page 77. and custom properties) of the document under this tab and change them if needed in the Attributes area. To learn more about the document details page. lock and download the document for editing. This means the relationship between documents as well as between components has been determined. You can also view all the metadata information (such as comments. This page allows you to view the document’s metadata. WSDL files. and TIBCO ActiveMatrix BusinessWorks process definition files in TIBCO XML Canon. view content of the document.40 | Chapter 4 TIBCO XML Canon Web Interface Click on a document to view its details. we will refer to this page as the document details page. inspect the revision history. In this user manual. For more information on features of the DAV tab. revision labels. see Using TIBCO XML Canon with WebDAV Clients on page 155. DAV The DAV tab (see Figure 30) provides a list of documents which have been recently saved in TIBCO XML Canon using a WebDAV client.

In order to get these notifications. and download the most up-to-date version. review the differences between various document revisions. You can view the document history. For more information on notification subscription. validate the document. This can be done by check the document notification you want to delete and click the Delete checked button or if you want to delete the entire list click the Delete all button. Personal Options The Personal Options tab (see Figure 32) allows you to configure the TIBCO XML Canon user interface display settings and the Stage notifications options.TIBCO XML Canon Home Page 41 | Web Report The Web Report tab (see Figure 31) allows you to monitor data changes in documents that have been recently modified. see Notification Subscription on page 106. User configurable options include: TIBCO XML Canon User’s Guide . Figure 31 Web Report Tab in the TIBCO XML Canon Home Page Click on a document name under this tab to view the document details page for more information about this document. TIBCO XML Canon will notify you when a document of interest has been updated. You can also delete a notification under the Web Report tab. you must subscribe to the document notification.

You can be notified through email. • Default stage for WebDAV upload Specifies the initial stage when documents are uploaded to TIBCO XML Canon via WebDAV clients. • Display a maximum of documents modified Specifies the maximum number of documents to be displayed under the Recent tab at the same time. For more information on web notifications. For instance. then it will display up to 20 documents in the recent document list. it can only be set on the server side. TIBCO XML Canon User’s Guide . see Web Report on page 41. a Quality Assurance Engineer might be interested in any document that enters into the Test stage. • Component count for paging Specifies the maximum number of components which will display in a single page after performing a component search query in TIBCO XML Canon. For example. if you set the maximum value as 20. or both.42 | Chapter 4 TIBCO XML Canon Web Interface Figure 32 Personal Options Tab in the TIBCO XML Canon Home Page • Display documents modified within (days) Specifies the maximum number of days which an uploaded document will remain in the list under the Recent tab. Since Stage is an attribute of TIBCO XML Canon. Once the document has reached the specified number of days. the web. • Stage Notifications Gives you the option to be notified when a document enters a particular stage. it will be removed from the list. Only the WebDAV plug-in of TIBCO Turbo XML recognizes the Stage attribute when it saves to TIBCO XML Canon.

TIBCO XML Canon User’s Guide . (See Figure 33) • • The content of the Reports tab is user-specific. Therefore. the Report tab only displays reports that are public or created by the user. Therefore. — Configure Reports and the Select and Setup Report button allow users to modify report properties. TIBCO XML Canon runs only one report at a time to ensure that running reports does not degrade overall system performance. Generated reports are ready for you to review. This means that. You must decide whether a report will be available to all users (the public) or restricted (only available to the user and the administrator) when setting up the report. • For information on configuring reports.TIBCO XML Canon Home Page 43 | Reports Use the Reports tab to monitor available reports and to configure new reports including reports in the queue and generated reports. all reports are entered into a queue before execution. Figure 33 The Reports Tab in the TIBCO XML Canon Home Page • Some reports can be resource-intensive to run. for non-administrator users. see Reports Overview on page 61. There are two areas under the Reports tab: — Available Reports shows all executed reports and the results of these reports.

Enter the existing password in the Old password field. Figure 34 The Account Tab in the TIBCO XML Canon Home Page • The Change password information section can be used to change the password used to log in to the XML Canon web interface. and the desired password into both the New password and Confirm password fields and click the Update password button. username. full name. and your email address. Note that if you attempt to change your user name and the new name is already in use. the name associated with the account. The Account Information section allows you to update your user name. • TIBCO XML Canon User’s Guide .44 | Chapter 4 Account TIBCO XML Canon Web Interface The Account tab allows you to change your account settings such as password. To change any of these items. and email address. enter the new information in the appropriate field and click Update settings. you will receive an error.

namespaces. page 61 Configuring a New Report. page 72 TIBCO XML Canon User’s Guide . and Reports This chapter describes how to use TIBCO XML Canon categories. page 64 Using an XSLT Document as a Report. page 56 Reports Overview. which are accessible through the Browse button in the menu bar of the TIBCO XML Canon web interface. Topics • • • • • • Overview. page 46 Using Categories.| 45 Chapter 5 Categories. and reports. Namespaces. page 48 Working with Namespaces.

Namespace can help distinguish between data or configuration files that have similar XML vocabularies. Like directories. For more details on categories. categories are containers for documents. In this chapter. The use of namespaces in XML removes any ambiguity to XML vocabularies during application development and data processing. you will learn how to use the category browser in TIBCO XML Canon to manage user access to categories and perform a wide range of operations. Namespaces. Categories are collapsible and expandable in the category browser. The TIBCO XML Canon web interface provides a category browser which has the same hierarchy structure as Windows Explorer. Thus. They will help you to store and manage XML documents in TIBCO XML Canon. you can view categories. It is represented with a URI (Uniform Resources Identifier) which could be a URL (Uniform Resource Locator) or a URN (Uniform Resource Name). and Reports Overview Through the TIBCO XML Canon Browse menu. You will manage the permissions of categories and documents. and reports. perform various related operations (such as load document. Various XML namespaces can be easily tracked in a wide range of projects. Namespaces XML namespace is a unique identifier that associates an XML Schema with the organization which created it.46 | Chapter 5 Categories. They are analogous to the directories in a local file system. and tag). and save a copy of a document to your local file system. go to Using Categories on page 48. TIBCO XML Canon is equipped with indexing tools which track all namespaces in the repository and their associations to documents stored in the repository. Categories Categories are the primary organizational units of TIBCO XML Canon. namespaces. locate a document for review. namespace provides context to schema components and the data they represent. clone. TIBCO XML Canon User’s Guide .

You can select up to three namespaces in one search query and use criteria such as document tag. To learn how to browse XML namespaces in TIBCO XML Canon. Namespaces are viewed and queried in a namespace browser. XML Canon provides two XSLT documents for creating reports by default. see Reports Overview on page 61. You can generate document reports or component reports based on configurable search criteria. the namespace browser provides a listing of the XML DTD DOCTYPE public IDs referenced by XML documents.Overview 47 | Similar to Categories. scope. namespaces in the XML Canon web interface are also represented in a hierarchical structure. If you prefer your own customization. see Working with Namespaces on page 56. and add a DTD’s access path to a public ID which has not been defined by another user. For more details on managing DTD DOCTYPE public IDs in TIBCO XML Canon. To learn how to select. In addition. and other searches to filter the results. see DTD Doctype Public IDs on page 187. TIBCO XML Canon User’s Guide . You can expand and collapse the hierarchical components of the URI. or schedule a report execution. run a report. Full expansion of a namespace in a namespace browser will yield a listing of its defining schemas and XML documents that use them. One is for documents and the other one is for components. Reports A TIBCO XML Canon Report is an XML document (customized for presentation as HTML using XSLT) which displays a list of results from the searching query. The namespace browser also provides a configurable namespace search engine for searching XML namespaces. You can store those documents anywhere on the server. setup. but it is recommended that you place them under a special category. you can modify the default documents or create new ones.

Roles permissions determine how much content a user can access through the category browser and the Category Details panel. If a user does not have full permissions. You can access and manage categories (set permissions. Browsing Categories To access the category browser hover your mouse over the Browse button in the menu bar and click the Categories button from the submenu. refer to Roles Overview on page 196. For information about tools available to administrators. Figure 35 The TIBCO XML Canon Menu Bar The category browser appears in the left-hand frame. and Reports Using Categories This section describes how users with CONNECT capabilities can manage categories and documents. that user will not be able to take some of the actions described in this chapter. Namespaces. see Chapter 10. as shown below.48 | Chapter 5 Categories. For more information on permissions. and clone) and documents from this browser. The chapter assumes that the users have full permissions. tag. Figure 36 Category Browser TIBCO XML Canon User’s Guide . Administering Categories and Documents.

while documents are indicated with a document icon . For more information on browsing by tag. Categories are marked with a yellow folder icon . tag a category. the Delete button for this category is unavailable. or unlock the category. For example. add documents to the category. delete a category. clone a category. Click Latest to update the category browser to display items using a different tag. Expanded categories can be collapsed by clicking on the "-" sign. click on the "+" sign. Using Tags. see Chapter 8. Administering Categories and Documents.Using Categories 49 | The category browser initially displays top-level categories. At the upper right hand corner of the category frame. To expand a category to view its contents (such as sub-categories or documents). Category Details Panel The Category Details panel (see Figure 37) contains information about a category and provides tools to carry out operations in the category. Latest refers to the current revisions of documents in TIBCO XML Canon. You can also add a document from the local file system to a category. you can rename a category. you can see the words by tag="Latest". By default. Your user role decides how many category-related operations you can do. For more information. and validate documents within a category. if your role does not have the permission to delete a category. on page 130. update category role permissions. see Chapter 10. add child categories. Only users with the ADMINISTRATOR capability can clone categories. certain buttons in its details page will be inactive. and validate XML Schema and XML documents from the local file system. page 171. From the Category Details panel. If your role only has limited permissions on a chosen category. TIBCO XML Canon User’s Guide . the category browser always displays categories which are marked with the latest tag.

TIBCO XML Canon User’s Guide . These tags may have been assigned to the category itself.50 | Chapter 5 Categories. Using Documents. See Deleting Categories on page 53 for more information. and Reports Figure 37 Category Details Panel Category Details The Category Details section gives general information about the category: • Name specifies the category name. New child category and the Add child button create a new category within the current category. For more information. Namespaces. ascendant or descendent categories. enter a new name in this field and click Rename. see Creating Child Categories on page 51 for more information. or to a document within the category. and to validate XML Schema and XML documents on the local system from the category. See Renaming Categories on page 52 for more information. To change the name. see Chapter 6. on page 75. WebDAV path gives the category’s URL accessible by WebDAV clients. Modification date shows when the category was last modified. For more information on managing documents. Tags displays a list of all assigned tags within the current category hierarchy. • • • • • • Document Actions The Document Actions area in the Category Details panel enables you to add documents from the local file system to this category. The Delete button deletes an empty category. Create date shows the date that the category was created.

Creating Child Categories In order to create a child category. you must have write permission to its parent category. Follow the instructions below to create a new category: 1. For more information on tagging. Using Tags. Click Browse > Categories from the menu bar to access the category browser. 2. see Managing Categories on page 173. Go to the category browser to verify that the child category has been created. Click the Add child button to complete the process. you can also see a Tagging area in the Category Details panel. Otherwise.Using Categories 51 | Tagging If your role has assign or reassign tagging permission. Figure 38 Creating a Category 5. see Chapter 8. on page 130 and Roles Overview on page 196. Type the name of the child category in the New Child Category field in the Category Details panel (see Figure 38). Locate the category where you want to create a child category and click the name of that category to open its Category Details panel. 3. TIBCO XML Canon User’s Guide . the Add Child button for this category will be disabled. 4. Note that if you do not have write permission to the parent category. For information on changing category permissions. this button is deactivated.

Figure 39 Renaming a Category 5. Otherwise. TIBCO XML Canon User’s Guide . Click Browse > Categories from the menu bar to access the category browser. 4. Locate the category you want to rename and click the name of that category to view its Details panel. and Reports Renaming Categories Your role must have the write permission to a category or its parent category in order to rename it. the Rename button will be disabled. Namespaces. 2.52 | Chapter 5 Categories. The WebDAV path will continue to use the original name even though the category may no longer exist. However. For information on changing category permissions. Click the Rename button to apply the new category name. see Managing Categories on page 173. 3. you can still access a renamed category through its tag. Type the new name of the category in the Name field within the Category Details panel (see Figure 39). Follow the instructions below to rename a category: 1. Renaming a category that contains Tag information affects the WebDAV path and URL address of documents within the category. Go to the Category browser to verify that the category name has been changed.

XML Canon is WebDAV-enabled and so can be accessed using a WebDAV client. a. Only one category is deleted at a time. Select a document under the Categories folder to view the Document Properties. For example you can delete a category in XML Canon from a Window’s Web Folder in the same way you would delete a directory on the local Windows file system. click the Delete.Using Categories 53 | Deleting Categories Your role must have delete permission to the category in order to delete it.. It is possible to delete categories and documents using a WebDAV client. Click Browse > Categories from the menu bar to access the Category browser. see Managing Categories on page 173. To delete a document. start deleting from the lowest level and move upwards after each category deletion. even if they do not meet the requirements above. 3. Expand the category you want to delete from the Category browser and delete all of its content. The category is not locked. You must delete the entire content of the parent category (documents and child categories) before you can delete it. For information on changing category permissions. see Chapter 9. Click the name of the category in the category browser after clearing all its contents. button found in the Detailed Views area. on page 147. For more information on WebDAV clients. See Deleting Documents on page 93 for information on how to delete documents. Follow the instructions below to delete a category through a web interface: 1.. If a category contains multiple levels of descendents. TIBCO XML Canon User’s Guide . A TIBCO XML Canon category can only be deleted through the XML Canon web interface if it meets following conditions: • • • The category is empty. b. 2. Working with WebDAV Clients.

Figure 41 Moving a Category .Before Selection TIBCO XML Canon User’s Guide . Namespaces.. This location can only be accessed by an administrative user. and Reports 4. To preserve the integrity of a tagged collection of categories and documents. see Purging Deleted Categories and Documents on page 177. button in the Category Details panel to delete the category. TIBCO XML Canon assigns a special deleted tag to all deleted documents and moves them to a holding location. Expand the categories to view both the category you want to move and the category you want to move it to. you will receive a warning message as shown as in Figure 40 in the right-hand frame: Figure 40 Category Must Be Empty Warning Message Moving Categories In order to move a category. For information on changing category permissions.. 3. If the category you are deleting is not empty. Deleted categories and documents will remain on hold until they are purged from the database. Follow the instructions below to move a category to another location within the TIBCO XML Canon repository: 1. 2. For information on purging deleted categories. Click Browse > Categories from the menu bar to access the category browser. Click on the folder icon associated with the category you want to move as shown in Figure 41. see Managing Categories on page 173. Click the Delete. your role must be assigned read and write permissions to that category as well as its destination category.54 | Chapter 5 Categories.

Figure 42 Moving a Category . The button appears to the right of potential categories destinations. or if one or more documents within the category are locked. Select the destination category by clicking the button next to it and click OK in the confirmation dialog to complete the move. the move operation fails with a permission-related error message in the left-hand frame. Expand the destination category to verify that you have successfully moved your category. TIBCO XML Canon User’s Guide . If you do not have permission to the source or the target categories.After Selection 4. 5. Note that the category you have selected is now highlighted.Using Categories 55 | The category browser window looks like Figure 42.

www. This includes all the documents in the repository. and Reports Working with Namespaces This section describes how to work with XML namespaces in TIBCO XML Canon. For more information on tagging. A namespace is represented with a button in the namespace browser.56 | Chapter 5 Categories. Click the sign to expand a namespace path. see Chapter 8. The Namespace browser appears in the left-hand frame of the browser window (see Figure 44). Click Browse > Namespaces in menu bar to access the Namespace browser. sign to collapse a namespace path. http://). Click the 4. whereas a namespace path is represented with a button. This list is categorized by URI scheme (for example.com). You will see a list of all namespaces that are associated with documents stored in the TIBCO XML Canon server. You can also filter namespaces by other tags the same way you filter the category list in the category browser by tags. on page 130. (See Figure 43) Figure 43 The Namespaces Menu Bar in TIBCO XML Canon 2. host name (for example. Browsing Namespaces for Documents Follow the instructions below to browse namespaces for their associated documents: 1. Figure 44 Namespace Browser 3. 2001/XMLCanon). By default. and path (for example. TIBCO XML Canon User’s Guide . the namespace browser displays all namespaces in TIBCO XML Canon because they are filtered by the default Latest tag. Namespaces.tibco. Using Tags.

This page displays the Schemas tab view by default. — The Schema tab displays a list of schemas that define the selected namespace. (See Figure 45) Figure 45 The Namespace Details Page 6. Select other tabs to view documents which are associated with the selected namespace. but do not fit under either of the two preceding tabs. For example. 7. button at the bottom of the namespace browser to switch the namespace browser to a Namespace Search panel (see Figure 46). Searching Namespaces Follow the instructions below to search namespaces within associated documents: 1. — The Uses tab shows a list of documents that use the selected namespace. See Chapter 11. TIBCO XML Canon User’s Guide . Click on a document name in one of the tabs to view its details in the right panel. Select a name of the namespace to see its namespace details page in the right-hand frame.. For example.Working with Namespaces 57 | 5. The Presentation tab is visible only to users with ADMINISTRATOR capability.. XML schemas with a target Namespace attribute matching the selected namespace. an XSLT file that converts documents from one namespace to another namespace will be shown under this tab for both namespaces. — The Instances tab shows a list of documents that use the selected namespace in an XML <root> tag. on page 185 for more information. Administering Namespaces. Click the Search.

The default search scope encompasses All documents which searches all document types in the repository. — Match any allows you to search for documents that contain references to any selected namespace. To add another namespace to your search query. TIBCO XML Canon allows you to search with a maximum of three namespaces. TIBCO XML Canon User’s Guide . Namespaces. If you select more than three namespaces or none at all. Select a search constraint from the Search constraint drop-down list. 3. 4.58 | Chapter 5 Categories. Permits you to search for documents that contain references to all selected namespaces. click on its name. This action will highlight the selected namespace. Select a namespace you want to search in documents under the Select namespaces to match area. There are two kinds of matches: — Match all is the default selection. the namespace Search button becomes inactive. Select the search scope from the Search scope drop-down list. and Reports Figure 46 The Namespaces Search Page 2. Click on a pre-selected (highlighted) namespace to deselect a namespace from your search. TIBCO XML Canon allows you to search with a maximum of three namespaces. The search scope is either all documents or documents of a particular type. 5.

Select a document from the Namespace Search Results list to see its details in the document details page. 8. Using Tags.Working with Namespaces 59 | 6. Browsing and Editing DOCTYPE Public IDs Follow these instructions to edit DOCTYPE public IDs: 1. Click the Return to browsing button to return to the namespace browser. see Chapter 8. 7. 2. 3. For more information on tagging. Click the Doctypes button in the namespace browser to open DOCTYPE Listing panel (see Figure 47). TIBCO XML Canon searches for tags assigned to the documents at the time the documents were created. Select a tag from the Document tag drop-down list. Your search results will be displayed in the right-hand frame. Click the Search button at the bottom of the namespace search panel to perform a search. Choose a public ID from the DOCTYPE Listing panel and specify the access path of a DTD document that TIBCO XML Canon must use when validating instance documents in order to resolve the public ID. only this user or an administrative user can change the access path. Figure 47 Editing DOCTYPE Public IDs The DOCTYPE Listing panel displays all public IDs found in the TIBCO XML Canon repository. 9. TIBCO XML Canon User’s Guide . Click Browse > Namespaces in the menu bar to access the namespace browser. These tags are not associated with later versions of the same document. on page 130. If a user has edited the DTD access path for a public ID.

For more details on managing DOCTYPE public IDs in TIBCO XML Canon. Click the Update button to carry out the implementation. The namespace resolution method for document validation is defined in stage configuration. Such paths will begin with a forward slash ’/’ representing the server’s root in TIBCO XML Canon (the Categories category). Namespaces. the validation tool will treat the document as invalid. If you want to use the access path specified in the DOCTYPE listing panel to resolve public IDs in your instance documents. see DTD Doctype Public IDs on page 187. While using the access paths specified in the DOCTYPE listing panel. ask an administrative user to make the appropriate stage configurations. TIBCO XML Canon User’s Guide .60 | Chapter 5 Categories. 4. Otherwise. — An absolute path represented by fully qualified URL beginning with http://. and Reports The access path may be either of the following: — A relative path in the TIBCO XML Canon server. you must specify a pseudo or dummy system ID in your instance documents in order to perform the validation task.

You decide what aspects of those documents or components will appear in the report. or click Browse > Reports in the menu bar to access the reports browser (see Figure 48 and Figure 49). Figure 48 Report Tab on the TIBCO XML Canon Home Page TIBCO XML Canon User’s Guide . which you can customize. However. add them to XML Canon and use them as reports. XML Canon allows you to choose when to run these reports and how often you want to run them. These reports are configurable based on documents or components you want to select. you can write your own XSLT documents. You can generate reports from the TIBCO XML Canon report web pages as described in this section. Reports are accessible to all users who generated them. TIBCO XML Canon can make reports available based on the XSLT documents stored on the server. and the Xalan XSLT processor. Therefore. Reports are generated by using configuration parameters you specify.Reports Overview 61 | Reports Overview TIBCO XML Canon enables you to run reports on documents and components. In addition. users can also access any reports that other users generate and make public (that is assign the report with a public permission). XSLT documents. Because reports are XML documents. Furthermore. a private report (a report assigned with the User and Administrator Only permission) is shared by saving the HTML output locally. TIBCO XML Canon provides two default reports (one for documents and the other for components). Finding Information on Reports You can set up TIBCO XML Canon reports from the Report tab in your XML Canon home page.

if you were working at 2 p. If a report is generated by another user and you are not an ADMINISTRATOR user. but you cannot delete the Default Component Report. the Delete action is not present in your Available Reports list. Namespaces. The Queued Reports list in the Reports browser tells you what reports are currently being queued to run. TIBCO XML Canon User’s Guide . even if there is not a queue. This means you have read-only access to reports which other users configured. • Available Reports These are reports that have already run and the results are available for review. and Reports Figure 49 Browse Reports Queued and Available Reports There are two kinds of report status: those which have been queued and those which have already been generated. The Available Reports area displays reports from two sources: — Reports which you configured with your User permission. — Reports configured by other users and assigned the Public permission.m. Delete The TIBCO XML Canon server grants you with the Delete permission on all reports you have created or configured. and decided to run a report immediately. For instance. there might be three reports in the queue that are scheduled to run at 2 p. • Queued Reports The report does not run immediately even if you choose the Run report immediately option from the Report Actions area because this process starts with a queue check. You need to understand these reports in order to understand the report process in TIBCO XML Canon. in Figure 49. it will still takes a few seconds for the report to generate.62 | Chapter 5 Categories. Reports are queued to run and. For example.m daily. you can delete Default Document Report.

you will be prompted to choose between two default reports: default document report and default component report (see Figure 50). or customize them following the descriptions in the next section. Figure 50 Default Reports You can run these default reports as they are.Reports Overview 63 | Default Reports Select and Setup Reports When you click on the Select and Setup Reports button. TIBCO XML Canon User’s Guide .

64 | Chapter 5 Categories. public versus private) Schedules for running the report These configuration steps are described in the sections below. These criteria are listed under the area titled Find documents and components using search criteria. and Reports Configuring a New Report To configure a new report. Searching Documents for a Report When you click the Select and Setup Reports button. Namespaces. you will be prompted with a choice of two default reports: the default document report and the component report (see Figure 51). Hide or add certain criteria and choose default values according to your needs (see Figure 52). you must set several types of parameters: • • • • • • Search criteria for documents or components of interest The report display Essential fields in the report Essential data in the report The report’s availability to other users (for example. Figure 51 Default Reports Click on the name of a default report (document or component) to start the setup by displaying the search criteria which are used to generate the content of the report. TIBCO XML Canon User’s Guide .

You can restart another search from this page.. Return to default settings Return to report type selection View report contents TIBCO XML Canon User’s Guide . After you have chosen all your search criteria for a report. If the default criteria are not sufficient to carry out your search. click the Check Report Contents. button to clear the screen (including search results) and return to the initial list of available reports.. Click the Reset button to clear your current search entries and return to the default search settings. Click the Clear Report Parameters. you can add more criteria by selecting an item from the list in the Additional Search Criteria drop-down menu.. button to view your search result and configure additional report parameters..Configuring a New Report 65 | Figure 52 Report Search Criteria Enter search criteria The area Find documents and components using search criteria combines the document search criteria described in Searching for Documents on page 108 and the component search criteria described in Searching for Components on page 125.

and Reports Navigating the Report Display You will see your search results list in the Documents Selected for the Report area after clicking the Check Report Contents.. Namespaces.. Figure 54 Report Navigation Position Navigation If the search results exceed the maximum display limit set in the Step menu. By default. However. TIBCO XML Canon User’s Guide .66 | Chapter 5 Categories. Note that the display number controls the size of steps for navigation. button (see Figure 53). the view also includes a Navigation area for you to go through all the pages of the result list. Forward. 20 search result records will be displayed per page. Back. Figure 53 Documents Selected for the Report Total Selected The number at the side of the Total Selected label on the top-left corner above the Documents Selected for the Report area indicates the total number of items in the search result. The Navigation area contains four self-explanatory buttons: Start. you search results will be displayed under the Components Selected for the Report area. and End (see Figure 55). If your search is based on the component report. you can use the Step drop-down menu to change the number of records displayed per page.

The Back button takes you to the previous page of the results list. Your position in the list is indicated by the Start label which is located at the left hand side of the Step drop-down list. • Actions Below the search results. The Forward button takes you to the next page of the list. configure the report data. and select the report display parameters. Setting Report Display Parameters You can choose which data will be included in the report and the way the report will be displayed by clicking the Set the Report Data and Display Parameters in a report display. End takes you to the end of the document list. These settings are described below. TIBCO XML Canon User’s Guide .Configuring a New Report 67 | Figure 55 Report Navigation Buttons • • • The Start button takes you to the beginning of the document or component list and the End button takes you to the end of the list. Click Set the Report Data and Display Parameters button to configure the report data and set the report display parameters. The Report Display Parameters screen allows you to set the report actions. the Actions section allows you to either clear the report or specify further search parameters. Continue below for more information about the display options. Figure 56 Report Actions • • Click Clear the Report Parameters to exit the report and return to the default report list.

Namespaces. Configure report data Figure 57 Report Display Parameters — Configure report data In this section. document relationships. • Click Review report settings to display a summary of the current report configuration and parameters. you can: • • Provide a name for your report in the Report Name field.68 | Chapter 5 Categories. and Reports Actions Although the Actions buttons are located at the top of the report display parameters screen. • Include additional data in your report such as document properties. you should review the Report configuration and Report display parameters sections (described below) before performing any actions. Assign a Permission to your report: — Public The report can be viewed by all TIBCO XML Canon users. • Click Clear all settings and restart to exit the report and return to the default report list. TIBCO XML Canon User’s Guide . just check the box next to the data type. and to schedule or run the report. Proceed to Running or Scheduling the Report on page 70 if you are ready to schedule or run the report. To do this. — User and Administrator only The report can only be viewed by the user who created or configured it and users with the ADMINISTRATOR capability.

refer to Chapter 6. Components. Continue with Running or Scheduling the Report below. scheduling the report execution for a later time. or clearing all settings for a new search. If the report you are attempting to generate includes documents and components beyond the maximum report size allowed. the report will be generated to the maximum size allowed by your administrative policies. you will receive an error about the documents only. For information on how the administrator sets the maximum report size and other reporting limits. After reviewing the report settings. Including a large amount of data in your reports will cause problems with the cache space that the reports consume. Using Documents. However. see Searching Namespaces on page 57 or Searching for Documents on page 108. A components over limit error message will only be sent if documents in the report are not over the maximum size limit. If you generate a long report. Report display parameters Figure 58 Report Display Parameters For an explanation of these parameters. you should include only the most relevant data. you may get an error message from the server. see Policies Page Overview on page 240. TIBCO XML Canon User’s Guide .Configuring a New Report 69 | For an explanation of the various data you may want to include in a report. page 75 and Chapter 7. updating the report settings. If you choose to run a large report. page 115. you have the option of running the report immediately.

Namespaces. The report summary is divided into several sections. and Reports Running or Scheduling the Report The Actions section at the top of the Configure Report Data screen offers two buttons that enable you to either review the current report settings or clear all settings and start a new report (see Actions on page 68).. Update settings returns you to the Report Display Parameters screen. permission settings.. XML Canon runs the report as specified in the Schedule section. and returns you to the Reports tab on the XML Canon Home Page. Setting Report Display Parameters. See Schedule below for more information. When you click Schedule report. Click the Review report settings. This summary consists of the report name. The hour of the day.m. and other parameters. where you can make changes to your selections. button to display a summary of the report configuration and parameters. Schedule report runs the report at the specified time. The following example shows a report scheduled to be generated once a day. You can schedule: • The frequency: — Once — Daily — Weekly • • • The day of the week (or Today). starting on Friday at 6:30 p.) Clear all settings and restart exits the report and returns to the default report list. Actions The Report Summary screen offers several buttons. • Schedule The Schedule section is used in conjunction with the Schedule report button. • • • Run report immediately runs the report with the selected parameters. described here. TIBCO XML Canon User’s Guide .70 | Chapter 5 Categories. The minutes after the hour. (This screen is described in the previous section.

Click the Schedule report button in the Actions section. Report Configuration & Parameters Parameters that you selected for inclusion in the report are labeled on in the summary report. and time in the Schedule section.Configuring a New Report 71 | Figure 59 Schedule Report Example To Schedule a Report 1. click the Update settings button to return to the previous screen. day. Set the frequency. If you wish to make any changes to your selections. TIBCO XML Canon User’s Guide . Figure 60 Summary of Report Configuration and Parameters Report parameters with the label on correspond to your selections in the previous section. 2. Setting Report Display Parameters.

3. Figure 62 the Quick View Button under the Properties Tab This action opens the XSLT file for the report as a simple text file in a new browser window (see Figure 63). You might find it helpful to use one of the provided default reports. The detailed report view opens in the right panel.na. Click Browse > Categories > Reports from the menu bar and expand the categories (see Figure 61). as a guideline.tibco. Select one of the default reports by clicking on its name to open its document details page. defaultDocumentReport. Scroll down to the Detailed Views area and click the Quick View button (see Figure 62). Use the category browser to open them by following the instruction below (see Figure 61).com/Reports.72 | Chapter 5 Categories. and Reports Using an XSLT Document as a Report If you want to use a custom XSLT document of your own creation as a TIBCO XML Canon documents or components report. Figure 61 Browsing Categories for Reports 2. TIBCO XML Canon User’s Guide . 1. These reports are under the XML Canon Reports category. Namespaces.xsl.xsl or defaultComponentReport. your XSLT document must reference the namespace http://canon.

com/namespaces/2004/XMLCanon/Reports has been used in this stylesheet.Using an XSLT Document as a Report 73 | Figure 63 The XSLT Style Sheet for Report Note that the namespace http://www.tibco. You can also contact TIBCO support for further guidance. You can review this stylesheet for guidance in designing your own report using a XSLT document. TIBCO XML Canon User’s Guide .

74 | Chapter 5 Categories. and Reports TIBCO XML Canon User’s Guide . Namespaces.

page 87 Uploading Documents. page 76 Document Details Page.| 75 Chapter 6 Using Documents This chapter provides instructions on using and managing documents in TIBCO XML Canon. page 98 Validating Documents. page 92 Deleting Documents. page 89 Downloading Documents. page 108 Accessing Documents via URL. page 97 Viewing Document Content. page 104 Notification Subscription. Topics • • • • • • • • • • • • • • • • Documents Overview. page 106 Searching for Documents. page 111 TIBCO XML Canon User’s Guide . page 101 Using the Differencing Engine. page 91 Moving Documents. page 96 Managing Documents with Stages. page 93 Locking and Unlocking Documents. page 94 Updating Document Properties. page 77 Viewing Different Document Versions.

For more information on WebDAV clients and how you can use them to manage and develop documents in TIBCO XML Canon.76 | Chapter 6 Using Documents Documents Overview TIBCO XML Canon offers a wide range of functions for document management and development. TIBCO XML Canon User’s Guide . However. TIBCO XML Canon provides a large set of metadata about each document in the document details page. which can expedite document management and development. TIBCO XML Canon also supports WebDAV clients. The metadata are kept for all document revisions so that you can review the information from earlier versions of the same document. All instructions given in this chapter are based on the assumption that your role has the maximum permissions to access stages and categories. see Roles Overview on page 196. see Chapter 9. This section describes how to use and manage documents from the web interface. This gives you detailed information about a document. on page 147. In addition to basic document management functions. Working with WebDAV Clients. For more information on roles and permissions.

Select one of these tabs to see different information about the document: • • Select the Properties tab to see the document properties.Document Details Page 77 | Document Details Page This section describes the different information and functions in the document details page. The document details page will open in the right-hand frame when you click a document name in TIBCO XML Canon. including its custom properties. Figure 64 Document Details Page Tabs The document details page contains four tabs which are located at the top of the page. You can TIBCO XML Canon User’s Guide . Select the History tab to view the document revision history and subscribe to web and/or email notification on future changes to the document. See Properties Tab on page 79 for more information. Figure 64 shows the Properties tab of a document details page.

TIBCO XML Canon User’s Guide . See Relations Tab on page 84 for more information. See History Tab on page 82 for more information.78 | Chapter 6 Using Documents also use the differencing engine to view differences between versions. See Update Tab on page 85 for more information. • • Select the Relations tab to see the document associations with other documents. Select the Update tab to update the document properties.

Document Details Page 79 | Properties Tab The Properties tab allows you to view all metadata of a document in TIBCO XML Canon. see Viewing Document Content on page 98. you can see all of the document metadata in the Document properties area. You can click the link or links here to see different views of the document. there may be multiple options to display the content of a document in the Detailed views area. metadata for the latest version of the document is displayed. More information about the data fields shown here is available in Table 3 on page 81.the Properties Tab Document properties In Figure 65. Configuring Custom Properties. Figure 65 Document Details Page . TIBCO XML Canon User’s Guide Detailed views . on page 255. For more information. Depending on the document type. By default. To find out how to view details for a different version of the document. For more information on custom properties. see Chapter 16. see Viewing Different Document Versions on page 87. Custom properties The Custom properties area displays custom properties associated with a document.

see Chapter 8. Quick view displays the current document’s content as a plain text file in a new browser window. For more information on tagging and tagging permissions. They enable you to perform operations (such as lock. Figure 66 Function Buttons under the Properties Tab A brief description has been provided for each of these buttons below: • • Lock locks the current document. on page 130 and Roles Overview on page 196. See Viewing Document Content on page 98 for more information. see Analyzing Documents for Components on page 182. on page 115. See Validating Documents on page 101 for more information. validate. or save) on documents in TIBCO XML Canon providing you have the necessary permissions to carry out the operations. Tagging If your role permits you to assign tags. Figure 66 shows a view of all the buttons present with all permissions granted to a user’s role. If you do not have the appropriate permission to perform certain functions (for example. Components. See Document Details Buttons below for more information about these options. Delete deletes the current document from the server. Components displays all components in the current document. view.80 | Chapter 6 Using Documents This section also includes a row of buttons that perform more actions. Validate validates the current document. depending on the type of document you are viewing. some buttons may be active while others may be inactive. • • • • • TIBCO XML Canon User’s Guide . Refer to Locking and Unlocking Documents on page 94 for more information. Document Details Buttons You will see a row of buttons at the bottom of the document details page. Save as downloads a copy of the current document to your local system. see Chapter 7. Analyze performs an logical analysis of the current document. For more information on components. See Deleting Documents on page 93 for more information. See Downloading Documents on page 91 for more information. the corresponding buttons are disabled. delete documents). Also. you will be able to see a Tagging area below the Detailed Views area. For more information. Using Tags.

The document’s fully-qualified URL as it pertains to external WebDAV clients. Multipurpose Internet Mail Extension type (such as application or XML). All tags that have been assigned to the currently selected version. Can be a version number of the currently selected version which was specified by the user during the document’s initial upload or at the time it was updated. The document type of the currently selected version (such as DTD and XSD). WebDAV path Stage TIBCO XML Canon User’s Guide . The TIBCO XML Canon username and full name of the user who modified the currently selected version. The stage of the currently selected version. The comment associated with the currently selected version which was specified by the user during the document’s initial upload or at the time it was updated. They are listed in the same order as they appear under the Properties tab in the document details page. The namespace that governs the content of the currently selected version. The full category path of the currently selected version. The namespace in the currently selected version which is defined by a schema. The size of the currently selected version. Table 3 Document Metadata Attribute Name Version # (X of Y) Document type Mime type Last modified by Root namespace Target namespace Size (bytes) Revision label Tags Comment Category Description The name of the currently selected version of a document. Note that different versions of the same document may possess different category paths if the document has been moved. Indicates the number of times which the document has been edited (Y) and which version is currently selected (X).Document Details Page 81 | Metadata Fields Table 3 shows a list of all metadata along with their descriptions. You can click the username to send an email to that user with your email client. Note that different versions may be named differently. Note that only the tagged version of a document can have WebDAV paths.

the content within all <appinfo> tags in an XSD schema) Documentation Application information History Tab The History tab in the document details page shows a revision history of the selected document in TIBCO XML Canon. A logical analysis is usually done on schemas and XML documents during their check-in (at the initial upload and at the time it was updated) in order to index and validate documents and their components and to establish the relationships and associations between them. Indicates whether the schema or XML document has been logically analyzed. (For example.the History Tab TIBCO XML Canon User’s Guide . the content within all <documentation> tags in an XSD schema). Any annotations within the XSD schema for consumption by an application. Any annotations within the XSD schema to be read by humans (for example.82 | Chapter 6 Using Documents Table 3 Document Metadata Attribute Save date Analyzed Description The date when the currently selected version was uploaded. Figure 67 Document Details Page . Figure 67 shows a typical History tab view in the document details page.

For more information.Document Details Page 83 | Notifications The Notifications area allows you to subscribe to notifications about updates on the current document. Make selected revision latest reverts to a previous revision of the document. See Quick View on page 98. or both depending on the subscriber’s selection. For more information. Document Metadata. Quick View displays the content of the document in plain text. see Notification Subscription on page 106. on page 81 for descriptions of all metadata. Notifications can be sent via email. Save as downloads the document to your local file system. Document history Actions The Document history section also included buttons that you can use to perform useful actions: • Show differences allows you to see the differences between two selected document revisions. see Viewing Different Document Versions on page 87. See Validating Documents on page 101. you will not be able to access its document details page. If a previous document version existed in a stage or category in which you do not have the read permission. For more information. Validate checks the document to see if it is well-formed. You can view the document details for a different version by clicking on its revision label or the button next to it. • • • • • • • TIBCO XML Canon User’s Guide . Components displays a list of all the selected document’s components. Delete removes the document. See Viewing Components on page 124. Note that. unless you are an administrator. via the web. The Document history area displays a list of all revisions of the document. It also displays some applicable metadata for each revision. See Locking Documents on page 94. you can only delete unlocked documents that you created. Refer to Table 3. see Using the Differencing Engine on page 104. Lock locks the document so that no other users can make changes. See Making a Previous Document Tag Current on page 136.

which may have one of the following values: • Include indicates that the schema content is included in or includes another schema. Import indicates that components of the selected schema are used by another schema through a namespace reference or that the selected schema uses components defined in another schema through a namespace reference. B. and C. including those which are external to TIBCO XML Canon. External indicates that this related document is external to TIBCO XML Canon. The Include role covers associations through an external parameter entity (DTD) or an include element (XSD). Figure 68 Document Details Page .84 | Chapter 6 Using Documents Relations Tab You can view document associations in the Relations tab if the document you are viewing is a DTD or an XSD schema. Because there are four related documents in TIBCO XML Canon.the Relations Tab One of the metadata in the relations list is called Role. the Relations tab displays their name and other metadata. A description of the Role attribute is provided below. The Role attribute indicates the nature of the association between documents. the relationship between A and C is described as indirect. on page 81 for a description of each metadata attribute. See Table 3. If A includes B and B imports C. • • • • TIBCO XML Canon User’s Guide . Consider an example of three schemas: A. Indirect is used to describe secondary relationships. Document Metadata. Figure 68 shows the Relations tab for an XSD document which uses or references and is used or referenced by other XSDs. Unknown indicates that this document has a relationship with a document which cannot be resolved. This tab shows all relations between this document and other documents.

Furthermore. if your server administrator has created some custom properties. and edit properties. you can ask your server administrator to define a port called aliases in the server. Instead of making changes to your TIBCO XML Canon documents. from 8080 to 8081). You can update document properties such as the name of the document and other metadata about the document under this tab. The Update tab also allows you to manage stages of individual documents via the TIBCO XML Canon web interface.the Update Tab TIBCO XML Canon User’s Guide . these relations will fail to resolve when the port number of your TIBCO XML Canon server changes (e. remove. see Updating Document Properties on page 96. you will also see a Custom Properties area where you can add. To see how to edit document properties. If your TIBCO XML Canon documents make references to each other via their fully-qualified URLs. See Managing Documents with Stages on page 97 for more information. Update Tab If you are currently viewing the latest version of a document in the document details page.g.xml file. you will see an Update tab (see Figure 69).Document Details Page 85 | The association Role must not be confused with the TIBCO XML Canon Role which defines a class of users with certain permissions. which is located in the TIBCO_HOME/xmlcanon/tomcat/conf directory. Figure 69 Document Details Page .

86

| Chapter 6

Using Documents

Actions

The Document history section also includes buttons that you can use to perform useful actions: • • • • • • Update properties updates the document with new settings you have specified. Lock locks the document so that no other users can make changes. See Locking Documents on page 94. Quick View displays the content of the document in plain text. See Quick View on page 98. Save as downloads the document to your local file system. Validate checks the validity of a document. See Validating Documents on page 101. Delete removes the document from the TIBCO XML Canon server. Note that, unless you are an administrator, you can only delete unlocked documents that you created. Components displays a list of all the selected document’s components. See Viewing Components on page 124.

TIBCO XML Canon User’s Guide

Viewing Different Document Versions 87

|

Viewing Different Document Versions
By default, the document details page displays details of a document’s latest version. Follow the instructions below to view the document details for different versions of a document: 1. Click Browse > Categories from the menu bar to open the category browser. 2. Find the desired document in the category browser and click its name. 3. Click the History tab at the top of the document details page (see Figure 70). 4. Click the revision label or the button for the version you want to view in the Revision label column under the Document History area. The document details page now shows the document details for the version you have selected. If you select a version other than the latest version, you will not be able to access the Update tab. Figure 70 Document Details Page - the History Tab

Click the tabs in the document details page to see information about the currently selected version or click the buttons in the document details page to view, validate, or download the selected version of the current document. Note that you cannot edit or delete any document versions other than the latest version. If a previous document version existed in a stage or a category in which you do not have the read permission, you will not be able to access its document details page.
TIBCO XML Canon User’s Guide

88

| Chapter 6

Using Documents

Actions

The Document history section also includes buttons that you can use to perform useful actions: • Show differences allows you to see the differences between two selected document revisions. For more information, see Using the Differencing Engine on page 104. Make selected revision latest reverts to a previous revision of the document. See Making a Previous Document Tag Current on page 136. Lock locks the document so that no other users can make changes. See Locking Documents on page 94. Quick View displays the content of the document in plain text. See Quick View on page 98. Save as downloads the document to your local file system. Validate checks the validity of the selected document. See Validating Documents on page 101. Delete removes the document from the server. Note that, unless you are an administrator, you can only delete unlocked documents that you created. Components displays a list of all the selected document’s components. See Viewing Components on page 124.

• • • • • • •

TIBCO XML Canon User’s Guide

Uploading Documents 89

|

Uploading Documents
If you want to upload a document to a category, your role must have read and write permissions for that category. Documents can be uploaded into any category except the root category. Follow the instructions below to upload a document: 1. Click Browse > Categories from the menu bar. 2. Select the category you want to upload a document to and click on its name. 3. Click the Add document button in the Document Actions area, as shown in Figure 71. Figure 71 The Add Document Button

After the Add document button has been clicked, you will see a document upload page which is similar to the one shown in Figure 72. If custom properties have been added to the TIBCO XML Canon repository, entries for those properties also appear in the document upload page. For more information on how to configure custom properties, see Chapter 16, Configuring Custom Properties, page 255.

TIBCO XML Canon User’s Guide

90

| Chapter 6

Using Documents

Figure 72 Upload Document Page

4. Click the Browse... button at the right of the Local file path field to select a document on your local file system. 5. In the Document Name field, specify the name for the document in TIBCO XML Canon. You may leave the value as default if you want to use the same document name. 6. Fill in the Revision label and the Comment field to clarify the version number and any additional comments you want. 7. In the Stage drop-down list, specify the appropriate stage for this document. The Stage drop-down list displays all stages that a document can transition to. For information on managing document stages, see Managing Documents with Stages on page 97. 8. If custom properties have been added to TIBCO XML Canon, the upload page will also include a Custom Properties area. Check the boxes for properties you want to associate with the document and fill in the properties values. Required custom properties are automatically checked by the server and cannot be unchecked. You must fill in the value of all required custom properties in order to upload your document. 9. Click Add document to finish uploading the document, or Cancel if you do not want to upload a document.

TIBCO XML Canon User’s Guide

Downloading Documents 91

|

Downloading Documents
You can download a document from TIBCO XML Canon to your local file system in the document details page. Follow the instructions below to download a document from XML Canon: 1. Click Browse > Categories from the menu bar. 2. Locate the desired document within the category structure. 3. Click on the name of the document to view its document details page in the right-hand frame. 4. Click the Save as... button at the bottom of any tabs within the document details page. All documents downloaded from TIBCO XML Canon will be in ZIP file format, regardless of their document type.

TIBCO XML Canon User’s Guide

your role must be assigned read. 3. 5. Follow the instructions below to move a document from one category to another: 1. Select the destination category by clicking the button next to it and click the OK button when prompted with a pop-up window. 2. Figure 74 After Clicking on a Document To Be Moved 4. button next to the document you want to move as shown in Figure 73 Before Clicking on a Document To Be Moved The category browser now resembles Figure 74.92 | Chapter 6 Using Documents Moving Documents To move a document. this operation will fail with an error message in the left-hand frame. write. and delete permissions for the source and the target categories. An arrow button should appear to the right of all potential destination categories for the document. Expand the destination category to verify that you have successfully moved the document. Note that the selected document is now highlighted. TIBCO XML Canon User’s Guide . Locate the desired document within the category structure. Click on the Figure 73. If you do not have the right permissions for the document’s source or destination categories. Click Browse > Categories from the menu bar to open the category browser.

You can only delete one document at a time from the TIBCO XML Canon web interface. To maintain the referential integrity of tagged categories and documents. Click Browse > Categories from the menu bar to open the category browser. These documents will remain on the server until they are purged. see Purging Deleted Categories and Documents on page 177. see Chapter 9. For more information on WebDAV clients. 4. Click the Ok button when prompted with a pop-up window.Deleting Documents 93 | Deleting Documents You must have delete permission for the document category and its stage in order to delete it. on page 147. 2.. TIBCO XML Canon User’s Guide . TIBCO XML Canon assigns a special tag called deleted to all documents which have been deleted and moves them to a location which can be accessed by a user with the ADMINISTRATOR capability. For information on purging deleted documents. WebDAV support offers an efficient way to delete multiple documents. 3. Click the Delete.. Documents which have been assigned the deleted tag no longer have the latest tag. However. button in the Detailed Views area. Follow the instructions below to delete a document from the web interface: 1. Working with WebDAV Clients. Find the desired document in the category browser and click on the name of the document to view its details page.

However. 3. Once its unlocked. not all WebDAV clients have the check-out and check-in feature. Click Browse > Categories from the menu bar to open the category browser. Follow the instructions below to lock a document: 1. you must lock a document before you download it to your local file system for editing. You must verify the compatibility of your current WebDAV client with TIBCO XML Canon. this document can no longer be modified by other users. After editing.94 | Chapter 6 Using Documents Locking and Unlocking Documents The lock and unlock document mechanisms in TIBCO XML Canon respectively lock and unlock documents on the server. on page 147. When you lock a document on the server. Locking Documents You must have write permission to a document’s category and current stage in order to lock it. for some WebDAV clients. It is imperative that all users follow the practice of locking documents before downloading them to the local file system for editing. For more information on WebDAV clients. the check-out and check-in features may not be compatible with the lock and unlock mechanism in TIBCO XML Canon. 2. Find the document you want to lock and click on the document name to view its details page. you must reload the document using the WebDAV client and unlock the document using the web interface. this document will be available to other users. follow the instructions below to lock and unlock documents appropriately in order to make changes using your WebDAV client. see Chapter 9. Furthermore. This also works with some WebDAV clients’ check-out and check-in features to control your document revisions in TIBCO XML Canon. If they are not compatible. TIBCO XML Canon User’s Guide . Click the Lock button at the bottom of the document details page to lock the document. Working with WebDAV Clients. If your WebDAV does not support locking and unlocking of documents on WebDAV-enabled servers.

you may launch your email client directly from the document details page to email the user who locked the document. However. Figure 75 A Document Locked by Pat 3. TIBCO XML Canon User’s Guide . you will see the name of the user who locked the document at the side of the Locked By attribute at the top of the Properties tab in the document details page (see Figure 75). Click Browse > Categories from the menu bar to open the category browser. Click the Unlock button at the right of the Locked By attribute to release the document lock.Locking and Unlocking Documents 95 | Unlocking Documents Only the user who locks a document and users with the ADMINISTRATOR capability are permitted to unlock the document. 2. Find the locked document in the category browser and click on the name of the document to view its details page. Follow the instructions below to unlock a document: 1. When a document is locked. Note that this button is only available to lock owners and administrators. Click on the name of the user (in blue font) to send an email to this user. See step 2 for more information.

see Managing Documents with Stages on page 97. TIBCO XML Canon User’s Guide . Update the properties in their corresponding text fields and from their drop-down lists. After you update document properties. For more information on changing the document stage. including custom properties.96 | Chapter 6 Using Documents Updating Document Properties You can only update metadata of the latest version of a document. Click the Update tab at the top of the document details page. 4. 2. Click the Update properties button at the bottom of this tab to complete the update. Figure 76 Updating Document Properties 5. Follow the instructions below to update document properties: 1. as shown in Figure 76. Find the desired document in the category browser and click on the document name to view its details page. the document will be saved as a new version. You can update various document properties. Click Browse > Categories from the menu bar to open the category browser. You cannot access the Update tab when you are viewing an earlier version of a document. 3.

Managing Documents with Stages 97 | Managing Documents with Stages This section gives instructions on managing a document life cycle using stages. If you are using a non-TIBCO WebDAV client to save a document in TIBCO XML Canon. TIBCO XML Canon User’s Guide . depending on how stages are configured by an ADMINISTRATOR. For more information on configuring stages. you can transition your XML documents from one stage to another. Configuring Stages. 5. such as TIBCO Designer. The Stage drop-down list displays stages that are configured with a transition from the document’s current stage. If you are loading a document into TIBCO XML Canon via a non-TIBCO WebDAV client. When you first load a document into TIBCO XML Canon. Note that some stages require the document to be well-formed or valid according to the schema before making the transition. This action will prevent an ambiguous initial stage for WebDAV uploads. on page 229. If you are using a TIBCO application with WebDAV client support. 2. Click the Update tab. you need to place it into an initial stage. see Chapter 14. Follow the instructions below to transit a document between stages: 1. To learn more about stages. Otherwise. you will explicitly define a default initial stage in the Personal Options tab of your TIBCO XML Canon home page. Configuring Stages. Click the Update properties button at the bottom to complete the update. you can transit documents between stages whenever you check them into TIBCO XML Canon. See 0 for more information. on page 229. Make sure that your document meets the stage-specific requirements before making the desired transition. see Chapter 14. Find the desired document in the category browser and click on the name of the document to view its details page. 4. 3. Select the stage of where you want to move the document in the Stage drop-down list. As you progress in the development process. Click Browse > Categories from the menu bar to open the category browser. you can specify a default stage in the Personal options tab of your TIBCO XML Canon home page. you can make the stage transition from the Update tab of the document details page.

Click the Quick View button at the bottom of the document details page. Click Browse > Categories from the menu bar to open the category browser. Follow the instructions below to view an XML document using the quick view: 1. These tags are automatically color-coded by the browser depending on their levels. The XML view displays the content of a document in a nesting structure by tags. If the browser recognizes the suffix of the document (for example. . 2. TIBCO XML Canon provides three types of detailed views: • XML view — Available for XML documents only. TIBCO XML Canon User’s Guide . Namespace Presentation — User-defined.pdf).doc or it will display this document in the appropriate application. See Namespace Presentation on page 186 for more information. the browser will show the content in its rendered form. The quick view enables you to view the content of a document in plain text whereas the detailed view enables you to customize your view. • • This section describes the quick view and the two default detailed views. . 3. SchemaDOC — Available for XML schema and DTD documents only. HTML or XHTML). Note that there might be several detailed views available to you depending on your document type. The SchemaDOC view shows the schema down to the element level and displays detailed information about each element including the graphical representation of all descendents of an element.98 | Chapter 6 Using Documents Viewing Document Content There are two ways to view the document content in TIBCO XML Canon: quick view and detailed view. Quick View The quick view allows you to view the content of an XML document in plain text. Find the desired document in the category browser and click on the name of the document to view its details page. You will now see a new browser window displaying the document content in plain text as shown in Figure 77. If the format of the document can be displayed natively by the browser (for example.

SchemaDOC View The SchemaDOC view is available for schemas and DTDs only. Click Browse > Categories from the menu bar to open the category browser. XML View The XML view is for displaying XML documents. XML view and SchemaDOC. 3. Find the desired document in the category browser and click on the name of the document to view its details page. Follow the instructions below to view a schema using the SchemaDOC view: 1. Follow the instructions below to view an XML document using the XML view: 1.Viewing Document Content 99 | Figure 77 Document Quick View Detailed View TIBCO XML Canon provides two detailed views of XML documents by default. Click Browse > Categories from the menu bar to open the category browser. 2. Click XML view in the Detailed Views area. TIBCO XML Canon User’s Guide .

examotion. It also displays the relevant metadata and the indented source code at the bottom of the window. Find the desired document in the category browser and click on the name of the document to view its details page. The RENESIS Player is available as a free download from http://www. Click SchemaDOC in the Detailed Views area. Figure 78 The SchemaDOC View TIBCO XML Canon User’s Guide . 3. This is required to view the SchemaDOC graphical diagrams.com/. Figure 78 shows a SchemaDOC view of a sample schema.100 | Chapter 6 Using Documents 2. You are prompted to install the RENESIS Player. The diagram at the top shows a graphical representation of the breakdown hierarchy structure model of all elements.

you must use TIBCO Designer’s Validate Resource or Validate for Deployment options in order to check the validation of TIBCO ActiveMatrix BusinessWorks project files. Validating in the Document Details Page Follow the instructions below to validate a document from its document details page: 1. 2. you will see a results page that either displays errors (if the document is invalid) or indicates no errors (if the document is valid). and XML validation. TIBCO XML Canon User’s Guide . Validate a document on your local file system by the document path from the Category Details panel. As a result. This option is useful if the document needs to be valid before it is uploaded into a stage which enforces document validation. Click the Validate button at the bottom of the document details page.Validating Documents 101 | Validating Documents The document validation refers to schema checking (such as XSD or DTD syntax checking). 3. Click Browse > Categories from the menu bar to open the category browser. TIBCO XML Canon provides you with two methods to validate these documents: • • Validate a document from its document details page. After the validation process. Find the desired document in the category browser and click on the name of the document to view its details page. Validation is disabled for TIBCO ActiveMatrix BusinessWorks process documents. the Validate button is disabled. 2. Click Browse > Categories from the menu bar to open the category browser. Click the name of any category to view its Category Details panel. Validating in a Category Details panel Follow the instructions below to validate any document on your local file system from a Category Details panel: 1. Therefore.

When resolving public IDs with this option. TIBCO XML Canon will use access paths specified in the DOCTYPE Listing panel first. Click the Browse. Click the Validate Document. TIBCO XML Canon will use the URLs specified in instance documents. TIBCO XML Canon will use the access paths specified in the DOCTYPE Listing panel. To check the validity of BusinessWorks project files.102 | Chapter 6 Using Documents 3. If this fails. If this fails. — Namespace only.. TIBCO XML Canon will use URLs specified in instance documents first. When resolving public IDs with this option. In the Resolution Policy drop-down list. use the TIBCO Designer Validate Resource or Validate for Deployment options. TIBCO XML Canon will try to resolve the schema based on their namespaces URI first. resolution will be attempted based on the value of the schema Location attribute. If this fails. TIBCO XML Canon User’s Guide .. There are four available options in the Resolution Policy drop-down list: — Namespace then location. a. Validation is disabled for TIBCO ActiveMatrix BusinessWorks 5. TIBCO XML Canon will try to resolve the schema based on the value of the schema Location attribute first. — Location then namespace. button in the Document Actions area. select a method that TIBCO XML Canon will use to resolve references to schemas when validating XML documents... b.x process documents. button to locate the document you want to validate. 4. TIBCO XML Canon will try to resolve schema references based only on their namespace URIs. Provide the local file path of the document to be validated and choose one of the resolution policies. If this fails. When resolving public IDs with this option. TIBCO XML Canon uses only the access paths specified in the DOCTYPE Listing panel. resolution will be attempted based on the namespace URI.

5. from 8080 to 8081). if the document is not valid.xml file. After validation. If your TIBCO XML Canon documents make references to other documents in XML Canon using their fully-qualified URLs.. these relations will fail to resolve when the port number of your TIBCO XML Canon server is changed (e. TIBCO XML Canon will try to resolve schema references based only on the value of the schema Location attribute. TIBCO XML Canon User’s Guide . This file and more instructions are located in TIBCO_HOME/xmlcanon/tomcat/conf.. you will see a results page showing all errors within the document. Instead of making changes to your TIBCO XML Canon documents to accommodate the port change. button to start validating the document. you can ask your systems administrator to define port aliases in the server. Click the Validate. TIBCO XML Canon uses only the URLs specified in the instance documents.Validating Documents 103 | — Location only.g. When resolving public IDs with this option.

which enables you to view the differences between two document versions or revisions. It detects an inserted element in the modified version. TIBCO XML Canon User’s Guide . In the Mod (Modified) column. 4. Click the Show differences button at the bottom of the Document History area to launch the XML differencing engine (see Figure 80). Follow the instructions below to view differences between two document versions: 1. 6. Figure 79 Viewing Differences Between Revisions The XML differencing engine compares the modified version to the base version and determines which elements in the modified version differ from the base. select the version you want to use as a modified version to compare to the Base version. select the version you want to use as the base version.104 | Chapter 6 Using Documents Using the Differencing Engine TIBCO XML Canon provides an XML differencing engine. 3. Find the desired document in the category browser and click its name. Figure 80 shows a typical results view of the differencing engine. 2. 5. In the Base column of the Document History area. Click the History tab at the top of the document details page (see Figure 79). Click Browse > Categories from the menu bar to open the category browser.

Refer to the legend under the heading to interpret the results. Expand the result by clicking the button next to each element. 8.Using the Differencing Engine 105 | Figure 80 XML Differencing Engine As shown above. 7. the heading at the top identifies the document and version numbers of the two documents revisions. TIBCO XML Canon User’s Guide .

Click the Update button to apply the subscription. 4. or both. 2. Notification can be received from the server through a web report.106 | Chapter 6 Using Documents Notification Subscription TIBCO XML Canon provides two modes of receiving notifications from the server: the web interface and email. Subscribing to Stages Follow the instructions below to subscribe to a stage for notification: 1. TIBCO XML Canon User’s Guide . Check the appropriate checkbox (or checkboxes) to select the notification method. Stage subscription — Notifies the user when a document moves into a subscribed stage. Click the History tab at the top of the document details page. Click the Personal options tab in the TIBCO XML Canon home page. You can subscribe to be notified of a change in a document or a stage: • • Document subscription — Notifies the user when a subscribed document is modified. 5. 2. 3. Find the desired document in the category browser and click its name. Subscribing to Documents Follow the instructions below to subscribe to a document notification: 1. Click Browse > Categories from the menu bar to open the category browser. email. Click the Home button from the menu bar to open the TIBCO XML Canon home page.

or both. TIBCO XML Canon User’s Guide . Click the name of a desired document from the list to view its document details page. then click the Delete checked. select its Delete checkbox on the left. Viewing Notifications If you subscribed to notification via the web report. an email. Click the Update Notifications button to apply the subscription.. 4. To delete a notification entry.. notifications can be delivered as a web report.. button. you can view the notifications under the Web Report tab of your TIBCO XML Canon home page. Figure 81 Viewing Web Notifications 3.. If you want to delete all notification entries.Notification Subscription 107 | 3. 4. Click the Home button from the menu bar to open your TIBCO XML Canon home page. click the Delete all. button. Select a stage from the drop-down list in the Stage Notifications area and select the notification method. Follow the instructions below to view notifications: 1. Click the Web Report tab in the TIBCO XML Canon home page (see Figure 81). 2. Again.

To search for an exact string. click the Reset button to set all search criteria to the default settings.. Follow the instructions below to search for documents in TIBCO XML Canon: 1. 4. Arithmetic operators (such as <. OR. Figure 82 Document Search Page 3. Type the search string in the appropriate criteria field according to the guidelines below: • Searches are wildcard-based by default (in other words. Click the Search. You can add additional search criteria by selecting items from the Addition Search Criteria drop-down list at the bottom of the document search page. 2. a search string "=inv". place a '=' sign in front of the search string. Otherwise. >) • are supported. on page 109 for a description of each search criterion.108 | Chapter 6 Using Documents Searching for Documents TIBCO XML Canon enables you to search for documents based on a number of search criteria. 5. as shown as in Figure 83. will only return results that match the exact string "inv". The Modify Search link on the top right of the results list returns to TIBCO XML Canon User’s Guide . +. Results are returned in the left-hand frame after the execution. The wildcard operator (*) is not supported. Click Hide next to search criteria to hide criteria that are not applicable to your document search. any document with a matching substring will be returned). Search Criteria. Active custom properties applicable to documents will also appear in the Additional Search Criteria drop-down list. Click Search > Documents from the menu bar to access the document search page (see Figure 82). For example.. See Table 4. button when you are ready to execute your query. Boolean operators (such as AND. |) • • are not supported.

Use part of the name to carry out a wildcard search or use the '=' sign (For example. Table 4 Search Criteria Name Document tag Description Put a document into user defined groups and allow searches based on tag collection. Search for documents that contain the specified string which sandwiched by schema-level documentation tag or tags. such as XML Schema. =docName) to carry out an exact match of the name.Searching for Documents 109 | the search page with all your previous search selections ready for modifications whereas the New Search link on the top left of the results list opens a new document search page. Document name Document type Analyzed Documentation TIBCO XML Canon User’s Guide . The default tag is Latest. Search for documents that contain the specified string in the document’s name. TIBCO XML Canon sorts the results into alphabetical groups according to the first two letters of the document’s name. Choose a state from the drop-down list. WSDL and TIBCO ActiveMatrix BusinessWorks Process Definitions (process documents). Search for documents of a particular type. You can view a different alphabetical group by clicking on its corresponding link in the grouping table above the results list. Search for analyzed documents in a particular state. which includes the current revision of all documents in TIBCO XML Canon. Figure 83 Search Results 6. DTD. Click on the desired document’s name from the results list to view its document details page.

110

| Chapter 6

Using Documents

Table 4 Search Criteria Name Application information Category name Comment File size Target namespace Root namespace Mime type Modification date Stage Revision label User Locked by user Description Search for documents that contain the specified string which sandwiched by schema-level Application Information tag or tags. Search for documents within a particular category. The default is blank, which would yield results from the entire repository. Search for documents that contain the specified string which sandwiched by Comment tag or tags, or meta-comment. Search for documents by size. For example, the string ">10000" returns all documents larger than 10,000 bytes. Search for documents that contain the specified string in the target namespace attribute. Search for documents that contain the specified string in the root namespace. Search for documents of a particular MIME type. Choose a MIME type from the drop-down list. Search for documents according to the Saved Date attribute. Search for documents in a particular stage. The default is represents documents in all stages.
blank,

which

Search for documents that contain the specified string in the document Revision label. Search for documents that were last modified by a specific user. Searches for documents that are currently locked by a specific user.

TIBCO XML Canon User’s Guide

Accessing Documents via URL 111

|

Accessing Documents via URL
Each document in TIBCO XML Canon has an unique URL. When a WebDAV client connects to TIBCO XML Canon, it accesses documents using their URLs. If you know how URLs in TIBCO XML Canon are formulated, you can access documents from your WebDAV clients directly without browsing through the category hierarchy. You may also type a document URL into your web browser to view your TIBCO XML Canon document directly without using the category browser. The ability to view XML documents in web browsers is browser-dependent.

Documents revisions that are tagged also have unique URLs and can be accessed as read-only documents. This is useful if different development teams need to use or access different versions of the same document. However, revisions which do not exhibit tags have no URLs and therefore cannot be accessed via URLs. This section illustrates URL access to documents stored in TIBCO XML Canon by using the document root.xsd as an example. This document is located under a category named Level 2. The History tab of this document is shown in Figure 84. Figure 84 The History Tab of root.xsd

TIBCO XML Canon User’s Guide

112

| Chapter 6

Using Documents

Accessing Current Documents Apply the fully-qualified URL format as below to use a URL to access TIBCO XML Canon documents:
http://<hostName>:<portNumber>/<categoryPath>/<documentName>

In this example, root.xsd is accessed using the following URL:
http://xmlcanon.example.com:8080/Level%201/Level%202/root.xsd

Note that all space characters in the URL string are replaced with the instance, category Level 1 is changed to Level%201 in the URL. Accessing Tagged Documents

%20

. For

You can access tagged documents by preceding the category path with tag/ followed by the tag name. Follow the fully-qualified URL format below to access tagged versions of TIBCO XML Canon documents:
http://<hostName>:<portNumber>/tag/<tagName>/<categoryPath>/<documentName>

In the example, root.xsd has four tags: Latest, test123, V2, and Beta. Each tagged version is accessed with its URLs respectively as below.
http://xmlcanon.example.com:8080/tag/Latest/Level%201/ Level%202/root.xsd http://xmlcanon.example.com:8080/tag/test123/Level%201/ Level%202/root.xsd http://xmlcanon.example.com:8080/tag/V2/Level%201/ Level%202/root.xsd http://xmlcanon.example.com:8080/tag/Beta/Level%201/ Level%202/root.xsd

Note that the current version of a document can be accessed with or without using the tag format. In the example below, both URLs are referring to the same document version:
http://xmlcanon.example.com:8080/Level%201/Level%202/root.xsd http://xmlcanon.example.com:8080/tag/Latest/Level%201/ Level%202/root.xsd

Un-authenticated URL Access
TIBCO XML Canon can also make documents available for un-authenticated URL access. This allows TIBCO XML Canon to act as a schema server for external validating parsers or other external applications. This feature enables any documents or applications to make reference to schemas in TIBCO XML Canon directly by specifying the schema URLs.

TIBCO XML Canon User’s Guide

Accessing Documents via URL 113

|

TIBCO XML Canon permits un-authenticated URL access to documents by means of a special Web user, which belongs to the Web role. Whenever an external application requests a document using a URL, it precedes the category path with pub/. The application is accessing TIBCO XML Canon anonymously as a Web user. By design, the Web user has only read permission to the TIBCO XML Canon repository. An administrator can further limit the Web user’s access to document, or disable the entire feature. For more information about the Web user and the Web role, see Users Overview on page 216 and Default Roles on page 199. If you would like to reference an external document or application schema stored in TIBCO XML Canon, use the following URL format (recommended):
http://<hostname>:<portnumber>/pub/<categoryPath>/<documentName>

In the example, following URL:

root.xsd

can be accessed without user authentication via the

http://xmlcanon.example.com:8080/pub/Level%201/Level%202/root.xsd

Likewise, the tagged versions of root.xsd can be accessed without authentication via the following URL:
http://xmlcanon.example.com:8080/pub/tag/Latest/Level%201/ Level%202/root.xsd http://xmlcanon.example.com:8080/pub/tag/test123/Level%201/ Level%202/root.xsd http://xmlcanon.example.com:8080/pub/tag/V2/Level%201/ Level%202/root.xsd http://xmlcanon.example.com:8080/pub/tag/Beta/Level%201/ Level%202/root.xsd

Backward compatibility for URL access can only be achieved by using the following format:
http://<hostname>:<portnumber>/xc/canon/<categoryPath>/<documentName>

TIBCO XML Canon User’s Guide

114

| Chapter 6

Using Documents

TIBCO XML Canon User’s Guide

| 115
Chapter 7

Components

This chapter describes how to view and search components in TIBCO XML Canon.

Topics
• • • • • • Components Overview, page 116 Component Browser, page 119 Component Details Page, page 120 Viewing Components, page 124 Searching for Components, page 125 Editing Custom Properties for Components, page 128

TIBCO XML Canon User’s Guide

entity. markup text. In general. where the content only includes characters. It allows you to search for components transparently. A user with the ADMINISTRATOR privilege can also force a logical analysis on documents in the repository. WSDL.116 | Chapter 7 Components Components Overview Components are building blocks which make up the abstract data model of XML Schema. Table 5 Indexed Components in TIBCO XML Canon Component Elements Description The basic building blocks of XML markup. TIBCO XML Canon User’s Guide . below. WSDL. Component Types Table 5. and other logically analyzable documents. Components that are declared within elements to add information by appending simple properties to them. For more information on component searching. Collectively. TIBCO XML Canon creates a searchable dictionary of all the components in the repository. simple data type (such as string). processing instructions or PIs comments. see Analyzing Documents for Components on page 182. and TIBCO ActiveMatrix BusinessWorks Process Definition documents. TIBCO XML Canon analyzes schemas. lists components indexed by TIBCO XML Canon. see Searching for Components on page 125. Phantom Element Attributes Simple Types A presumed element declaration in DTD documents. allowing you to browse and easily search through all documents and components. A primitive. or character references. Component search is one of the most powerful features of TIBCO XML Canon. Elements serve as containers for character data. you cannot find this element in well-designed DTD documents. the various items that make up an element are known as its content. DTDs. DTD. and for every version. A content model of an element defines the element's structure. After that. This is achieved by analyzing schemas and XML documents during their check-in. It only contains ATTLIST declarations but does not contain any ELEMENT definition. and other elements. TIBCO XML Canon server logically analyzes the document in order to catalog its constituent components during its initial load. For more information.

but possibly containing attributes) mixed content text-only (containing a combination of elements. Similar to an IPE whose declaration in a DTD contains a reference to a parameter entity external to the DTD. Unparsed EGEs allow documents to reference external non-XML data. It may optionally have a public identifier based on the Formal Public Identifier syntax used in SGML.Components Overview 117 | Table 5 Indexed Components in TIBCO XML Canon Component Model Group Attribute Group Complex Type Description The collection name for elements which are grouped together for easy reference in an XML document. A storage unit for DTD content. EPEs are often used to modularize schemas and access the schema modules selectively from an external schema. An element that contains other elements or attributes. TIBCO XML Canon User’s Guide . and text) (containing only text) A name-value storage unit that is declared in an XML document and referenced within the document for repeating content or for content that changes regularly. but its content is defined in an external location. A name-value storage unit that is declared and referenced like IGEs. which can be a file name or a URL respectively. The collection name for attributes which can appear in more than one element in an XML document. four kinds of elements have complex type: • • • • Internal General Entity (IGE) External General Entity (EGE) Internal Parameter Entity (IPE) External Parameter Entity (EPE) element-only (containing only other elements or attributes) empty (containing no other elements or text. A name-value storage unit for DTD content which is declared and referenced locally by the DTD for repeating content or for content that changes regularly. attributes. An EPE is where the content of the entity (for instance. An EGE may be parsed or unparsed. For example. an entity value) is stored. It has a name and a system identifier. in the XML Schema.

TIBCO XML Canon User’s Guide .118 | Chapter 7 Components TIBCO ActiveMatrix BusinessWorks and WSDL Components In addition to the logical analysis of the standard schema and DTD components. Refer to TIBCO ActiveMatrix BusinessWorks and TIBCO Designer documentation for more information on WSDL and TIBCO ActiveMatrix BusinessWorks process definition components. TIBCO XML Canon also analyzes WSDL documents and TIBCO ActiveMatrix BusinessWorks process definition documents.

Component Browser 119

|

Component Browser
When you access components of a selected document via the Components... button in the document details page, the component browser will display a list of document components and their types. Components are grouped alphabetically for easy browsing. The components are grouped according to the first two letters of the component name. These links of component groups are at the top of the component list. Figure 85 shows a typical Component browser which is found on the left-hand frame of the browser window. Figure 85 A Component Browser

Click on the name of a component to see its component details in the right-hand frame. For the description of a component type, see Components Overview on page 116.

TIBCO XML Canon User’s Guide

120

| Chapter 7

Components

Component Details Page
The component details page shows the details of a component, including its metadata and all of its relationships to other documents and components in TIBCO XML Canon. Figure 86 is a typical default view of a component details page in TIBCO XML Canon. Figure 86 Component Detail Page - The Component Metadata Tab

There are three tabs at the top of the component details page which describe the component details. For an overview of each tab, go to the respective sections listed below. • • • Component Metadata, page 120 Document Relationships, page 121 Component Relationships, page 122

Component Metadata
The Component Metadata tab (shown above in Figure 86) is the default tab when you open the component details page. You can view all metadata for the component under the Component Metadata tab. Table 6 shows a list of the component metadata and their descriptions. Table 6 Component Metadata Attribute Name Namespace Type Description The name of the component. The namespace to which the component belongs (if any). The type of the component (such as element and attribute).

TIBCO XML Canon User’s Guide

Component Details Page 121

|

Table 6 Component Metadata Attribute Defining Document Stage Defining Component Documentation Description The document which defines the component. The stage in which the component’s defining document resides. The defined context of the current component. For example, if the current component is a top-level component, then the value of this attribute is Top Level Component. Any documentation for the component in the defining document (such as XML comments in DTD and the value of the <annotations> tag in XSD). The content in the component’s <appInfo> tag in XSD.

Application Info

In addition, the Component Metadata tab includes a Custom Properties area, which represents user-defined metadata that can also be added to the component. You can add custom properties at the component level by clicking Edit. See Editing Custom Properties for Components on page 128 for more information.

Document Relationships
The Document Relationships tab enables you to see all documents which are related to the current component, including its defining documents and documents which use or refer to this component. Figure 87 Component Details Page - Document Relationships Tab

The Document Relationship tab displays the related Document name, Version, Stage, and Owner.

TIBCO XML Canon User’s Guide

122

| Chapter 7

Components

Component Relationships
The Component Relationships tab displays all components which are related to the current component, including components which use or refer to this component. Figure 88 Component Details Page, The Component Relationships Tab

Click the name of any related component under the Component Relationships tab to view its component relationships. You can either view the component details of this related component by clicking on the three tabs in its component detail page, or select the name of a related component to view other component relationships. This feature enables you to navigate through all the related components in the component details pages. The top section shows all components that are used by the current component. Table 7 lists the metadata for these components. Table 7 Metadata for All Components that are Used by the Current Component Attribute Name Role Type Namespace Description The name of the component being used. Indicates how the component is used by the current component. The type of the component being used. The namespace of the component being used.

The bottom section shows all components that use the current component. Table 8 lists the metadata for these components. Table 8 Metadata for All Components that Use the Current Component Attribute Usage Role Description Indicates how the current component is used.

TIBCO XML Canon User’s Guide

Component Details Page 123

|

Table 8 Metadata for All Components that Use the Current Component Attribute Type Used By Used from Namespace In Document Relationship Description The type of the component that uses the current component. The name of the component that uses the current component. The namespace of the component that uses the current component. The defining document of the component that uses the current component. The relationship of the current component to the component that uses it.

TIBCO XML Canon User’s Guide

124

| Chapter 7

Components

Viewing Components
Follow the instructions below to view the components of a document: 1. Click Browse > Categories from the menu bar to open the category browser. 2. Click on the desired document name in the category browser to view its document details page. Alternatively, you can perform a document search to access the desired document. 3. Click the Components... button at the bottom of the document details page (see below) to open the component browser window. For more information on the component browser, see Component Browser on page 119. If this document is not a DTD or schema, the Components... button will not appear in its document details page.

4. Click on the name of a component to open its component details page in the right-hand frame. For more information about the component details page, see Component Details Page on page 120.

Viewing Components in Different Document Versions
Follow the instructions below to view components in different versions of the same document: 1. Follow the instructions in Viewing Different Document Versions on page 87 to open a document details page to view a different version of the document. If a version is located in a stage or category which you do not have the read permission, you will not be able to access its document details page or its component browser. 2. Click the Components... button at the bottom of the document details page to open the component browser window. 3. Click on the name of a component to open its component details page in the right-hand frame. For more information about the component details page, see Component Details Page on page 120.

TIBCO XML Canon User’s Guide

See Table 9 on page 127 for a description of each search criteria. Add search criteria by selecting them from the Additional Search Criteria drop-down list at the bottom of the search page. 4. the wildcard operator (*) is not supported. Boolean operators (such as AND. component type. For example. OR. Figure 89 Component Search Page Like the document search page. +. Type the search string in the appropriate criteria field according to the following guidelines: • Searches are wildcard searches by default. including default metadata and custom properties. any document with a matching substring is returned. the component search page also allows you to search for components using many search criteria. a search string "=inv" would only returns results that exactly match the string "inv".Searching for Components 125 | Searching for Components Follow the instructions below to search for components in TIBCO XML Canon: 1. Click the Search button to view the result. Click Search > Components from the menu bar to open the component search page. Hide criteria that you do not want to see or use by clicking Hide to the right of the criteria (see Figure 89). |) >) • • • are not supported. Active custom properties which can apply to components are also located in the Additional Search Criteria drop-down list. Arithmetic operators (such as <. and its defining document. TIBCO XML Canon User’s Guide . Use a '=' sign in front of the searching item to search for an exact match. 2. Its display includes the component name. are supported. 3. The search result is displayed in the left-hand frame (see Figure 90). For example. However.

Click on the name of a defining document to view its document details page in the right-hand frame. You can choose four different actions from the search result list: • • • • Click on a component name in the results list to view its component details page in the right-hand frame.126 | Chapter 7 Components TIBCO XML Canon sorts the results into groups alphabetically by the first two letters of the document’s name. You can navigate through the results list by clicking on different alphabetical groups above the results list. Click New search at the top left of the results frame to begin a new component search. TIBCO XML Canon User’s Guide . Click Modify search at the top right of the results frame to modify your search criteria for another search query. 5. Figure 90 Search Results You must have the read permission for the category and stage of the component’s defining document to view this component.

Searching for Components 127 | Table 9 Component Search Criteria Criterion Component name Component type Documentation Description Search for a component by its entire name or part of its name. The default tag is Latest. which represents documents in all stages throughout the repository. You can search by its entire name or part of its name. which includes all current documents in the TIBCO XML Canon repository. Search for components that contain application information strings within the <appInfo> tag of an XSD schema document. Search for components in documents of a particular document type (such as XSD). attribute. and simple type). Search for components that contain commentary strings in an XML comment or in the <documentation> tag of an XSD schema document. Search for components that belong to namespaces. Search for components in documents which belong to the specified stage. Search for components by the tag of their defining documents. The default is All stages. Search for components of a particular type (such as element. Search for all components in defining documents by the defining document’s name. Document name Application information Stage Component namespace Document type Document tag TIBCO XML Canon User’s Guide . You can search for the exact name or part of the name.

Select the custom property you want to apply to the component from the Use column. Each property in the list is preceded with a checkbox under the Use column.128 | Chapter 7 Components Editing Custom Properties for Components You can add. Click on a component name from the component browser or the search results set to view its component details page. 2. clear the corresponding checkbox. 3. Type or select the desired value for each custom property to be applied. For more information on custom properties. Figure 91 Editing Custom Properties for Components The right-hand frame will now display all custom properties applicable to the components. TIBCO XML Canon User’s Guide . remove. 5. 4. Configuring Custom Properties. Find the desired component in TIBCO XML Canon from a document details page (see Viewing Components on page 124) or use the component search tool (see Searching for Components on page 125). see Chapter 16. and edit custom properties at the component level in the component details page. Follow the instructions below to edit custom properties for components: 1. the property value may be a text-free field (Memo type) or a drop-down list (Enumeration type). Depending on the customer property type. Click Edit in the Custom Properties area under the Component Metadata tab (See Figure 91). If you want to delete a custom property. on page 255.

Click the Update button to update all the custom properties of the components. Before step 6. Changes to custom properties will now show in the Custom properties area under the Component Metadata tab. TIBCO XML Canon User’s Guide .Editing Custom Properties for Components 129 | 6. you can always reset all values to default settings by clicking the Reset button.

page 134 Browsing By Tags.130 | Chapter 8 Using Tags Chapter 8 Using Tags This chapter describes how to use tags in TIBCO XML Canon. Topics • • • • • Tags Overview. page 142 Removing Tags. page 145 TIBCO XML Canon User’s Guide . page 140 Viewing Documents via URL with Tagging Information. page 131 Assigning Tags.

see Accessing Documents via URL on page 111. each revision group (under the same tag) will be accessible at the same time via their unique URLs. Most version control systems (VCS) use tags. and does contain any spaces. Latest or The Latest tag is assigned to the most current revision of every document in TIBCO XML Canon. it allows you to label. underscore (_). It is a string identifier and has the maximum length of 256 characters. In TIBCO XML Canon. The unique property makes a tagged document accessible to its consuming applications even if the name of the document or its host category changes in a later revision. This string consists of alphanumeric (A-Z0-9). recognizing. the combination of tagging and cloning is the functional equivalent of branching in VCS which makes TIBCO XML Canon function as a version control repository. Other features like logical analysis and staging allows XML Canon to function above and beyond the common VCS. Tagging is an association between a label and a document or category in TIBCO XML Canon. For more information on accessing tagged documents via URLs. You can capture a document or a set of documents at a moment in time or logically classify a set of documents into one group by a single tag. Tag Nomenclature The rules of naming tags are defined as follows: • The name of the tag must be meaningful. dash (-). • • Tag Characteristics Tags in TIBCO XML Canon have the following characteristics: • • Each document in TIBCO XML Canon must have one of two tags: Deleted. and identifying mechanism. If a document has multiple tags during its development cycle. The tag information can be used to access external documents or applications using unique URLs. The case of the tag depends on the database configuration. identify.Tags Overview 131 | Tags Overview Tagging in general is a labelling. TIBCO XML Canon User’s Guide . and recognize a particular revision of a document or a set of documents effectively. the tag name will also be case-sensitive. If the database you are using is case-sensitive. In fact. This URL contains information specific to the tag.

the assigned tag stays with the same document version despite the document status. • The emerald icon (green. Furthermore. The Delete tag will be marked on a category instead of the Latest tag after it has been deleted but before purging.132 | Chapter 8 Using Tags • When a tagged document is deleted from TIBCO XML Canon. A single document revision can have multiple tags. Although a document can have more than one tag. TIBCO XML Canon User’s Guide . there are two symbols which represent two status of a tag in category details view. the same tag cannot be assigned to more than one version of the same document. This document will remain in the repository until it is purged. You can only assign tags to the most current document version (with the exception of the Latest tag). • • • • • Tags in the Category Detail View Tag details are located in the category details view. providing you have the permission to remove tags. Tags can be assigned to categories in XML Canon. The details view lists all tags which have been assigned to the category. it is assigned the Deleted tag instead of the Latest tag. diamond-shaped symbol) represents a fixed tag which cannot be removed (such as the Latest tag and the Delete tag). the Tags property offers a mechanism for removing tags. Figure 92 The Tag Property in the Category Details View As you see in Figure 92. Tags assigned to earlier document revisions can be reassigned to the most current version (Latest). However. including the Latest tag (see Figure 92).

In other words. or use the tag field to enter the name of an existing tag. Categories). Changing the category name will not affect the original category tagging.Tags Overview 133 | • The red. see Removing Tags on page 145. You will only see the X-shaped button if you are a member of a role that has permission to remove tags. For more information on tagging permissions. see Tag Permissions on page 198. when you assign a tag to a category (or a document within the category). This means that you can always access the original category via its tags. You can pick a tag from the Current Tags link under the Tagging area. TIBCO XML Canon User’s Guide . X-shaped button to all user-assigned tags. even to administrators. Figure 93 The Tagging Area The category details view also includes a Tagging area for assigning tags to the selected category. For more information on removing tags. represents removable tags and is displayed next This button is hyperlinked to a tag removal mechanism. the server implicitly tags all ascendant categories up to the root (not including the default container. A warning message then appears to confirm whether you want to remove the tag from the category. Assigned tags percolate upward to the base category under Categories. ALL tags assigned to the selected category and its sub categories will be displayed (see Figure 93). You can remove a tag by clicking on the red X. This permission is not granted by default.

see Roles Overview on page 196. the revision must be currently assigned the latest tag in order to assign a tag to an earlier revision of a document.134 | Chapter 8 Using Tags Assigning Tags This section provides instructions on assigning tags to documents and categories in TIBCO XML Canon. Follow the instructions below to assign a tag to a document revision: 1. • • • You must have the assign tagging permission to assign tags to documents. However. since each tag in TIBCO XML Canon is unique and identifies a particular revision of a document. You must have the remove tagging permission to delete tags from documents. TIBCO XML Canon User’s Guide . 3. For more information on tagging permissions. Click on the document name to view its document details. Therefore. You may assign multiple tags to one document revision. 2. You need to have all three permissions above to complete the remaining functions described in this chapter. you may not assign the same tag to two different revisions of the same document. View the revision history of the document under the History tab. You can assign a tag to a document (see Assigning Tags to Documents on page 134) or a set of documents under the same category (see Assigning Tags to Categories on page 139). Assigning Tags to Documents Tags can only be assigned to the latest revision of documents. You must have the reassign tagging permission to assign a new tag to a previously tagged revision. Note that the highlighted version is assigned the Latest tag by default (see Figure 94). Click Browse > Categories from the menu bar to open the category browser.

In Figure 95. Figure 95 Select the First Revision Under the History Tab 5. you must highlight the revision you want to tag by selecting the adjacent document icon button (next to the Revision label). Note that you do not have access to the Update tab of the document details page since you cannot update its metadata. TIBCO XML Canon User’s Guide . If you do not want to tag the most current revision.1 has been selected for tagging.Assigning Tags 135 | Figure 94 Three Revisions under the History Tab 4. Select the Properties tab to view the properties of the highlighted revision. the document with Version # 2 and Revision label 1.

use the Search function to locate a category. one way to make a previous document current is to assign the Latest tag to a previous version. Click on the document name to view its details. To make an earlier revision current: 1. the tag is implicitly assigned to its category as well as to all ascendant categories. dashes. as shown in Figure 96. Click Browse > Categories from the menu bar to open the category browser. View the history of this document under the History tab.) 2. Making a Previous Document Tag Current The Latest tag can be used as an indicator of whether a document is the most current one. The added tag name is now displayed in the Tags list of the selected revision. Note that the highlighted version is tagged with Latest by default. 4. TIBCO XML Canon User’s Guide . Note that the Make Selected Revision Latest button is now active. 8. Type the name of an existing tag. or select a tag from Current Tags in the Tagging area at the bottom of this tab. numbers. The Make Selected Revision Latest button is deactivated because the highlighted version already represents the latest version. all the way up to the root category. Therefore.136 | Chapter 8 Using Tags 6. and underscores. When a document is assigned a tag. 3. Review the document revisions under the History tab. Highlight the revision (or tag) you want to make current by clicking on its corresponding document button. Click the Update button to complete the tag assignment. 7. (Alternately. The name of the tag must be less than 256 characters in length and must contain only letters.

Assigning Tags 137 | Figure 96 Before Clicking the Make Selected Revision Latest Button 5. An older revision of the document has now been made current (or. as shown in Figure 97). assigned with the Latest tag. Click the Make Selected Revision Latest button. click the Go Back To Make Changes button to return to the History tab. 7. You can verify the result under the History tab. in other words. Figure 97 After Clicking the Make Selected Revision Latest Button 8. TIBCO XML Canon User’s Guide . Unlock the Latest revision of this document. If you received the error message explained above because the document was not locked. 6.

You can verify the result under the History tab: TIBCO XML Canon User’s Guide . Select the Properties tab to view the revision details. Click on a document name to view its document details. 3. 8. 2. Click Browse > Categories from the menu bar to open the category browser. To reassign a document tag: 1.138 | Chapter 8 Using Tags Reassigning Tags to Documents Reassign is an XML Canon tag permission which allows users to assign a new tag to a document revision which has already been tagged. This function can only be applied to one document at a time.1. Click the Update button to complete the tag assignment. Assign the revision with an existing tag under the Tagging area. 4. 6. The OldRevision tag is now assigned to revision 1. Click on the document icon button corresponding to the revision you want to assign a new tag to. or select a tag from the Current Tags link in this area. View the history of this document including its tag record under the History tab. 5. Type the name of a new or existing tag. 7.

numbers. Click Browse > Categories from the menu bar to open the category browser. TIBCO XML Canon User’s Guide . 5. The tag has been applied to the latest revision of all documents in this category. and underscores. Follow the instructions below to assign a tag to all documents within a category: 1. Select a category you want to tag from the category browser and view its Category Details panel. The name of the tag must be less than 256 characters in length and can contain only letters. Type the name of an existing tag. you can assign tags to their parent categories instead.Assigning Tags 139 | Assigning Tags to Categories In order to tag documents in TIBCO XML Canon more efficiently. You can verify the result by viewing their document details pages. 3. assigning a tag to a category captures the latest revisions of its documents. dashes. This tags all the document groups under the category. In effect. 2. 4. Click the Update button to complete the tagging operation. or select a tag you want to assign from Current Tags in the Tagging area.

Browsing Categories by Tags Follow the instructions below to browse categories by a specific tag: 1. 3. Select the name of the tag you want to use as a filter for categories. The default value is Latest. Click on the tag link on the top-right to launch the tag picker. and represents metadata (properties) of documents and their categories. 2. Click Browse > Categories from the menu bar to open the category browser.140 | Chapter 8 Using Tags Browsing By Tags Tagging is an useful filtering mechanism for browsing categories or namespaces. It acts as a marker of a specific revision of documents. or searching for documents or components. You can classify the category by tag by changing the value in the by tag option. The tag name linked to the tag picker is a pop-up window that displays all available tags in TIBCO XML Canon. Furthermore. the value of the by tag option is changed to the selected tag. TIBCO XML Canon User’s Guide . The tag picker pop-up window closes and documents and categories assigned to the tag (explicitly or implicitly) will be displayed in the category browser.

txt With Tag http://<hostname>:<portnumber>/pub/tag/M yTag/CatA/CatB/doc. These users will not be able to modify documents or their tags. assume we have a document on the category path /CatA/CatB/doc.txt which has been tagged with MyTag. but note that the paths are different. refer to Web (Un-authenticated) User on page 219.Browsing By Tags 141 | Tags and Authentication Web users (and other unauthenticated users) can sometimes browse documents by tag without being asked for a username or password. TIBCO XML Canon User’s Guide . For more information on the Web user. As an example of the interaction of authentication and tagging.txt Authenticated http://<hostname>:<portnumber>/ CatA/CatB/doc.txt http://s<hostname>:<portnumber> /xc/canon/CatA/CatB/doc.txt http://<hostname>:<portnumber>/tag/MyTag /CatA/CatB/doc.txt Both authenticated and non-authenticated users can use tags to browse documents. The availability of this document via URL to an authenticated and non-authenticated user is as follows: Table 10 URL Access to Documents User No authentication No tag ("latest" tag is implied) either: http://<hostname>:<portnumber>/ pub/CatA/CatB/doc. Non-authenticated users will only be able to view documents and categories that the Web user has permission to see.

whereas the Latest tag is an implicit tag in the tags column. TIBCO XML Canon only permits access to the latest document version.xsd For the most current version (with the latest tag). Figure 98 shows the history of an XSD Schema in TIBCO XML Canon.142 | Chapter 8 Using Tags Viewing Documents via URL with Tagging Information Without tagging. the tagging function enables you to access a specific revision of a document by way of a tag-specific URL. The t1 and t2 tags are user-assigned tags.xsd TIBCO XML Canon User’s Guide . use: http://xmlcanon:8088/tag/Latest/MyTestProject/XSDs/alpha. Figure 98 Document History in TIBCO XML Canon Use the following URL format to access any of the tagged versions: http://<hostName>:<portNumber>/tag/<tagName>/<categoryPath>/<documentName> To access the document with the t1 tag: http://xmlcanon:8088/tag/t1/MyTestProject/XSDs/alpha. However.xsd To access the document with the t2 tag: http://xmlcanon:8088/tag/t2/MyTestProject/XSDs/alpha.

xsd The latest document revision can be accessed by two URL formats: http://<hostName>:<portNumber>/<categoryPath>/<documentName> http://<hostName>:<portNumber>/tag/<latest>/<categoryPath>/<documentName> The tag-specific URL is a very useful feature because it enables external documents or applications to access different revisions of the same document in TIBCO XML Canon. Use the following URL to access the document invoice. The figure below shows a typical example of a TIBCO XML Canon category browser.xsd in its latest revision: http://xmlcanon:8088/BW%20Projects/BW%20Test_02/XSDs/invoice.xsd A revision of invoice. you can use the document WebDAV path because it implicitly links to the latest revision: http://xmlcanon:8088/MyTestProject/XSDs/alpha. BW Test_01 and BW Test_02. TIBCO XML Canon User’s Guide . There are two subcategories under the BW Projects category which represent two BW projects.xsd which is tagged t1 can be viewed using: http://xmlcanon:8088/tag/t1/BW%20Projects/BW%20Test_02/XSDs/invoic e.xsd A URL can only be applied to user-defined categories. This manual will explain category depth using the subcategory of BW Test_02. Category Depth The document path used in a TIBCO XML Canon category can also be used in a Unix file system. The root server category (Categories) is not part of the category path. XSDs and all documents under XSDs as an example. The document URL reflects the hierarchical structure in the repository by separating individual categories with a forward slash '/'.Viewing Documents via URL with Tagging Information 143 | Alternatively.

You must replace all space characters in URLs in order to access the document if your application does not process the space character automatically. TIBCO XML Canon User’s Guide . Consult your XML Canon administrator if you are unable to access a document via an URL. use: http://xmlcanon:8088/My%20XSDs/address. to access the address. See Specifying URLs in WebDAV Clients on page 153 for more information. TIBCO XML Canon allows external applications to access a document within the server. the access URL may be different.144 | Chapter 8 Using Tags Hints for Using a URL with Tagging Information Common web browsers will automatically use %20 to represent the space character in a URL string.xsd document under the My XSDs category. A document stored in TIBCO XML Canon can be located or viewed via its URL. These applications can access documents within TIBCO XML Canon via their URLs by following the format below: http://<hostName>:<portNumber>/pub/<categoryPath>/<documentName> Or. a validating parser might need to locate an XML Schema stored in TIBCO XML Canon to validate an XML stream or instance documents. • • Not all web browsers has the ability to display XML documents. For example.xsd The port number is optional if the server is configured with port 80 or 433. For example. alternately: http://<hostName>:<portNumber>/xc/canon/<categoryPath>/<documentName> WebDAV Clients If you are using a WebDAV client to access a document in TIBCO XML Canon. Access to documents in TIBCO XML Canon via URL is permission-dependent.

4. including administrators. you will only see the green diamond-shaped icon next to the tag. This permission is not granted by default to any role. Tags can be removed from individual documents on their document details pages. Open the Properties tab. If a document has been untagged under a host category. 5. For more information on tagging permissions. an administrator must update the tagging permissions in the role details page. In the Document properties section. 2. Removing Tags from Documents Follow the instructions below to remove a document tag: 1. 3. Select a document from the document browser to view its details page. If you do not have remove permission. the rest of tags in this category will remain. see Tag Permissions on page 198. Click Browse > Categories from the menu bar to open the category browser. Removable tags will be marked with an X-shaped button next to the tag name in the document or category details view. select the tag you want to remove and click the button next to the tag name. To assign a tag remove permission. Confirm the tag removal by clicking the OK button in the pop-up dialog.Removing Tags 145 | Removing Tags Your role must have the remove permission in order to remove tags from documents or categories in TIBCO XML Canon. or from a collection of documents by way of the category details page for their host category. TIBCO XML Canon User’s Guide .

select the tag you want to remove and click the button next to the tag name. 3. A category may contain documents which have been assigned various tags. TIBCO XML Canon User’s Guide . 1. Confirm the tag removal by clicking the OK button in the pop-up dialog. depending on the complexity of your project. Select a category from the category browser to view its Category Details panel. Follow the instructions bellow to remove a tag from a category. Click Browse > Categories from the menu bar to open the category browser. For more information on browsing categories by tags. Removing tags from a large number of documents can be time consuming. In the Category details section. It may take several minutes to complete. Therefore.146 | Chapter 8 Using Tags Removing Tags from Categories You can implicitly remove a tag from all documents under the same category by removing the tag from the Category Details panel. 4. you must be aware of the impact of tag removal and ensure that you want to move the tag from all documents under this category. see Browsing By Tags on page 140. 2.

page 155 Using Windows Web Folders. page 151 Using TIBCO XML Canon with WebDAV Clients. page 166 TIBCO XML Canon User’s Guide . Topics • • • • • • WebDAV Support in TIBCO XML Canon. page 148 WebDAV Client Overview. page 157 Using TIBCO Designer as a WebDAV Client.| 147 Chapter 9 Working with WebDAV Clients This chapter describes how to use WebDAV clients to access and perform WebDAV operations in TIBCO XML Canon. page 161 Using XMLSpy as a WebDAV Client.

If the document is left unlocked when dowloaded with the WebDAV client. You must remember to unlock the document after editing. Only the user who locks the document or an administrator can unlock the document through its Document Details page. TIBCO XML Canon User’s Guide . TIBCO XML Canon does not use timeout locks on documents or categories. When a document fails to save. If you cannot save documents via a WebDAV client. you will receive an error message which varies from client to client. WebDAV and Version Control WebDAV does not imply full implementation of version control functionalities as its name suggests. contact your TIBCO XML Canon administrator who will review the TIBCO XML Canon log for the cause of the problem. you can use the document locking mechanism provided by the server through the XML Canon web interface unless the WebDAV client has the built-in locking mechanism. you cannot revise the document from the TIBCO XML Canon web interface. TIBCO XML Canon supports WebDAV and therefore enables the user to edit and manage resources on the server with WebDAV clients. and then to reload the new version via the WebDAV client in order to make it available to other users. The name merely refers to the ability to provide document versioning through a locking mechanism. Before using a WebDAV client to update a document.148 | Chapter 9 Working with WebDAV Clients WebDAV Support in TIBCO XML Canon WebDAV (Web Distributed Authoring and Versioning) is a protocol which extends HTTP to enable users to manage resources located remotely on web servers. Clients can easily edit and manage documents stored on the server through WebDAV. The ability to manage resources in TIBCO XML Canon with WebDAV may vary with the level of support a WebDAV clients offers. This action prevents other users from editing the document while it is being revised. which prevents simultaneous edits to the same document. you must first lock the document in TIBCO XML Canon. WebDAV has the advantages of collaborative authoring and file management. To do so.

and size) when the resource is saved to the server. can be updated via the DAV tab of the TIBCO XML Canon user home page. Custom properties. However. Table 11 Mapping WebDAV Properties to TIBCO XML Canon Metadata WebDAV Property creationdate displayname getcontentlanguage getcontentlength getcontenttype gettag getlastmodified lockdiscovery resourcetype source supportedlock TIBCO XML Canon Metadata Date of the initial document load Name Not supported Size (bytes) Mime type Not supported Last modification date (applies to category only) Locked by (the user who locked the document) Not supported Not supported The Write lock (this is the only lock supported in TIBCO XML Canon) Additional properties captured by TIBCO XML Canon are listed in Table 12. including revision labels and comments. these properties cannot be updated using a WebDAV client. These metadata are then used for filtering search queries in TIBCO XML Canon. TIBCO XML Canon also exposes its custom properties as WebDAV properties. Table 11 lists WebDAV properties and their associated metadata in TIBCO XML Canon. save date.WebDAV Support in TIBCO XML Canon 149 | WebDAV and Metadata TIBCO XML Canon captures a set of metadata about a resource (such as the resource name. TIBCO XML Canon User’s Guide . Most of the metadata captured by TIBCO XML Canon is easily mapped to the corresponding WebDAV properties.

The governing namespace information of a document. Properties marked with an * are optional. The revision number of the document. Identifies the document’s current stage. stageName revision analyzed schemaType documentation appinfo rootNamespace governingNamespace conformingStage* TIBCO XML Canon User’s Guide . comment and custom properties are updated through the DAV tab in the home page of the TIBCO XML Canon web interface. States if the document has been analyzed. The root namespace information of a document. XML schema type such as XSD (XML Schema Definition) and DTD (Document Type Definition). If this identifier is specified by the client. They may be supplied by the user either through the TIBCO XML Canon web interface via the Document Detail page or through a WebDAV PROPPATCH request. It returns the content of <annotation> as text. Metadata such as revision label. For example. it must always match an existing stage ID on the transition list for the current stage.. It returns the content of <annotation> as text. The name of the stage associated with the document. Table 12 TIBCO XML Canon Properties TIBCO XML Canon Property Name modifiedByName versionLabel* comment* stageId Meaning The name of the user who last modified the document. The string representation of <appinfo> element. Conforms a document stage. if the document matches a schema type. Comments about the document provided by the user. The string representation of <documentation> element. The version label of the document provided by the user.150 | Chapter 9 Working with WebDAV Clients The following properties are specific to XML. Its value must match an existing stage ID. < will be escaped as &lt.

but basic functions will still be provided. regardless of the WebDAV client used with TIBCO XML Canon. Nevertheless.WebDAV Client Overview 151 | WebDAV Client Overview Many vendors supply WebDAV client software. For example. TIBCO Designer is integrated with TIBCO XML Canon through a WebDAV plug-in. a category will not display if you do not have the permission to view it. which enables you to use XML Canon as a central repository for collaborative development and management of your TIBCO ActiveMatrix BusinessWorks projects. Therefore it is not practical to state the interactions between every client and TIBCO XML Canon. you can read this section for an overview of how XML Canon works with WebDAV clients. by cut and paste. drag and drop. Altova’s XMLSpy — A popular Integrated Development Environment (IDE) for XML with WebDAV support. This chapter covers several WebDAV clients that are compatible with TIBCO XML Canon: • Windows Web Folder — A simple Windows WebDAV client which allows you to login to TIBCO XML Canon and manage resources on the server the same way you would manage them on your Windows file system. However. using copy and paste tools. upload. For instance. the level of WebDAV support and the available features vary from client to client. download. These functions include moving categories and documents. TIBCO XML Canon User’s Guide . and delete functions. • • Tips for Using WebDAV Clients There are many commercial and open-source WebDAV clients which vary in their WebDAV support and feature set. Permissions Your ability to view categories and documents on the server depends on your role permissions. and some are available for download from the web free of charge. the core feature of a WebDAV client should allow you to upload and download documents to and from TIBCO XML Canon with an authenticated login. The level of support and functions of WebDAV vary over clients. TIBCO Designer — A design-time tool for developing and testing TIBCO ActiveMatrix BusinessWorks processes. However. Managing Categories and Documents Categories on the TIBCO XML Canon server resemble regular file system folders and documents resemble regular files.

because other users can access and modify the same document without your knowledge. In cases where the WebDAV client does not support locking. You can open one of these tag folders and browse all resources assigned to a particular tag. See Using TIBCO XML Canon with WebDAV Clients on page 155 for more information. data will be lost. You will not be able to edit any documents within the tags folder. The tags folder is read-only and for document viewing purposes only. For more information. However. This could cause your copy of the document to miss updates made by others. Clients such as Windows Web Folder and XMLSpy do not have these features. Figure 99 Tags View in Windows Web Folder Check-out and Check-in WebDAV clients such as TIBCO Designer are equipped with check-out and check-in mechanisms that are coupled with the lock and unlock mechanisms of TIBCO XML Canon. Each tag is represented as a folder with the same tag name under the tag folder (see Figure 99). Check-in Properties TIBCO Designer allows you to update the document properties directly during check-in. If this happens.152 | Chapter 9 Tags Working with WebDAV Clients Tagged documents on the TIBCO XML Canon server are accessible as read-only resources via WebDAV clients. you must lock and unlock documents manually via the TIBCO XML Canon web interface in order to modify them. but other WebDAV clients do not provide this feature. see Locking and Unlocking Documents on page 94. XML Canon makes such documents available through the tag folder under the root folder (categories). Failing to lock a document before downloading it for editing could jeopardize other document updates. you can update properties after the check-in via the DAV tab of the TIBCO XML Canon home page. TIBCO XML Canon User’s Guide .

TIBCO XML Canon will assign a stage to the document to users with write permissions. For example. ask your TIBCO XML Canon administrator to review TIBCO XML Canon logs to find the cause. Error Messages The error messages received during WebDAV operations vary from client to client. For more information on specifying a default upload stage. and access is granted based on the your role memberships. If a default upload stage has not been specified. Instead. Therefore. If there is more than one stage to choose from. TIBCO XML Canon User’s Guide . You must use the DAV tab of the TIBCO XML Canon home page to change the document stage. When you use this type of path. If you cannot perform certain operations via a WebDAV client. the initial upload stage for a document will be ambiguous. /xc/canon may be dropped from the URL. • Manual user authentication is required when xc/canon is omitted from the URL. See Managing Documents with Stages on page 97 for more information. you will be prompted to authenticate manually. TIBCO Designer also enables you to transit documents into a different stage at check-in time. TIBCO XML Canon will assign the first document stage in the transitional configuration of all stages. see Using TIBCO XML Canon with WebDAV Clients on page 155. the path above would become simply: http://<hostName>:<portNumber>/<categoryPath>/<documentName> or WebDAV://<hostName>:<portNumber>/<categoryPath>/<documentName> depending on the WebDAV client.WebDAV Client Overview 153 | Stages An initial stage will be assigned to a document during its upload to TIBCO XML Canon via a WebDAV client. In this case. this path is not recommended for runtime scenarios unless your application is designed to provide essential parameters to process standard HTTP authentication automatically. Specifying URLs in WebDAV Clients Accessing a document via URL from a WebDAV client has some special considerations: • If you are using a WebDAV client to access a document in TIBCO XML Canon. It is therefore better to avoid the ambiguous default upload stage. authentication is not based on the Web role.

to access the address. use: http://xmlcanon:8088/My%20XSDs/address.xsd document under the My XSDs category. For example. TIBCO XML Canon User’s Guide . Many web browsers will automatically use %20 to represent the space character in a URL string.xsd • The port number is not required in the URL if the server is configured to use port 80 or 433. if your application does not process the space character automatically. You must replace all space characters in URLs to access the document.154 | Chapter 9 Working with WebDAV Clients • • The root category (Categories) is not included in the URL.

Click the Personal Options tab from the home page (see Figure 100). 5. This section provides instructions for various WebDAV-related tasks in the TIBCO XML Canon web interface. The default stage for WebDAV uploads is user-specific. Figure 100 Specifying a Default Upload Stage 4. 3. Select a default upload stage from the Default stage for WebDAV upload drop-down list. click the Home button in the menu bar to open this page. Log in to the TIBCO XML Canon server via its web interface. TIBCO XML Canon User’s Guide . It is set via the Personal Options tab in the home page of the web interface.Using TIBCO XML Canon with WebDAV Clients 155 | Using TIBCO XML Canon with WebDAV Clients TIBCO XML Canon is WebDAV-enabled and therefore can help the server overcome some of the limitations imposed by its plain HTTP client interface. Click the Update Options button. Follow the instructions below to specify a default stage for WebDAV uploads: 1. Although the server has a built-in logic to assign a stage to the document during its initial upload. Specifying a Default Upload Stage A document must be assigned to an initial or default upload stage regardless of how you upload the document in TIBCO XML Canon. 2. If not. it is recommended that you specify a default stage for WebDAV uploads to eliminate ambiguity when uploading a document via WebDAV clients. You will see the TIBCO XML Canon home page.

Select a document or a set of documents you want to update from the Update column of the Documents area. enter a brief comment. Follow the instructions below to view documents uploaded through a WebDAV client and update their properties. 1. Update the properties of other documents under the DAV tab until the list is clear. In the Attributes area. You will see all the documents you have uploaded to the server recently via WebDAV clients (except TIBCO Designer) under the DAV tab (see Figure 101). Figure 101 Managing WebDAV Uploads 3. Ensure the list is clear. 2. a revision label. The document is removed from the list under the DAV tab after its properties have been updated. 4. and any optional custom properties. Click the DAV tab under the home page. 5. TIBCO XML Canon User’s Guide . Click the Update Attributes button to complete the properties update. all required custom properties. Some WebDAV clients cannot update documents metadata and properties. TIBCO XML Canon web interface provides document locking and unlocking features through the document details page and the metadata update feature through the DAV tab in the home page. which means all documents are up-to-date. Log in to the TIBCO XML Canon web interface using the same credentials you used in WebDAV. It includes a WebDAV plug-in that simplifies document check-in and check-out. 6.156 | Chapter 9 Working with WebDAV Clients Managing WebDAV Uploads TIBCO Designer is integrated with TIBCO XML Canon.

Click the OK button. Name your Web Folder (for example. paste. 6. Click the Next button in the Wizard. and drag and drop can be used in the same way as they would be on a local system folder. Open My Network Places from one of the following locations: • • • The Start menu My Computer from the desktop Windows Explorer 2. Enter a valid TIBCO XML Canon username and password. http://xmlcanon:8080) and click the Next button. Configuring a Windows Web Folder Follow the instructions below to configure a Windows Web Folder as a WebDAV client for the TIBCO XML Canon server: 1. TIBCO XML Canon User’s Guide . 8. With Windows Web Folders. you can view categories and documents in TIBCO XML Canon in the same way that you would view a local system folder. TIBCO XML Canon WebDAV) and click the Next button. Select Choose another network location as your service provider and click the Next button. This section provides instructions for creating an XML Canon Web Folder on Windows. 3. 5. Creating a Web Folder in TIBCO XML Canon varies slightly between different versions of Windows. copy.Using Windows Web Folders 157 | Using Windows Web Folders A Windows Web Folder is easy to access on a Windows platform. Basic operations such as cut. 7. Click the Finish button to complete the task. Enter an internet address such as the URL of your TIBCO XML Canon server (For example. 9. 4. Click Add a network place from the Network Tasks menu to launch the Add Network Place Wizard.

Open My Network Places from one of the following locations: • • • The Start menu My Computer from the desktop Windows Explorer 2. see Accessing Documents via URL on page 111. View the Web Folder in the same way as you would view a local system folder. TIBCO XML Canon User’s Guide . Double-click the WebDAV folder shortcut that you have created (or right click and select Open) for TIBCO XML Canon and open it in an explorer window. If you have the view tag permission. To find out more about the tag folder. Browsing Categories and Documents Follow the instructions below to browse documents in TIBCO XML Canon through a Web Folder: 1. you will also see a tag folder (see Figure 102). The representation is the same as a local file system. Figure 102 The Tag Folder under the Root Directory 3. Double click the tag folder to browse the TIBCO XML Canon repository by tags.158 | Chapter 9 Working with WebDAV Clients Managing Categories and Documents in the Web Folder Your TIBCO XML Canon permissions for stages and categories determine your ability to access and update resources on the server using the Web Folder. You will receive warning messages if you do not have the required permissions for a stage or a category. The Web folder displays all TIBCO XML Canon categories within your read permission as folders.

Do not double-click a document for editing. Select a document or a set of documents from your local file system. Folder. This fails because the content of the tag category is read-only. Instead. Deleting Categories and Documents Follow the instructions below to delete categories and documents: 1. Select the categories and documents to be deleted. Adding Categories and Documents Follow the instructions below to add a child category: 1. If you do not have write permission to a document stage within the category. Double-click a document to view it. If the document in the category is locked by another user. Copy the document or a set of documents to a category in the Web Folder using drag and drop. Navigate to the level where you want to make a new category and right-click the blank area in the category content window. New name for this folder. Type a TIBCO XML Canon User’s Guide .Using Windows Web Folders 159 | 4. If you do not have delete permission to a child category of this category. 3. Adding Documents to a Category Follow the instructions below to add documents to a category: 1. 2. lock the document using the TIBCO XML Canon web interface and then download it using the Web Folder before making any modifications. selected. Deleted documents and categories are stored in a holding area in TIBCO XML Canon until they are purged by an administrator There are four possible reasons a category deletion fails: • • • • If you are trying to delete documents from the tag category. 2. and then press the ENTER key. A new folder is displayed with the default name. Select New in the pop-up menu and click the Folder option. Press the DELETE key on your keyboard and click the OK button to confirm the deletion. 2.

If this happens. lock the document using the TIBCO XML Canon web interface and then download it using the Web Folder before making any modifications. unedited document. 1. See Using TIBCO XML Canon with WebDAV Clients on page 155 for more information. Unlock the document by following the steps described in Locking and Unlocking Documents on page 94. Do not double click a document for editing. because other users can access and modify the same document without your knowledge. because Windows Web Folder does not provide a lock mechanism.160 | Chapter 9 Working with WebDAV Clients Editing Documents You must manually lock the documents in TIBCO XML Canon in order to download them for updates. data will be lost. Copy the modified document from the local directory to its original location in the Web Folder to replace the old. Edit the document on your local file system. 2. This could cause your copy of the document to miss updates made by others. Failing to lock a document before downloading it for editing could jeopardize other document updates. Instead. Lock the document you want to edit by following the steps described in Locking and Unlocking Documents on page 94. Editing Document Properties You must edit the document properties using the TIBCO XML Canon web interface after uploading the document through the Windows Web Folder. 3. 5. 4. Open the Web Folder to select the locked document and copy this document into a local directory. TIBCO XML Canon User’s Guide .

where <categoryPath> is the location where you want to save the new TIBCO XML Canon project. With this integration. Figure 103 The XML Canon Tab in TIBCO Designer 3. Follow the format: http://<hostname>:<portnumber>/<categoryPath>. TIBCO Designer allows for check-out and check-in of TIBCO ActiveMatrix BusinessWorks projects. Setup a project by filling in the following fields. See Specifying URLs in WebDAV Clients on page 153 for more information. — Proxy Server (Optional) — You can only use a proxy server that does not require authentication. — TIBCO XML Canon category — The URL of the new project. — Username and Password — A valid username and password for TIBCO XML Canon. Open TIBCO Designer and select New Empty Project. as well as metadata updates of project documents.Using TIBCO Designer as a WebDAV Client 161 | Using TIBCO Designer as a WebDAV Client TIBCO Designer is fully integrated with TIBCO XML Canon through a WebDAV connector/plug-in. TIBCO XML Canon servers as an excellent source control repository of TIBCO ActiveMatrix BusinessWorks projects. 2. Opening New Projects in Designer Follow the instructions below to open a new project in TIBCO Designer: 1. Click the XML Canon tab in the Save Project dialog (see Figure 103). — TIBCO messaging encoding — The character encoding for messaging (for example. ISO8859-1 or UTF-8). TIBCO XML Canon User’s Guide .

Browse to the project folder and click the Select Folder button. Checking-out Project Resources for Editing When using TIBCO XML Canon as a version control system for TIBCO ActiveMatrix BusinessWorks projects. canon:8080) and click the Connect button. Select Multi-User from the menu bar and click the Check In Changes option. Click Browse at the right of the TIBCO XML Canon category field. or edit the folder. you cannot edit project resources before you check-out the resources. Click the OK button.162 | Chapter 9 Working with WebDAV Clients 4. Follow the instructions in Checking-in Changes on page 163 to check in your project for the first time. Opening Existing Projects in Designer Follow the instructions below to open an existing project from TIBCO Designer: 1. 5. Follow the instructions in the Checking-in Changes section to check in your project for the first time. Select the resources you want to change in the project tree. 3. Enter a valid TIBCO XML Canon username and password. Open TIBCO Designer and select Open existing project. move. Follow the instructions below to check-out a resource: 1. delete. you must check-out a folder before you rename. Click the OK button. 6. 2. Specify the URL of the TIBCO XML Canon server (for example. 6. 2. Click the TIBCO XML Canon tab in the Open Project dialog. 7. 5. When checking-out resources. 4. 8. Select Acquire-Check out Resource from the resource’s right click menu or the Multi-User menu. TIBCO XML Canon User’s Guide .

Follow the instructions below to check in your changes to TIBCO XML Canon: 1. you can apply your changes to the project in TIBCO XML Canon during check-in.Using TIBCO Designer as a WebDAV Client 163 | Checking-in Changes Once you update your project. Click Check In Changes to open the TIBCO XML Canon Check In dialog. you can add metadata to the modified project documents or to new documents that have been created during the check-out. The XLM Canon Properties dialog box opens (see Figure 105). You must synchronize the project after you check-in your updates in order to prevent synchronization conflicts that can later cause check-out difficulties. When you check in a project (or one of its resources). Figure 105 The XML Canon Properties Dialog TIBCO XML Canon User’s Guide . Figure 104 Checking-in Documents with TIBCO Designer 3. modified. Select a document and click the Properties button to specify the document properties. You do so by selecting these documents one at a time from the Added or Modified folders of the XML Canon Check In dialog and applying Properties to enter metadata. TIBCO Designer displays any document that has been added moved. Select Multi-User from the menu bar in TIBCO Designer. 2. or deleted in this dialog.

164 | Chapter 9 Working with WebDAV Clients 4. TIBCO XML Canon User’s Guide . Click Check in selected to check in only the selected documents. Click OK to return to the XML Canon Check In dialog box. — Revision label — A string value to specify this revision. 5. Select the project from the Project tab in TIBCO Designer. Add metadata to this document by filling in the fields: — Current Version # — One increment higher than the previous version. modified. 2. — Comment — Any comments on the current version. Click Synchronize Project to open the synchronization panel (see Figure 106). or click Check in all to check in all documents. Follow the instructions below to synchronize a TIBCO ActiveMatrix BusinessWorks project: 1. Repeat step 3 and step 4 until you have finished specifying all desired properties. Synchronize all files or select specific files for synchronization. moved. shown in Figure 104. Use synchronization to: • • Monitor which files have been added. then click Multi-User from the menu bar. or deleted. This maximum length of this field is 256 characters. 6. — Stage — The desired stage of the document in TIBCO XML Canon. Synchronizing a TIBCO ActiveMatrix BusinessWorks Project Synchronization obtains the latest files for a particular project. You need to synchronize your project often to ensure your project reflects the changes made by other users.

or click the Synchronize selected button after selecting a file or a set of files to synchronize.Using TIBCO Designer as a WebDAV Client 165 | Figure 106 Synchronizing a BusinessWorks Project 3. refer to the appendix "Working with a Revision Control System" in the TIBCO ActiveMatrix BusinessWorks Process Design Guide and the chapter "Working with a Revision Control System" in the TIBCO Designer User’s Guide. Click the Synchronize all button to synchronize all project files. Additional Notes Because TIBCO XML Canon automatically treats all resources in a TIBCO ActiveMatrix BusinessWorks project as a part of the revision control system. TIBCO Designer will display any conflicts it discovers along with potential solutions. the Add Resource to RCS menu item in Designer’s Multi-User menu is deactivated when you are using TIBCO XML Canon. TIBCO XML Canon User’s Guide . During the synchronization process. For more information on using TIBCO ActiveMatrix BusinessWorks with TIBCO XML Canon.

users can download documents from and upload documents to the TIBCO XML Canon server.166 | Chapter 9 Working with WebDAV Clients Using XMLSpy as a WebDAV Client Altova XMLSpy is a popular development environment for XML. 2. Click the Switch to URL button at the bottom of the Open dialog. Opening Documents from TIBCO XML Canon Follow these steps to open a document from TIBCO XML Canon in Altova XMLSpy: 1. as shown in Figure 107. XMLSpy can serve as WebDAV client for TIBCO XML Canon. Because it is WebDAV-enabled. This section provides instructions on how to use Altova XMLSpy with TIBCO XML Canon. 3. Figure 107 XMLSpy Open Dialog — Switch to URL TIBCO XML Canon User’s Guide . Select Open from the File menu (or press Ctrl+O) to launch the Open dialog. Start XMLSpy. From XMLSpy.

Using XMLSpy as a WebDAV Client 167 | 4. Figure 108 The TIBCO XML Canon Category Tree in XMLSpy 6. — If desired. then select a document (such as XSD or WSDL). See Specifying URLs in WebDAV Clients on page 153 for more information. TIBCO XML Canon User’s Guide . using the format: http://<server_host>:<port_number> For example. check the "remember password between application starts" box. The Open URL dialog should display the TIBCO XML Canon category tree with all of the resources stored on the server. Expand one of the categories in TIBCO XML Canon to browse its contents. 5. — Available Files Server URL — your TIBCO XML Canon server URL. Enter your TIBCO XML Canon credentials to continue. XMLSpy prompts you with an Enter Network Password dialog. If you did not provide your username and password before clicking Browse button. Click Browse to browse categories in TIBCO XML Canon. as shown in Figure 108. Enter your TIBCO XML Canon information in the fields: — User and Password — Enter your TIBCO XML Canon user name and password. http://xmlcanon:8080.

168 | Chapter 9 Working with WebDAV Clients 7. If this happens. data will be lost. In XMLSpy. open the document and make the desired changes. For detailed instructions. 2. because other users can access and modify the same document without your knowledge. see Locking and Unlocking Documents on page 94. If you cannot save a document in TIBCO XML Canon using XMLSpy after making your changes. the document may be unlocked on the TIBCO XML Canon server. see Locking and Unlocking Documents on page 94. This could cause your copy of the document to miss updates made by others. — Replace (escape) all spaces in the File URL (which gives the WebDAV path) with %20. you must: — Select the document in the XMLSpy browser to display its fully qualified WebDAV URL in the File URL field. Follow the instructions below to use Altova XMLSpy to edit a document that is stored in TIBCO XML Canon: 1. as shown in Figure 108. you must use the lock and unlock functions provided in the TIBCO XML Canon web interface. See Opening Documents from TIBCO XML Canon above for more information about opening documents in XMLSpy. 3. TIBCO XML Canon User’s Guide . Editing Documents If you use XMLSpy to edit TIBCO XML Canon documents. Unlock the document in TIBCO XML Canon using the web interface. Double-click a document to open it in XMLSpy. For detailed instructions. because XMLSpy does not provide a check-out and check-in function. Save the edited document as the same URL in XMLSpy. If you click Open rather than double-clicking the document. Failing to lock a document before downloading it for editing could jeopardize other document updates. 4. Lock the document in TIBCO XML Canon using the web interface.

http://xmlcanon:8080. 6. Enter your TIBCO XML Canon information in the fields: — User and Password — Enter your TIBCO XML Canon user name and password. its WebDAV path appears in the File URL field.Using XMLSpy as a WebDAV Client 169 | Saving New Documents to TIBCO XML Canon Follow the instructions below to save a new document from XMLSpy to TIBCO XML Canon: 1. as shown in Figure 108 on page 167. In XMLSpy. Click Browse to browse categories in TIBCO XML Canon. Select a category from the TIBCO XML Canon category tree. XMLSpy prompts you with an Enter Network Password dialog. using the format: http://<server_host>:<port_number> For example. If you did not provide your username and password before clicking Browse button. check the "remember password between application starts" box. 2. — If desired. When you select a target category. The Open URL dialog should display the TIBCO XML Canon category tree with all of the resources stored on the server. 5. Select Save As… from the File menu to launch the Save As dialog. 3. or click New Folder to create a new category. Enter your TIBCO XML Canon credentials to continue. — Available Files Server URL — your TIBCO XML Canon server URL. TIBCO XML Canon User’s Guide . as shown in Figure 107 on page 166. 4. Click the Switch to URL button at the bottom of the Open dialog. open the document that you would like to save to TIBCO XML Canon.

TIBCO XML Canon User’s Guide . Adding Metadata to Documents XMLSpy does not provide a mechanism for adding metadata to a document when the document is saved through the WebDAV client. Click Save to save the document to the TIBCO XML Canon server.170 | Chapter 9 Working with WebDAV Clients 7. See Using TIBCO XML Canon with WebDAV Clients on page 155 for more information. 8.xsd to a category.xsd The WebDAV path shown in the File URL may not contain spaces. you must add the metadata through the DAV tab of your TIBCO XML Canon home page immediately after you update or upload your documents. In the File URL field. If the WebDAV path or document name includes spaces. For example. update the File URL http://xmlcanon:8080/MyProject/Sample_01/XSDs/ to read http://xmlcanon:8080/MyProject/Sample_01/XSDs/alpha. Therefore. to add the document alpha. you must replace each space with %20. append the document name to the WebDAV path.

page 177 Controlling Non-Authenticated URL Access to Documents. page 172 Managing Categories.| 171 Chapter 10 Administering Categories and Documents This chapter describes how administrative users can work with categories and documents in TIBCO XML Canon Topics • • • • • • • Overview. page 173 Cloning Categories. page 183 TIBCO XML Canon User’s Guide . page 182 Understanding Permissions. page 176 Purging Deleted Categories and Documents. page 181 Analyzing Documents for Components.

where each category relates to a different section of the project. you can control access levels to an XML project with categories permission. See Controlling Non-Authenticated URL Access to Documents on page 181 for more information. you will set more restrictions as the level of the stage goes higher. The roles. on page 195. Stages also allow you to specify different access levels to documents in an XML project as the development process moves from one step to the next. Configuring Roles. Configuring Stages. Usually. For more information on permissions and roles. For more information on administrating documents via stages.172 | Chapter 10 Administering Categories and Documents Overview An administrator can control access to documents within the TIBCO XML Canon repository in two primary ways: • • Configure the category permission in the Category Details panel. This chapter also discusses cloning and purging which are two important functions related to document administration. see Chapter 12. As a result. see Chapter 14. If you are an administrator. TIBCO XML Canon User’s Guide . you can create multiple child categories in a project category. You can specify which XML documents are made public from the development stage to the publishing stage. For example. on page 229. You can also group developers into different roles according to the section or category they work on. It also allows you to control the flexibility of your XML documents between stage transitions by assigning each role with different permissions for different stages. and then grant each role and category a different set of permissions. This can be achieved by configuring the category and the stage permissions for the default Web role (an un-authenticated role). categories. Configure the stage permission in the role configuration page. different developers working on different sections will have a different set of permissions. and stages permissions in TIBCO XML Canon provide an administrator with an easy and powerful mechanism to control document access.

Recursive Unlock removes restrictions on the document. TIBCO XML Canon User’s Guide . • The Recursive Unlock button (available to Administrators only) removes all locks on documents within the category. ADMINISTRATOR Category Details panel Figure 109 The ADMINISTRATOR Category Details Panel Figure 109 shows an ADMINISTRATOR Category Details panel which is similar and to a CONNECT Category Details panel. If a document has been locked by another user. but which includes some additional functions.Managing Categories 173 | Managing Categories Administrators have access to additional functions in the Category Details panel as well as access to all the documents and categories in the TIBCO XML Canon repository.

Configuring Category Permissions Document access can be controlled by configuring category permissions. TIBCO XML Canon User’s Guide . documents.. and history. see Cloning Categories on page 176. There are two kinds of permissions in the Category Details panel: category-specific and role-specific permissions. Follow the instructions below to configure category permissions: \ 1. The Statistics link provides the statistical details of a category. For more information. button enables you to clone an entire category with all its sub-categories. • • See Using Categories on page 48 for more details on the Category Details panel.174 | Chapter 10 Administering Categories and Documents • The Clone. Click Browse > Categories from the menu bar to open the category browser. including the number of sub-categories and documents. Figure 110 Role Permissions of a Category The Role permissions area in the Category Details panel allows you to view the category’s permissions for each particular role.. metadata. The buttons and settings in the Role Permissions section enable you to set category permissions. 2. See Configuring Category Permissions below for details on these options. Select a category from the category browser to open its Category Details panel.

— Read. click the Update permissions recursively button. TIBCO XML Canon User’s Guide . write. It also grants users with the read permission explained above. It also grants users with the read permission explained above. However. An explanation of each list item has been provided as below: — Default Each role has been configured with default category permissions after creation. Select an item from the drop-down list to configure the permission for each role. If you want to assign the same permissions to all descendents of this category.Managing Categories 175 | 3. Note that if you do not update category permissions recursively—particularly when removing permissions—you may find that a child category has less restrictive permissions than its parent category. write. — Read This role allows users to view the content of the category and download all documents under this category. users cannot make changes to the category or its documents. delete This role allows users to perform the read. — Read. add and rename documents and child categories. write This role allows users to perform the lock and unlock function. including the category itself. — None This role has no access to this category including its content. — Read. and move the category content (including both documents and child categories) within the category. Use this option if you have never changed a role’s category permission in Category Details panel. 4. within the category. and delete permissions. as explained above. delete This role allows the user to delete documents within the category. Click the Update permissions button to complete the update.

176 | Chapter 10 Administering Categories and Documents Cloning Categories An administrator has the ability to clone a category. 3. button. You can also create a development template and clone the template in order to start a new development branch. 5. and tag of documents. This means that TIBCO XML Canon creates an exact copy of the category including all its contents (all properties and permissions of child categories. Click the Clone. Click Browse > Categories from the menu bar to open the category browser.. and all child categories and documents under the cloned category).. histories. all properties. TIBCO XML Canon User’s Guide . Select a category to be cloned from the category browser. Cloning helps you to retrieve a project at an earlier stage by saving the project at that particular point. Data is copied rather than shared. which is analogous to a branching mechanism. Follow the instructions below to clone a category: 1. 4. Many source code management systems using cloning. However the difference between cloning and branching are: • • A clone must be accessed via a new path. Enter a name for the cloned category in the corresponding field and click the Clone Category Name button as shown here: All the category content is copied to the new location. 2. Click the OK button in the pop-up dialog.

Purging Click Configure > Policies from the Administrator menu to open the Policies page (see Figure 111). For more information on how documents are deleted.Purging Deleted Categories and Documents 177 | Purging Deleted Categories and Documents After deletion via the web interface or a WebDAV client. The document will be assigned with a Delete tag when it is ready to be purged. memory use. Use the purge function to remove these categories and documents completely from the repository. An administrator can only purge documents within the Deleted holding area. Remove documents with the Delete tag to reduce TIBCO XML Canon overhead (such as disk space. see Deleting Documents on page 93. general responsiveness) Browse and clean up unused target namespaces The delete-purge system enables you to recover a previously tagged version of document after its deletion to maintain the consistency of your tagged projects. • • • Only administrators have the ability to perform the purge function. We recommend regular purges to maintain system health. When / Why Perform the Purge Function Perform a purge function when you need to: • • • Remove deprecated tags and tagged document sets from the Deleted holding area. Figure 111 The Policies Menu Bar in TIBCO XML Canon TIBCO XML Canon User’s Guide . categories and documents are moved to a special holding area of the TIBCO XML Canon repository.

Configuring Policies. refer to Chapter 15.178 | Chapter 10 Administering Categories and Documents View or perform the following options within the Policies page: • • • • • General Policies Configuration Authentication Configuration (Internal. a confirmation message similar to the one shown here prints. Purge Tab Select the Purge tab to open the Purge View. Purge All permanently removes all deleted documents and categories. regardless of whether tags are assigned. See Purging Selected Documents below. and TIBCO Administrator) Installation information Purge information and functions TIBCO XML Canon server status and logs For more information on administering policies. The Purge selected link opens a list of purgeable resources. page 239. Figure 112 Purge Options There are three purge options: • • Purge Untagged permanently removes all documents and categories that do not have associated delete tags. Use this option to remove all deleted resources. indicating the number of documents and categories purged: TIBCO XML Canon User’s Guide . LDAP. You can then select those resources you wish to delete permanently. • Confirmation After purging resources using the Purge All or Purge Untagged buttons.

this panel displays only the message. • • Purgeable resources Deleted but not purgeable resources Figure 113 Purging Selected Documents When all deleted documents have already been purged.Purging Deleted Categories and Documents 179 | Purging Selected Documents The Purge tab contains two lists of deleted resources. No resources available for purging. as shown in Figure 113. TIBCO XML Canon User’s Guide .

TIBCO XML Canon User’s Guide . reassign.180 | Chapter 10 Administering Categories and Documents Purgeable Resources Documents ready to be permanently deleted are listed in the purgeable resources area. 2. Click the Purge Selected button to purge the selected documents. Restart Some purge-related data cannot be removed from the database while the XML Canon server is running. It may take several minutes to complete. these data are removed only at startup. a target namespace will display in the browser after the removal of all the documents which use the namespace unless you restart TIBCO XML Canon. available in the initial Purge Options screen. Purging a large number of documents from the repository is a time consuming operation. overrides this restriction and deletes all resources. A confirmation dialog box is displayed. you can click the Select All button to select all documents for purging. 1. see Removing Tags on page 145. Alternately. The Purge All button. These metadata must be removed before the purge process. For example. You need to restart the TIBCO XML Canon service or daemon to perform the final clean up and update process. Deleted but not purgeable resources The Deleted but not purgeable resources area shows all documents associated with additional active metadata as you will see in Figure 113. Follow the procedures described in Purging Selected Documents on page 179 to permanently delete these documents from the TIBCO XML Canon repository. For more information on removing tags. or click Select None to deselect all documents. and remove tags permission to remove these tags. including those listed as not purgeable. The administrator must have the assign. Following a purge. Documents will move to the Purgeable Resources area and are ready to be purged after the removal of the additional metadata. Check the checkbox next to a document to select it for purging.

see HTTP Addressability in General Policies on page 241 Read permission is required for a Web user to access documents. Therefore. The access level of a Web user or an external program depends on the role or roles to which it belongs and the permission associated with the role or roles across categories and stages. For further information. The administrator has the ability to turn off the URL access using a policy. If the Web user role has read permission to view documents stored in category A and stage A. A web role with the CONNECT capability has the read permission to view documents in all categories and stages by default. then the role only has the ability to view documents in category A and stage A.Controlling Non-Authenticated URL Access to Documents 181 | Controlling Non-Authenticated URL Access to Documents When an external program such as a Web browser or a validating parser attempts to locate and access a document stored under the /pub folder in the TIBCO XML Canon repository via a URL. an administrator controls the visibility of categories and documents for the Web user. TIBCO XML Canon User’s Guide . For information on Web users and tagging. refer to Tags and Authentication on page 141. the program is given the same access levels as a Web user. it will lose the URL addressability on a particular category or stage if an administrator removes the read permission of that category or stage on the web role. but does not have read permission to view documents stored in category B and stage B. However. not category B and stage B. regardless of the existence and placement of the Web user.

It categorizes all constituent components within a document through logical analysis during its initial upload and then a searchable dictionary is built based on that analysis. This dictionary contains all the components in the repository and enables you to easily view and search them. Click the Analyze button at the bottom of the document details page. An administrator has the ability to force an analysis on a document and ensure that the component catalog in TIBCO XML Canon is up-to-date. TIBCO XML Canon User’s Guide . 2. WSDL files. DTDs. Click Browse > Categories to open the category browser.182 | Chapter 10 Administering Categories and Documents Analyzing Documents for Components TIBCO XML Canon has the ability to analyze schemas. Follow the instructions below to perform a document analysis: 1. 3. Select a document from the category browser to open its document details page. and TIBCO ActiveMatrix BusinessWorks Process Definition files.

regardless of the stage permission settings for documents in that category. Each role offers permissions in these categories: • Category Permissions determine access to both categories and the documents within a category. permissions in other categories may differ. edit. reassign tags to documents and categories. or delete documents from the category. A user without a role does not have access to any TIBCO XML Canon categories. he or she will not see that category in the category browser. make changes to the category. See also Changing Default Permissions on page 207. documents. if the stage permissions permit full read/write access to documents in the stage. and cannot log into the TIBCO XML Canon web interface. However. if a user has no permissions a particular category. • Tagging Permissions determine the ability of role members to create new tags. These permissions settings are described in more detail in Role Permissions on page 196. stages. resulting in write access in another category. Permissions control a user’s ability to access and modify categories. Note that if category and stage permissions conflict. Similarly. the most restrictive permissions take precedence. a user with multiple roles may have greater permissions than any single role grants. everything is controlled through roles. As a result. Users with membership in multiple roles are granted a combination of the highest permissions from each role. and tags. • Stage Permissions determine whether role members can view. It is not possible to grant permissions directly to an individual user. This means that a user is granted permissions by the roles in which he or she has membership. These settings determine whether role members can see a category and its contents. all permissions are associated with roles. For example. while the category grants only read permission. and remove tags. or delete documents belonging to a particular stage. TIBCO XML Canon User’s Guide .Understanding Permissions 183 | Understanding Permissions In TIBCO XML Canon. the result is read permission for the stage in that category.

The result is the same: the user has no roles. TIBCO XML Canon User’s Guide . In the category details page. Default Administrator Permissions By default. it is possible to create a new user without assigning a role. as with any other role. and delete permissions for all categories and stages. Permissions entered for a role in the category details page supercede default category permissions settings from the role details page. navigate to the Administrator role details page and edit the Tagging Permission field. stage permissions. At a minimum. However. the default permissions settings are None. Here an administrator grants role members tagging permissions. By default. and default category permissions. For more information on how portal users are created. see Creating Portal Users on page 223. Portal Users Portal Users are the exception to this rule. an administrator can remove a user from all roles. When this happens. To grant role members access. each role must have read permission to at least one category and one stage. administrators do not have remove permissions for tags.184 | Chapter 10 Administering Categories and Documents Default Role Permissions When a new role is created. and therefore no permissions. or deactivate all roles which the user is a member of. write. the Administrators role has read. which has read-only permissions to all categories. an administrator can change the defaults Portal role permissions by editing the role and category details pages. Here an administrator can grant permissions specify to the category to each configured role in TIBCO XML Canon. Although the administrator is prompted to chose a role during user creation. See Changing Default Permissions on page 207 for more information. meaning that role members do not have access to view or edit TIBCO XML Canon categories and documents. the user cannot log in to the TIBCO XML Canon web interface. portal users are assigned to the Portal role. Similarly. • Default User Permissions A new user has no view or edit permissions until the user is assigned to a role. In order to give administrators the tag remove permission. However. an administrator must assign permissions in two places: • In the role details page.

| 185 Chapter 11 Administering Namespaces This chapter describes namespace administration which can only be accessed by an administrator in TIBCO XML Canon. page 190 Managing DTD DOCTYPE Public IDs. page 186 Adding Namespace Presentations. Topics • • • • Namespace Administration Overview. page 193 TIBCO XML Canon User’s Guide . page 189 Notes on Building XSLT Stylesheets.

Figure 114 The Namespace Presentation Tab The Available Detailed Views area in the Presentation tab shows the namespace presentations that have been added by an administrator. and SchemaDOC) which are provided by TIBCO XML Canon. TIBCO XML Canon User’s Guide . The ability to edit DTD Doctype public IDs. see Viewing Document Content on page 98. as shown in Figure 114. For more information. For more information on viewing documents. The Add Detailed View area is where additional presentations will be added. see Adding Namespace Presentations on page 189. ProcessDOC. Namespace Presentation When browsing namespaces. Administrators have access to an additional tab. You can access namespace presentations in the same way you access the standard detailed views in a document detail page. Namespace presentations are XSLT-defined detailed views for documents which belong to a particular namespace. The Presentation tab enables a TIBCO XML Canon administrator to introduce namespace presentations.186 | Chapter 11 Administering Namespaces Namespace Administration Overview An administrator has access to two additional features in the namespace view that a normal user does not have: • • The Presentation tab in the namespace details page. XSLT stylesheets can be used to define a customized view for a document in addition to its standard detailed views (XML view.

TIBCO XML Canon will resolve the public ID using the DTD access path specified in the DOCTYPE Listing panel instead of the system ID specified by the instance document. Figure 115 Administrators — Namespace Browser Instance documents which use a public ID in the DOCTYPE must include a resolvable system ID. they will be considered as invalid by the TIBCO XML Canon validation tool. Configuring Stages. Changing the name or location of a DTD in the system ID for each instance document becomes more inconvenient as the number of documents with references to different public IDs grows in TIBCO XML Canon. After the validation of an instance document which uses a public ID in the DOCTYPE is validated. An administrator also has the ability to specify the access path of a DTD that each public ID points to in this page. Otherwise. TIBCO XML Canon will attempt to resolve this public ID according to the method defined in the stage configuration (see Chapter 14. on page 229 for more information).Namespace Administration Overview 187 | DTD Doctype Public IDs Administrators also have access to the Doctypes button. Figure 116 Doctype Listing The DOCTYPE Listing panel from the namespace browser enables you to view all public IDs which are referenced by all instance documents in the TIBCO XML Canon repository. as shown in Figure 115. If you set the value of Namespace Resolution to Namespace Only. TIBCO XML Canon User’s Guide . located at the bottom of the namespaces browser. centralized place throughout the XML development process without tracking instance documents. The DOCTYPE list in TIBCO XML Canon will ease this process and make this change in a single.

188 | Chapter 11 Administering Namespaces You must specify a dummy system ID in the instance document despite the fact that TIBCO XML Canon will disregard this ID. TIBCO XML Canon User’s Guide . see Managing DTD DOCTYPE Public IDs on page 193. For more information. the validation tool will consider this document as invalid. Otherwise.

Adding Namespace Presentations 189 | Adding Namespace Presentations Follow the instructions below to add a namespace presentation: 1. Select a namespace in the namespace browser to open its namespace details page. see Viewing Document Content on page 98. Click the Presentation tab. 6. TIBCO XML Canon will display XSLT files in the Uses tab of the namespace only. Click the Add view button. Name the namespace presentation in the Detailed View Name field. Therefore. The detailed view always uses the latest revision of the document. Click the Lookup. You will see a pop-up window with a list of all candidate XML stylesheets. it is fine to make revisions to an XSLT stylesheet which is used for a namespace presentation. Upload the XSLT stylesheet into TIBCO XML Canon (see Uploading Documents on page 89). 9. TIBCO XML Canon User’s Guide . 2. Select a validated XSLT stylesheet from the list. 8. For more information on viewing documents. 7. Click Browse > Namespaces from the menu bar to open the namespace browser... 3. Validate the document (see Validating Documents on page 101) 4. You will see the newly created namespace presentation in the Available Detailed Views area. Every user has the ability to view the namespace presentation in the document details page regardless of the permission assigned to the XSLT stylesheet. They represent different styles of the namespace display. button in the Add Detailed View area. 10. Create an XSLT stylesheet for your intended namespace. 5.

full. TIBCO XML Canon User’s Guide .apache. See Table 13 for more information on these parameters: Table 13 Namespace Presentation Parameters Parameter name xmlcanon.file. such as the extension functions.full.file.name xmlcanon.source.folder xmlcanon.name xmlcanon.user. you will gain a sophisticated understanding of how TIBCO XML Canon applies namespace presentation XSLT stylesheets to XML documents.user.lock.lock. The full name of the user for detailed view access. The full name of the user who locked the document. See http://xml.0 as its XSLT processor.source.name xmlcanon.name xmlcanon. TIBCO XML Canon passes on a collection of parameters which provide additional information about the document and other context information to an XSLT stylesheet which defines the namespace presentation.user.user. By reading this section.name Meaning The username of the user for detailed view access. Review this section before you start building your XSLT stylesheet for namespace presentations. The name of the user who locked the document.190 | Chapter 11 Administering Namespaces Notes on Building XSLT Stylesheets This section provides information on building your own namespace presentation XSLT stylesheets in TIBCO XML Canon.7. if any. It allows you to take advantage of certain features that are specific to Xalan. XSLT Processor TIBCO XML Canon uses Xalan 2. The category path of the file in the detailed view. Namespace Presentation Parameters When you select a namespace presentation in the Detailed Views area of the document details page. The name of files listed in the detailed view.org/xalan-j/ for more information.

TIBCO XML Canon User’s Guide . Caching TIBCO XML Canon does not cache the results of namespace presentations. Increase the available memory for the TIBCO XML Canon JVM (Java Virtual Machine) if this happens. If your XSLT stylesheets are too complex or the documents the users want to view are too large.xsl"/> <xsl:include href="mystylesheet.Notes on Building XSLT Stylesheets 191 | Table 13 Namespace Presentation Parameters Parameter name xmlcanon.com/XSLT/mystylesheet.lock.stylesheet. Referencing Other Stylesheets Do not use absolute URLs when referencing other stylesheets through xsl:include or xsl:import.email xmlcanon. Be aware of this limitation if you are going to include external references such as images or stylesheets. See General Policies on page 241 for more information.example. URL of the Returned Document Note that the URL of the custom view result does not correspond to the path of the document on the server. Reference the same stylesheet within a category: • The two examples below are supported: <xsl:include href="/XSLT/mystylesheet. the namespace presentation will not respond.folder Meaning The email address of the user who locked the document. The stylesheet category.user. You will use this to reference stylesheet documents and image files from the generated HTML.xsl"/> MIME Type The xsl:output element in the XSLT stylesheet defines the output format of the MIME type which reports to the browser in TIBCO XML Canon.xsl"/> • The example below is not supported: <xsl:include href= "http://www. if any. These two elements support absolute or relative category paths in TIBCO XML Canon.

document() will also return an FILE_NOT_FOUND error.com/namespaces/ErrorDocument"> <xce:errorCode>FILE_NOT_FOUND</xce:errorCode> <xce:errorParameter>FileName. Parameters (2): file name. IO_EXCEPTION An unexpected problem occurred during file access. error message.192 | Chapter 11 Administering Namespaces Error Documents The XPath function document() always returns a document whether there are errors or not. Parameter (1): file name. If you do not have read permission to a document.example. You will get different types of errors while importing documents. column number.xml</xce:errorParameter> </xce:errorDocument> The potential error codes and their descriptions are listed in Table 14. SAX_EXCEPTION A generic parsing problem occurred (no specific location information is provided). Parameters (2): file name. system ID. TIBCO XML Canon User’s Guide . error message. Parameters (5): public ID. error message. PARSE_EXCEPTION A parsing error occurred. line number. an error document will be generated (as shown below) if the target document was not found: <xce:errorDocument xmlns:xce="http://www. The error message parameters indicate the problem area. Table 14 Error Codes Error code FILE_NOT_FOUND Descriptions The target file was not found. For example.

Managing DTD DOCTYPE Public IDs 193 | Managing DTD DOCTYPE Public IDs Follow the instructions below to manage DTD DOCTYPE public IDs with TIBCO XML Canon: 1. Specify the access path of DTD files for each public ID displayed in the page for clarification. Click the Doctypes button in the namespace browser to open the DOCTYPE Listing panel. 2. TIBCO XML Canon will use these public IDs when validating documents. The access path will either be a relative path in the TIBCO XML Canon server or an absolute HTTP-accessible URL. TIBCO XML Canon User’s Guide . See Configuring Stages on page 236 for more detailed instructions. Click Browse > Namespaces from the menu bar. Configure your stages by choosing the Namespace only option or the Namespace then location option from the namespace Resolution drop-down list. 4. A relative path begins with a '/' which represents the root category in TIBCO XML Canon (the Categories category) and an absolute path starts with http://. 3.

194 | Chapter 11 Administering Namespaces TIBCO XML Canon User’s Guide .

page 202 Managing Existing Roles. page 196 Default Roles. Topics • • • • • • Roles Overview. page 209 Managing TIBCO Administrator Roles. page 212 TIBCO XML Canon User’s Guide .| 195 Chapter 12 Configuring Roles This chapter describes role management and configuration. page 205 Assigning LDAP Users to Roles. page 199 Adding New Roles.

and tag permissions. • • ADMINISTRATOR capabilities include complete access to the TIBCO XML Canon repository and administrative functionalities. A role will either be assigned with administrator capabilities or connect capabilities. These permissions are configured in the role details panel. stage permissions. as described in Understanding Permissions on page 183. Different users will have different permissions for specific categories or stages depending on their roles. Role Permissions There are three kinds of permissions in TIBCO XML Canon: category permissions.196 | Chapter 12 Configuring Roles Roles Overview Roles determine user access levels to functions and features when a user connects to TIBCO XML Canon. CONNECT capabilities include the complete access to the TIBCO XML Canon repository only. It is recommended that you log in as a CONNECT user for all document development work and log in as an ADMINISTRATOR for administrative tasks only. shown here: Figure 117 The Role Details Panel — Permissions TIBCO XML Canon User’s Guide .

category rename. there are three kinds of access permissions on a stage: read. An administrator has the ability to assign one or a combination of these to users in the role details page. write.Roles Overview 197 | Category and Stage Permissions Categories and stages act as two distinct logical containers for XML documents. • • Stage Permissions Similar to categories. These permissions are used to control document access within each category and stage. Write — The write permission enables the user to perform a document’s initial upload. Delete — The delete permission allows the user to delete categories and documents under these categories. • • TIBCO XML Canon User’s Guide . an administrator also has the ability to modify permissions for each category (in the category detail page) and each stage (in the role configuration page) individually. Delete — The delete permission allows the user to delete all the documents which belong to a stage. and delete. It also allows the user to view the details of documents under these categories in the document details page. Category Permissions There are three kinds of access permissions for a category: read. Write — The write permission allows the user to create new revisions of all documents which belong to a stage. Furthermore. and category content relocation. An administrator has the ability to assign one or a combination of these to users in the Category Details panel. An administrator has the ability to customize permissions for categories and stages and assign them to a specific role. document revision upload. • Read — The read permission allows the user to view categories and their content in the category browser and view details of these categories in the Category Details panel. It also allows the user to view details of these documents in the document details page. • Read — The read permission allows the user to view all documents belonging to the stage in the category browser. and delete. write.

Users Users in TIBCO XML Canon will either belong to a single role or multiple roles. For more information about tags. see Chapter 8. Using Tags. Single role users will inherit all permissions assigned to that role. To delete tags. • TIBCO XML Canon User’s Guide . LDAP — Users will be assigned to TIBCO XML Canon roles via LDAP queries which are specified by an administrator if TIBCO XML Canon is using an LDAP server for authentication. Remove — Permits the role to delete a tag from a category or document. It is role specific rather than category or stage specific. Depending on the authentication settings of your TIBCO XML Canon server. it will use the LDAP default role. Each role is assigned with specific tag permissions at the time of configuration. and tags. users are assigned to roles via different media: • • TIBCO XML Canon — Users will be assigned to at least one role when configured in TIBCO XML Canon by an administrator. categories. • • • Assign — Permits the role to create a new tag and assign it to categories or documents.198 | Chapter 12 Configuring Roles Tag Permissions Tag permissions grant different levels of tag management to a role in TIBCO XML Canon. Reassign — Permits the role to assign an existing tag to a different revision of the same document. An administrator has the ability to assign one or a combination of the tag permissions to each role in the role details page. If no roles are assigned to users after the LDAP queries. Note that this permission is not granted to any role by default. on page 130. an administrator must first grant the remove permission to the appropriate role. TIBCO Administrator — Users will be assigned to roles imported from TIBCO Administrator or the TIBCO Authorization default role when using TIBCO Administrator for authentication. Multiple roles users have the highest permission level of these roles which reflect a combination of their access to different stages. Adding users to multiple roles is an effective way to establish a unique set of permissions without having to define a new role.

Web The Web role is a special role which has un-authenticated programmatic access to TIBCO XML Canon documents via an URL. Administrators The Administrators role is created at the time of installation by the TIBCO XML Canon installation manager. The Administrators role is configured with ADMINISTRATOR capabilities by default. Each is described as below. When an external document or application makes reference to a document within the TIBCO XML Canon repository. An administrator has the ability to modify or deactivate the Web role but is not allowed to delete it. You are allowed to modify. You will see this setting in the Category Details panel and the role details page within the TIBCO XML Canon user interface. but you must maintain at least one active role with an administrator capability. deactivate. However.Default Roles 199 | Default Roles TIBCO XML Canon creates five default roles at the installation time. it will automatically log in without credentials as a Web user. an administrator has the ability to assign category-specific permissions in the Category Details panel. It is important that you maintain at least one active role with ADMINISTRATOR capabilities. This allows you to create your first administrative user. you are allowed to change these permissions either in the role details page or in the Category Details panel of any category. (A default user also belongs to the Web role) A Web role is usually assigned with the read-only permission or no permission on categories and stages. see Controlling Non-Authenticated URL Access to Documents on page 181. For more information. TIBCO XML Canon User’s Guide . Otherwise you will not be able to perform administrative tasks in TIBCO XML Canon. However. This role provides you with the full access to all functions and features in TIBCO XML Canon during the initial log in. or delete this role.

For more information on creating a new portal user. see Creating Portal Users on page 223. the Portal role only has limited permissions. It is usually assigned with the read-only permission or no permission on categories and stages. However.200 | Chapter 12 Portal Configuring Roles The Portal role is a special role for anyone who logs in to the TIBCO XML Canon web interface as guests. the Portal role refers to developers who write these external documents. See Assigning LDAP Users to Roles on page 209 for more information. You will see this setting in the Category Details panel and the role details page within the TIBCO XML Canon user interface. An administrator has the ability to modify or deactivate the Portal role but is not allowed to delete it. The LDAP Default role has the read permission for categories and stages and has the assign permission for tags. Like the Web role. LDAP Default The LDAP Default role is a default role for LDAP-authenticated users if TIBCO XML Canon is using an LDAP for authentication. An administrator has the ability to modify or deactivate the LDAP Default role but is not allowed to delete it. Note that a portal user must log in to TIBCO XML Canon with a username and a password. although any user has the ability to create these credentials at the TIBCO XML Canon login page. an administrator has the ability to assign category-specific or stage-specific read permissions in the Category Details panel. These permissions are viewed and changed in the role details page. users who log into TIBCO XML Canon using their LDAP account information belong to the LDAP Default role. Unlike the Web role. which allows users to view and download external XML documents made public by a TIBCO XML Canon administrator. TIBCO XML Canon User’s Guide . Unless LDAP queries associate users with more than one role. and category-specific permission changes are made in the Category Details panel.

An administrator has the ability to modify. In this authentication mode. a user belongs to the TIBCO Authorization Default role by default unless this TIBCO Administrator role has been imported to TIBCO XML Canon. The TIBCO Authorization Default role has the read permission for categories and stages and has the assign permission for tags.Default Roles 201 | TIBCO Authorization Default The TIBCO Authorization Default role is the default role for authenticated TIBCO administrator users if TIBCO XML Canon is using TIBCO Administrator for authentication. These permissions are viewed and changed in the role details page. TIBCO XML Canon User’s Guide . and delete this role. deactivate. and category-specific permission changes are made in the Category Details panel.

follow the instructions in this section to add a new role. Click Configure > Roles from the menu bar to open the Add New Role page. follow the instructions in this section to create a new role and move on to Assigning LDAP Users to Roles on page 209 for further instructions. You will see the Add New Role page in the right-hand frame. TIBCO Administrator — If TIBCO XML Canon is using TIBCO Administrator for authentication. see Authentication Configuration on page 244. 2. To add a new role to TIBCO XML Canon: 1. Click the Add New Role button at the bottom of the Roles panel in the left-hand frame. Figure 118 Add New Role TIBCO XML Canon User’s Guide . follow the instructions in Authentication Configuration on page 244 to add TIBCO Administrator roles.202 | Chapter 12 Configuring Roles Adding New Roles TIBCO XML Canon has different ways of adding new roles because TIBCO XML Canon uses various authentication settings including: • • TIBCO XML Canon — If TIBCO XML Canon is using its own authentication mechanism. then configure them as a native role in TIBCO XML Canon. LDAP — If TIBCO XML Canon is using an LDAP server for authentication. • For more information on authentication settings.

see Roles Overview on page 196. The Stage Specific Permissions area allows you to grant permission to each stage individually. Enter a role name in the Name field. Unlike the overall stage permission you set in step 6. Choose a default stage for new document uploads from the Initial Stage drop-down list. If you are going to apply the permissions set in the Default Stage Permission drop-down list to all stages. TIBCO XML Canon User’s Guide . 8. Otherwise. the role will not be able to upload documents. Select the ADMINISTRATOR option for an administrative role or the CONNECT option for a regular role from the Capability drop-down list. then ignore the Stage Specific Permissions area. 4.Adding New Roles 203 | 3. Click the Add role and set members >> button to switch to the Membership tab. 5. underscores. select a different set of permissions from each stage’s drop-down list individually. Role names must be unique and case-insensitive. 7. This enables all members under this role to save the new document in the default stage in TIBCO XML Canon. colons. Select the appropriate permissions from the three drop-down lists: — Default Stage Permission — The default initial permission for stages. If you deactivate or delete a role’s default initial stage that is not configured with a transition into another. — Default Category Permission — The default inti al permission for categories. 6. — Tagging Permission — The default inti al permission for editing tags. and full stops. They cannot include special characters except hyphens. For detailed information about each permission.

Portal users (prefixed with a ’#’ character) and the Web user are managed by TIBCO XML Canon and will not be assigned to any roles other than the Portal or the Web role. You will now see all members you selected in the Current Members area. 10. Click the Update button. Add members to the role by checking the boxes in front of their usernames in the Not Members area.204 | Chapter 12 Configuring Roles Figure 119 The Membership Because this is a new role. its Current Members area is initially empty. 9. The Not Members area initially displays all users created by TIBCO XML Canon. TIBCO XML Canon User’s Guide .

Click a role in the Roles panel from the left-hand frame to open its role details page. except for the Active selector at the top and the function buttons at the bottom. From the role details page. Follow the instructions below to manage existing roles: 1. Configure the role’s LDAP query and query context — Assigning LDAP Users to Roles on page 209. you are allowed to: • • • • • Activate and deactivate a role — Activating and Deactivating Roles on page 206. Change role members — Changing Role Members on page 207. Change role permissions — Changing Default Permissions on page 207. Click Configure > Roles from the menu bar to open the Roles browser. reactivated. 2. TIBCO XML Canon User’s Guide . and modified in their role details page. they are allowed to be deactivated. Figure 120 The Role Details Page The role details page looks similar to the Add New Role page. Delete a role — Deleting Roles on page 206.Managing Existing Roles 205 | Managing Existing Roles After roles have been created.

Click the Update button at the bottom of the role details page. Click the Delete button at the bottom of the role details page. Portal. Deleting Roles Web. 2. They cannot log on to TIBCO XML Canon unless they have an account in the active roles list. Click the role you want to activate or deactivate in the Roles panel. In other words. 2. Newly created roles are active by default. 3. The Active section contains roles that are currently active in TIBCO XML Canon and The Inactive section contain roles that are currently inactive in TIBCO XML Canon. Select the Yes or No radio button to activate or deactivate the role in the Active selector. Follow the instructions below to delete a role: 1. Use the deactivate and reactivate functions to manage roles rather than delete and create roles repeatedly. users in the Inactive role list are deactivated and do not have any role permissions. Select a role to delete in the Roles panel. TIBCO XML Canon User’s Guide . and LDAP Default are three default roles which can only be deactivated but cannot be deleted.206 | Chapter 12 Configuring Roles Activating and Deactivating Roles The Roles panel in the left-hand frame is divided into two sections: the Active section and the Inactive section. Follow the instructions below to activate or deactivate a role: 1.

Note that this permission does not change the role’s categories permission if the role already has category-specific permissions. Note that this permission does not change the role’s stage permission if the role already has stage-specific permissions. To modify the role settings. Select a role from the Roles panel. — Default stage permission — Change the default stage permissions for the role. Click the Update button at the bottom of the role details page. Select a role to be changed from the Roles panel.Managing Existing Roles 207 | Changing Default Permissions Follow the instructions below to change role permissions: 1. You must manually set the role permissions in all the permission drop-down lists. This permission does not affect tags that have been previously assigned by members of this role. — Default category permission — Change default category permissions for the role. Figure 121 The Membership Tab TIBCO XML Canon User’s Guide . update the fields described here: — Capability — Select the role capability as ADMINISTRATOR or CONNECT. Changing role capability does not set the corresponding permissions automatically. Click the Membership tab (see Figure 121). 2. 3. Changing Role Members Follow the instructions below to change members of a role: 1. 2. — Tagging permission — Change tag permissions for the role.

Select a permission set from the corresponding drop-down list to change the role’s stage permissions for each stage. Click the role to change from the Roles panel. They were assigned to the role based on the LDAP query of the role. 2. 3. Check the checkboxes in front of member names in the Not Members area to add members to the role. TIBCO XML Canon User’s Guide . You can click the Update button in either area (the Current Members area or the Not Members area). Uncheck the checkboxes in front of member names in the Current Members area to remove members from the role then click the Update button. 4. See Managing Categories on page 173 for more information. Follow the instructions below to change stage-specific permissions: 1. 3. Click the Update button at the bottom of the role details page. You can click the Update button in either area (the Current Members area or the Not Members area). You are allowed to change a role’s stage-specific permissions in the role details. You can also view LDAP users who logged on to the server recently in the Current Members area. The Stage Specific Permissions area in the role details page lists each stage individually with their own permission drop-down lists.208 | Chapter 12 Configuring Roles The Membership tab provides two lists: a list of users who are members currently and a list of users who are not members. Changing Category. then click the Update button.and Stage-specific Permissions You are allowed to change a role’s category-specific permissions in the Category Details panel. Click send email in the Current members title bar to send emails to all role members.

TIBCO XML Canon automatically creates an account for the user. In this case. An administrator will manually modify the role memberships for users. TIBCO XML Canon uses LDAP queries to assign an user with one or more TIBCO XML Canon roles.Assigning LDAP Users to Roles 209 | Assigning LDAP Users to Roles When TIBCO XML Canon is configured with LDAP authentication. You will be able to specify an LDAP query and a query context for each role in the role details page. users can log in with their LDAP username and password. Role Details Page in LDAP Authentication Mode If your TIBCO XML Canon server uses LDAP authentication. After an LDAP user successfully logs in to TIBCO XML Canon for the first time. the role details page for each role will look similar to Figure 122. These users are not in the XML Canon user list. Figure 122 Role Details Page in LDAP Authentication Mode TIBCO XML Canon User’s Guide .

This condition ensure that only one user will be returned by the query (see the example in Figure 123). make sure that you specified a valid organization unit within the organization root when you configured LDAP authentication for TIBCO XML Canon. LDAP queries (string representations of LDAP search filters) are defined by the Network Working Group Request for Comments 2254 (RFC 2254). For more information. Select the role to be configured from the Roles panel. TIBCO XML Canon uses this value to filter the LDAP query. The number of roles assigned to a user depends on the number of true responses after the LDAP query evaluation. 4. Include the (uid={0}) condition in your query string.210 | Chapter 12 Configuring Roles When an LDAP login occurs. where variable {0} will be replaced by the TIBCO XML Canon login username automatically. If none of the LDAP query evaluations return true. see Authentication Configuration on page 244. The user is assigned to a role if the result of the query evaluation is true. If you specify a value in the LDAP query context field. Configuring LDAP Queries Follow the instructions below to configure LDAP role queries: 1. TIBCO XML Canon authenticates the user using its own authentication mechanism. 3. Read the documentation in http://rfc. Specify the query string in the LDAP query field. (Optional) Specify your query context in the LDAP query context field.net/rfc2254.html for complete information on search filters and syntax. Click the Update button at the bottom of the page. 2. all queries with their accompanying query contexts are evaluated. TIBCO XML Canon User’s Guide . Apply the query above on multiple roles to place an LDAP user into multiple roles. After that. Figure 123 shows an LDAP query example. the user will be assigned to the LDAP Default role. LDAP queries are evaluated only when an LDAP user logs in to TIBCO XML Canon for the first time. The query context in this example is the engineering organizational unit and the query string searches for a user whose location attribute equals to Anytown and the username equals to the login user.

Follow the instructions below to view what roles your LDAP user will belong to after all the LDAP queries are evaluated: 1. Click Configure > Users from the menu bar to open the Users panel. you can test your LDAP query configurations using the Role lookup feature in the LDAP tab of the Users panel. Rewrite your LDAP queries in the role details pages until you are satisfied with the lookup result. Click the LDAP tab in the Users panel. 2. 3.Assigning LDAP Users to Roles 211 | Figure 123 The LDAP Query Example Testing LDAP Queries for Roles In TIBCO XML Canon. TIBCO XML Canon User’s Guide . Enter the username and click the Show button in the Role Lookup field at the bottom of the LDAP tab.

This user belongs to the CanonDev role. Note that the TIBCO Administrator user. Figure 125 shows the Membership tab of the CanonDev role. TIBCO XML Canon User’s Guide . Therefore. you can only add or remove TIBCO XML Canon users under this tab. users will log in to TIBCO XML Canon using their TIBCO Administrator credentials.212 | Chapter 12 Configuring Roles Managing TIBCO Administrator Roles When TIBCO XML Canon is configured with TIBCO Administrator authentication. except the TIBCO Administrator users who belong to these roles are unchangeable. You will see CanonDev and Guests roles from the Active role list. You will see these imported roles along with other roles in the Roles panel. Note that they are both marked with the (T) prefix. Figure 124 shows a Roles panel after an TIBCO Administrator user logged into TIBCO XML Canon for the first time. Figure 124 The List of Roles Including TIBCO Administrator Roles in The Roles Panel The role details page for TIBCO Administrator roles provides the same information as roles in TIBCO XML Canon. These two TIBCO Administrator roles are imported when users who belong to these roles log in. TIBCO Administrator roles are automatically imported into the TIBCO XML Canon database with the special (T) prefix when users log in to TIBCO XML Canon. in the Current Members area (marked with the (T) prefix) does not have a checkbox like other TIBCO XML Canon users. tibuser.

A page will display all current roles in TIBCO Administrator. 5. Click Manage TIBCO Administrator Roles >>. Click the Authentication tab in the Policy Configuration page. 3. click Delete. Go to the role configuration page to assign permissions to the added role. You must manually assign their permissions after they are imported. TIBCO Administrator roles are imported with permissions equivalent to the Portal role. If you want to remove a role. Click the Add button on the right-hand side to add a role. 4. If TIBCO XML Canon is using TIBCO Administrator for authentication. 2. TIBCO XML Canon User’s Guide .Managing TIBCO Administrator Roles 213 | Figure 125 A TIBCO Administrator Role (CanonDev) under the Membership Tab TIBCO Administrator roles will be managed the same way as other TIBCO XML Canon roles (see Managing Existing Roles on page 205). Importing TIBCO Administrator Roles Manually Follow the instructions below to manually import TIBCO Administrator roles from the Policies page: 1. you will see the TIBCO Administrator Server Configuration area. Click Configure > Policies from the menu bar to open the Policy Configuration page.

214 | Chapter 12 Configuring Roles TIBCO XML Canon User’s Guide .

Topics • • • • Users Overview. page 216 Creating a New User.| 215 Chapter 13 Configuring Users This chapter describes user configuration and management in TIBCO XML Canon. page 223 Managing Existing Users. page 221 Creating Portal Users. page 225 TIBCO XML Canon User’s Guide .

which are created by any TIBCO XML Canon user in the login page. These users have a special prefix (the # character) in their TIBCO XML Canon username and are able to browse documents in the repository that have been made public by a TIBCO XML Canon administrator. • • Users Panel TIBCO XML Canon enables you to create new user accounts. deactivated. but be sure to maintain at least one active user with an ADMINISTRATOR capability at all times. TIBCO Administrator users. Administrator User When you install TIBCO XML Canon. and managed by a TIBCO Administrator that is external to TIBCO XML Canon. It is used to configure users in TIBCO XML Canon. which are created by a TIBCO XML Canon administrator. you are prompted to create an initial administrative account. Portal users. This user can be modified. which are created. and deactivate or reactivate users via the users panel. which are created. authenticated. The administrator user name specified during installation is also created automatically. Figure 126 The Users Button in the Menu Bar The Users panel always displays in the left-hand frame and shows both active and inactive users. LDAP users. view and edit the profiles of existing users. or deleted. Click Configure > Users from the menu bar to access the users panel. authenticated. You may also see an LDAP tab or a TIBCO Administrator tab depending on the authentication setting in TIBCO XML Canon. TIBCO XML Canon User’s Guide . You will see a Normal tab and a Portal tab at the top of the Users panel.216 | Chapter 13 Configuring Users Users Overview TIBCO XML Canon supports several user types: • • Normal users. and managed by an LDAP server that is external to TIBCO XML Canon.

Portal user accounts are used to browse the TIBCO XML Canon repository. Portal Users The Portal tab displays all Portal users which are created by internet users. For more information about the Web user. email address. Each Portal user has an username which is prefixed with the # character. Select a username to view and edit the user account information. The # character must be used in front of the username when logging in. Because Portal users have very limited privileges. password. some user-interface related configurations. including role memberships and some user-interface related configurations. TIBCO XML Canon User’s Guide . Portal usernames are automatically prefixed with a # character so it is easy to distinguish from other users during configuration activities.Users Overview 217 | Normal Users The Normal tab displays when the Users panel opens by default. see Web (Un-authenticated) User on page 219. administrators are allowed to edit their username. and deactivate or reactivate Portal users. You will also see an user named Web under this tab. It lists all TIBCO XML Canon users created by a TIBCO XML Canon administrator.

You are also allowed to view the role memberships of users on the LDAP server under the LDAP tab. You are allowed to edit LDAP role membership and deactivate or reactivate them.218 | Chapter 13 Configuring Users LDAP Users If TIBCO XML Canon is configured with LDAP authentication. you are not allowed to edit LDAP user account information because it is imported from the LDAP server. Role membership is determined using the LDAP queries configured in the roles detail page in TIBCO XML Canon. TIBCO XML Canon User’s Guide . However. For more information. the LDAP tab will display users who logged in with their LDAP credentials. see Testing LDAP Queries for Roles on page 211.

the TIBCO Administrator tab will display users who logged in with their TIBCO Administrator credentials. Web (Un-authenticated) User The Web user is created by TIBCO XML Canon for un-authenticated. Web users are shown in the TIBCO XML Canon user interface in order to allow an administrator to control unauthenticated external access. they will automatically log in to TIBCO XML Canon as Web users. programmatic access to TIBCO XML Canon. The administrator can also look up TIBCO Administrator users’ current role memberships in the Role Lookup area. TIBCO XML Canon users will be able to send emails to TIBCO Administrator users from the web interface after the creation of their email addresses in XML Canon.Users Overview 219 | TIBCO Administrator Users If TIBCO XML Canon is configured with TIBCO Administrator authentication. The role lookup operation will fail if users who belong to that role are not currently logged in to TIBCO XML Canon. see Accessing Documents via URL on page 111. or activate their role membership. When an external application or document makes an URL reference to a document within the TIBCO XML Canon repository. TIBCO XML Canon deals with Web users internally and does not need to be recognized by external applications or documents. deactivate. For more information on making un-authenticated URL access to documents. TIBCO XML Canon User’s Guide . An administrator can also edit. TIBCO XML Canon provides this unauthenticated access to allow external sources to access TIBCO XML Canon documents without any credentials.

For more information on controlling un-authenticated access to documents.220 | Chapter 13 Configuring Users An administrator also has the ability to control which documents are visible to un-authenticated sources. An administrator has the ability to rename or deactivate the Web user role but is not allowed to delete it. see Controlling Non-Authenticated URL Access to Documents on page 181. Renaming the Web user will not conflict with any clients that request internal documents in TIBCO XML Canon. TIBCO XML Canon User’s Guide .

Creating a New User 221 | Creating a New User This section describes how to create users within TIBCO XML Canon. Users authenticated by an LDAP server or TIBCO Administrator are automatically imported into TIBCO XML Canon. Click Configure > Users from the menu bar to open the Users panel. because that character is used as an indicator for Portal users. Follow the rules below to create the username: • • • • This username must be unique. TIBCO XML Canon User’s Guide . Enter a username for this new user in the User Name field. Do not include the following special characters in the username: ' > < ] | = ) & ! " ? * The initial character of the username must not be the # character. refer to Authentication Configuration on page 244. Click the Add New User button at the top of the Users panel. The Add New User page will appear in the right-hand frame. Usernames are case-sensitive and must not contain any spaces. Follow the instructions below to create a user: 1. as shown here: 3. For more information on LDAP and TIBCO Administrator users. 2.

9. 8. on page 195. For more information about roles. Enter the full name of the user in the Full Name field. 6. Click the Add user button. Specify a password in the Password field follow the rules below: • • Passwords are case-sensitive. TIBCO XML Canon User’s Guide . see Chapter 12. Check the checkboxes next to the roles you want to assign to the user in the Role Membership area. They can only be automatically assigned by TIBCO XML Canon.222 | Chapter 13 Configuring Users 4. This field can contain spaces. Web and Portal roles are special roles and cannot be manually assigned to users. Configuring Roles. Re-enter the password to confirm it in the Confirm Password field. 5. Do not include the following special characters in the password: ' > < ] | = ) & ! " ? * 7. Enter a valid email address for this user in the Email Address field.

Enter the full name of the user in the Full Name field. Some documents in TIBCO XML Canon will be published for the general public by administrators. This field can contain spaces. You will see the Create TIBCO XML Canon Portal User page (see Figure 128). Enter a username for this new user in the User Name field.Creating Portal Users 223 | Creating Portal Users This section describes how to create a portal user and use it to connect to the portal interface of TIBCO XML Canon. The instructions below demonstrates how to create a portal user and how to log in as a portal user in TIBCO XML Canon: 1. Figure 127 The Create New Portal Account Link 2. Any user can log in to TIBCO XML Canon as a portal user with a valid username and password. An administrator can restrict the permission further by modifying the configurations of the Portal role. After a portal user has been created. For further information on the Portal role. this user is automatically added to the Portal role. Portal users will be able to view and download these documents from the repository. Do not include the following special characters in the username: ' > < ] | = ) & ! " ? * 3. Usernames are case-sensitive and must not contain any spaces. The portal user has read-only permission on all categories and stages. see Default Roles on page 199. Follow the rules below to create the username: • • • This username must be unique and must begin with the # character. Click Create New Portal Account in the TIBCO XML Canon login page (see Figure 127). TIBCO XML Canon User’s Guide .

Figure 128 Create a Portal User in the TIBCO XML Canon Portal User Page After the submission. You will see the portal homepage. Enter a valid email address for the user in the Email Address field. To log in at a later time. Click the Submit button. 7. re-enter the username and password provided in the TIBCO XML Canon Portal User Page in the TIBCO XML Canon login page. TIBCO XML Canon will log you in as a portal user. Do not include the following special characters in the password: ' > < ] | = ) & ! " ? * 6.224 | Chapter 13 Configuring Users 4. Re-enter the password to confirm it in the Confirm Password field. Specify a password in the Password field follow the rules below: • • Passwords are case-sensitive. TIBCO XML Canon User’s Guide . 5.

Deactivating an user has an effect similar to that of deleting a user. email address. TIBCO XML Canon User’s Guide . It is safer to deactivate a user before deletion in case you need to reactivate the user later. LDAP Users The LDAP user details page is uneditable except for the activation or deactivation and delete functions. Figure 129 The User Details Page Click the Update user button or the Update password button to save changes after editing the user profile. The user details page enables you to activate or deactivate users and edit users’ details such as username. These users will no longer be able to log in to TIBCO XML Canon.Managing Existing Users 225 | Managing Existing Users Click on a username in the Users panel to modify existing user profiles. full name. Deactivated users are listed in the Inactive area of the users panel. and password (see Figure 129).

226 | Chapter 13 Configuring Users Deactivate LDAP users from the user details page to prevent their connection to TIBCO XML Canon. the Full Name and the Email Address are can be changed (see Figure 130) Figure 130 The TIBCO Administrator User Details Page . Enter a username in the User Name field of the Role Lookup area to view the user role details. The number of users permitted by the licensing agreement does not include inactive users. The number of users permitted by the licensing agreement does not include any inactive users. This happens because their accounts are not removed from the LDAP server. However. Do not perform the Deletion function because LDAP users will still be able to log in. TIBCO Administrator Users The username in the Administrator users’ detail page is uneditable. Click the Show button to display the results. LDAP Users LDAP users’ role membership are groups which the user belonged to when they last logged in. TIBCO XML Canon User’s Guide .

role results will be shown as shown here: If the LDAP configuration is incorrect. Because role memberships are dynamically computed when log in. an error will be reported when you attempt to look up the roles. For more information on LDAP authentication. TIBCO XML Canon User’s Guide .Managing Existing Users 227 | If the LDAP configuration is correct. see Authentication Configuration on page 244. LDAP users will appear to be members of the role which was assigned to them during their last login.

228 | Chapter 13 Configuring Users TIBCO XML Canon User’s Guide .

| 229 Chapter 14 Configuring Stages This chapter describes stage configuration and management by an administrator. page 233 Configuring Stages. Topics • • • Stages Overview. page 230 Creating Stages. page 236 TIBCO XML Canon User’s Guide .

After it has advanced out of Development. the administrator selects the stages that a document can transition to. but not to Production. you have the ability to control these transitions. XML Canon users are then able to move documents from one stage to the next as development progresses. consider these three stages: Development. a document may also need to transition backwards. After once the stages are in place. Documents may transition to When configuring a stage. Also. As such. and Production. TIBCO XML Canon User’s Guide . edit. For example. a document may require further changes at any point in its life cycle. Testing. a document should follow a defined workflow. An XML document most likely begins in the Development stage. This varies the access levels between stages. When creating or configuring stages. An XML document can only move from one stage to another if it meets the other stage’s entry conditions. a document in Production should not transition back to testing. it is because the document requires further development (not testing). Therefore. An administrator has the ability to set the stage permission for each role. Stage Transitions Stages are most useful when their configuration reinforces the document life cycle. For example. A life cycle can be divided into chronological sections and each TIBCO XML Canon stage corresponds to each section. However. You can define transitions between different stages and grant different stage permissions to different roles. or progression through stages. Consider the above example. a document in the Development stage may be able to transition to Testing. On the other hand. That means a user can have more or less access to a document when it moves to a different stage. the stage-specific permissions grant different permissions to each stage for each role. then transitions to Testing and from there to Production. and delete documents in each stage by setting the Stage Permission in user roles. you also control which users can view. both Testing and Production stages may transition back to Development. Each stage has different entry conditions.230 | Chapter 14 Configuring Stages Stages Overview Stages in TIBCO XML Canon help you to define and manage XML documents during their development life cycle. if you are demoting a document from Production.

you must configure the document stages in TIBCO XML Canon as soon as possible so the document can move through the development life cycle. The default stage is created by the TIBCO XML Canon installation manager. For example. see Stage Permissions on page 197. However. but does not allow a document to transition from Development. and delete documents. the Production stage may allow a document to transition from the Testing stage into Production. TIBCO XML Canon User’s Guide . These permissions determine which roles can view documents in the stage. A document will be moved to a default stage if it is not specified during its initial upload. Default Stage All documents in TIBCO XML Canon must belong to an active stage at all times. For more information.Stages Overview 231 | Documents may transition from The administrator also selects the stages that a document can transition from. Stage Permissions Stage permissions are determined by settings in roles. You are allowed to rename or deactivate the Default stage as long as you maintain at least one active stage at all times. add or make changes to those documents. the administrator must assign stage permissions to one or more roles. After creating a new stage.

Figure 131 The Stage Button in the Menu Bar The Stages browser displays in the left-hand frame. Figure 132 The Stages Browser TIBCO XML Canon User’s Guide . and contains an Active list and an Inactive list of stages (shown below).232 | Chapter 14 Configuring Stages Stages Panel Click Configure > Stages from the Administrator menu bar.

and full stops. 4. The Add New Stage page will appear in the right-hand frame (as shown in Figure 133). Stage names cannot include special characters with exceptions of hyphens. underscores. colons. Click the Add New Stage button at the bottom of the Stages panel.Creating Stages 233 | Creating Stages Follow the instructions below to create a new stage: 1. TIBCO XML Canon User’s Guide . Specify a stage name in the Stage Name field. Figure 133 The Add New Stage Page 3. If you select the radio button no. Click Configure > Stages from the menu bar to open the Stages panel. Select the radio button yes from the Transition to self option if the documents will remain in this stage after revision. the documents must transition out of the stage after they are updated to a new revision. 2.

When resolving public IDs under this option. Select the method TIBCO XML Canon will use to resolve references to schemas when validating the documents from the Namespace Resolution drop-down list. TIBCO XML Canon uses the URLs specified in instance documents first. — Location only — TIBCO XML Canon will try to resolve schema references using the value of the schemaLocation attribute only. TIBCO XML Canon will use the access paths specified in the DOCTYPE Listing panel first. When resolving public IDs under this option. TIBCO XML Canon will use the access paths specified in the DOCTYPE Listing panel. If this fails. If this fails. There are four available options: — Namespace then location — TIBCO XML Canon will try to resolve the schema using the namespace URI first. When resolving public IDs under this option. If this fails. TIBCO XML Canon uses the URLs specified in instance documents only. 6. — Namespace only — TIBCO XML Canon will try to resolve schema references using the namespace URI only. When resolving public IDs under this option.234 | Chapter 14 Configuring Stages 5. Specify the pre-requisite transition rules for this stage in the Conformance Rules area. The chosen method is used by the TIBCO XML Canon validation tool when you validate documents in this stage. resolution will be attempted using the value of the schemaLocation attribute. TIBCO XML Canon will use the URLs specified in instance documents. If this fails. — Location then namespace — TIBCO XML Canon will try to resolve the schema using the value of the schemaLocation attribute. resolution will be attempted using the namespace URI. TIBCO XML Canon determines whether documents are allowed to TIBCO XML Canon User’s Guide . TIBCO XML Canon uses the access paths only specified in the DOCTYPE Listing panel.

Select the stage or stages which documents can transition from in the Documents May Transition From area. documents in the Design stage can transition into the Default. — Documents must be well-formed — Only documents that are well-formed can transition into this stage. When the Documents must be valid option is selected. If you are creating stages for the first time. Select the stage or stages which documents can transition into from the Documents May Transition To area. 7. Production. Production. page 207 for more information. TIBCO XML Canon User’s Guide . or Testing stage.Creating Stages 235 | transition into this stage based on this setting. and Testing stage. Click the Add stage button. Development. you must also configure role permissions for the stage. — Documents must be valid — Only valid instance documents and valid schemas or DTDs can transition into this stage. XML documents without reference to a schema or DTD are not allowed into the stage because they are not valid. After creating a stage. There are three available options: — Documents do not need to be well-formed — Any document can transition into this stage. They can also transition from the Deprecated. In Figure 133. 8. create all stages before configuring the document transition settings. See Changing Default Permissions. Development. 9.

2.236 | Chapter 14 Configuring Stages Configuring Stages This section describes how to configure stages as an administrator. For information on adding documents to stages and moving documents between stages. — Change document transitions. Click the Update button to apply the changes or click the Delete button to delete this stage. Select a stage from the Stages panel to open its Stage Details page. Figure 134 The Stage Details Page 3. The Stage Details page looks similar to the Add New Stage page except for the buttons on the bottom of the page. Click Configure > Stages from the menu bar to open the Stages panel. Follow the instructions below to configure an existing stage: 1. Perform the following tasks from the Stage Details page (see Creating Stages on page 233 for more information on each task): — Rename a stage. refer to Managing Documents with Stages on page 97. — Change the namespace resolution method for document validation. 4. — Change the conformance rules. — Activate or deactivate a stage. TIBCO XML Canon User’s Guide .

Deactivating or deleting a default stage for a role will prohibit the role from uploading new documents. In other words. except the stage settings are preserved. Only delete a stage permanently if you are certain you no longer need it. TIBCO XML Canon User’s Guide . Therefore it is recommended that you deactivate a stage before deleting it. However. If the transition list is empty and the default role is removed. A deactivated stage acts the same as a deleted stage. Documents in the deleted stage will not transition to another stage. you can still make document revisions within the stage. the document will not be saved.Configuring Stages 237 | Notes on Deleting and Deactivating Stages After a stage is deactivated. documents will only be saved if they are in the transition list from the role’s initial upload stage. you will not be able to add new documents to the stage or transition documents from this stage to another stage.

238 | Chapter 14 Configuring Stages TIBCO XML Canon User’s Guide .

Topics • • • • • • Policies Page Overview. page 244 Install Tab. page 250 Server Status. page 251 Checking Database Consistency.| 239 Chapter 15 Configuring Policies This chapter describes policy configuration and management. page 252 TIBCO XML Canon User’s Guide . page 241 Authentication Configuration. page 240 General Policies.

240 | Chapter 15 Configuring Policies Policies Page Overview Administrators use the policies page to customize the TIBCO XML Canon behaviors and view installation information and the status of the TIBCO XML Canon server. Status states the current status of the TIBCO XML Canon server. Purge enables you to purge documents and categories that have been deleted by users. Click Configure > Policies from the menu bar to open the Policies page. Purging frees up space on the database server. Install contains the current TIBCO XML Canon installation information. See General Policies on page 241 for more information. See Authentication Configuration on page 244 for more information. See Purging Deleted Categories and Documents on page 177 for more information. A brief description has been provided below: • • Policies contains the configurable properties of the TIBCO XML Canon server. • • • TIBCO XML Canon User’s Guide . See Server Status on page 251 for more information. You can see five tabs at the top of the policies page. Authentication allows you to specify the way TIBCO XML Canon authenticates user logins.

See descriptions for each policy below. Each policy can only be updated by its corresponding Update button. Click on the property’s corresponding Update button to update the property setting. TIBCO XML Canon User’s Guide .General Policies 241 | General Policies This section describes the configurable policies in the Policies tab. • Zero size documents — Specifies whether TIBCO XML Canon allows empty documents when the file path in a document upload does not point to an actual file. This policy is enabled by default. Figure 135 The Policies Tab in the Policies Page There are thirteen policies to specify in this tab.

000 bytes. TIBCO XML Canon will apply this change and remove the oldest reports from the report cache (without regard to which user owns a report) until the number of reports in the cache meets the limit defined. Reporting limits (individual) — Specify the maximum number of reports that a single user can cache. Modifying this parameter does not take immediate effect. Maximum document size (bytes) — Specifies the maximum size of documents to be uploaded.000. Reporting limits (days) — Specifies the maximum days that a report can be cached. see Web (Un-authenticated) User on page 219.728. For more information on accessing documents with their URLs. Search result limits — Specifies the maximum number of search results returned in TIBCO XML Canon. This path is the absolute path in TIBCO XML Canon (beginning with the root category which is represent by a '/').640 bytes. Its default value is 1000 items. For more information about Web users. The acceptable range is 4. Reporting limits (total)— Specifies the maximum number of reports that all users can cache. It only takes effect after the user generates a new report. If a user attempts to run a report immediately and the number of documents exceeds the defined limit. Its default value is 24 hours.242 | Chapter 15 Configuring Policies • HTTP addressability — Specifies whether external documents or applications can access documents in the repository without authentication. This information is used when referring to documents (directly or indirectly) on the Internet during document validation. The default value is 15. Its default value is 60 minutes. Session length (hours) — Specifies the maximum login length of a user. It only takes effect when a new report is generated.000 to 75. Reporting limits (documents) — Specifies the maximum number of documents in a single report. TIBCO XML Canon will not run the report and will • • • • • • • • • • TIBCO XML Canon User’s Guide . SOX resolution path — Specifies a SOX schema path for URN resolution. TIBCO XML Canon checks the length of time reports remain in the repository every time a new report is generated or every 30 minutes. TIBCO XML Canon will apply this change and remove the oldest reports from the user’s cache until the number of reports in the cache meets the limit defined. Session timeout (minutes) — Specifies the maximum timeout length for users who performed no activities during this time. Modifying this parameter does not take immediate effect. see Accessing Documents via URL on page 111. HTTP proxy server — Specifies an HTTP proxy server if it is in use. This policy is enabled by default and applies to the Web user.

the report will be generated with the maximum number of components only and also display an error message. If the number of documents and components are both over the limits. If a user schedules a report that exceeds the defined limit. If the number of documents and components are both over the limits. If an user attempts to run a report immediately and the number of components exceeds the defined limit. the error message will only indicate the number of documents exceeds the limit. TIBCO XML Canon will not run the report and will display an error message instead.General Policies 243 | display an error message instead. TIBCO XML Canon User’s Guide . the error message will only indicate the number of documents exceed the limit. • Reporting limits (components) — Specifies the maximum number of components in a single report. the report will be generated with the maximum number of documents only and also display an error message. If a user schedules a report that exceeds the defined limit.

Figure 136 The Authentication Tab in the Policies Page Internal TIBCO XML Canon Authentication Only If the Internal TIBCO XML Canon Authentication Only radio button has been selected. Internal authentication is always available and can be used in conjunction with either an LDAP server or TIBCO Administrator for authentication. Click the Update button. TIBCO XML Canon first authenticates users as internal users. You will see an LDAP Configuration area in the Authentication tab (see Figure 137). Select the LDAP Authentication radio button. 2. You can either use the internal TIBCO XML Canon authentication on its own or use an external application such as an LDAP server or a TIBCO Administrator along with the internal TIBCO XML Canon authentication. LDAP Authentication Follow the instructions below to use an LDAP server for authentication: 1. it will query the LDAP server or TIBCO Administrator in the Authentication tab. If the internal authentication does not produce a match. TIBCO XML Canon will use its own authentication mechanism to log in users who were created and managed in TIBCO XML Canon. TIBCO XML Canon User’s Guide . This will be achieved under the Authentication tab (see Figure 136).244 | Chapter 15 Configuring Policies Authentication Configuration Authentication configuration allows you to configure the way TIBCO XML Canon authenticates its users.

Check the Secure checkbox if the LDAP server uses a secure connection. the LDAP Server field must begin with ldaps://. Specify the root entry for your LDAP server in the Organization Root field. • • Login DN (optional): This option is optional. This is optional and depends on your configuration. Passwords are case-sensitive.Authentication Configuration 245 | Figure 137 The Authentication Tab — LDAP Authentication 3. 4. Figure 138 The List of Candidate Organization Roots TIBCO XML Canon User’s Guide . Specify the host name of the LDAP server in the LDAP Server field. You can click the Suggest button to view the list of candidate organization roots (see Figure 138). 5. Login DN password: The DN password for the LDAP server. If you check the Secure checkbox. Only users under this LDAP root have access to TIBCO XML Canon.

— Adding additional query parameters to the default query provides an easy way to limit the number of LDAP users who log in to TIBCO XML Canon. Testing Login DN A login DN works correctly with native Microsoft LDAP applications. Therefore. you will receive a message similar to the following: LDAP: error code 49 .246 | Chapter 15 Configuring Policies 6. For information on assigning role membership to LDAP users.80090308: LdapErr: DSID-0C09030B. Troubleshooting LDAP with Microsoft Active Directory If you are using Microsoft Active Directory with TIBCO XML Canon and an LDAP directory. data 525. if you want to limit users who log in to TIBCO XML Canon by setting their location attribute to Anytown. For example.com/jxplorer/) is a testing tool that resolves this problem. Read the documentation in http://rfc. TIBCO XML Canon User’s Guide . This is because Microsoft LDAP applications use non-standard LDAP extensions. Use (samaccountname={0}) rather than the default query (uid={0}) for more accurate results. Click the Update button at the bottom of the page. but does not work with LDAP components in TIBCO XML Canon. Specify an LDAP query in the User Query field following the guidelines below: — Always include (uid={0}) in your LDAP query string to ensure a single entry will return from the LDAP server. Read the notes below to find a solution to the problem.net/rfc2254. The JXplorer (http://pegacat. you have possibly specified an invalid Login DN or a bad password. 7. (uid={0}) is the default query and {0} is a variable which will automatically replace the login username. — Microsoft Active Directory uses a different LDAP property for the username field. see Assigning LDAP Users to Roles on page 209. you will use the string below in the User Query field: — (&(l=Anytown)(uid={0})) — LDAP queries (string representations of LDAP search filters) are defined by the Network Working Group Request for Comments 2254 (RFC 2254). you need to test the DN with a third-party LDAP client before you test it with TIBCO XML Canon. v893] If this happens.html for complete information on search filters and syntax. comment: AcceptSecurityContext error.

dc=yyy. ..com) instead of a normal LDAP specification. TIBCO XML Canon User’s Guide . domain\suser or instead of the typical comma-separated list of LDAP assignments (such as cn=xxx.com NT Domain: domain Options: • • Use the full name of users as the value of the cn= clause for your DN. use cn=Some User instead of cn=suser) Use the domain name with the login name. see the section below for the way to conform non-standard DNs to the common LDAP format. suser@example.. (For example. Try the following options in the example below: Example: Full name: Some User Login name: suser Email address: suser@example.Authentication Configuration 247 | If your DN does not work with third-party LDAP clients. (For example.) domain/suser) • Use the email address on its own. (For example. Non-standard LDAP DNs Microsoft Active Directory allows for non-standard DNs.

If the verification is successful. Figure 139 The Authentication Tab — TIBCO Administrator Authentication 3. Click Manage TIBCO Administrator Roles to view all the active roles in TIBCO Administrator and add them to the TIBCO XML Canon server after configuring TIBCO XML Canon with TIBCO Administrator authentication (see Figure 140). 5. 4. Specify the port number used by the TIBCO Administrator server. Click the Update button. Select the protocol used by TIBCO Administrator from the Protocol drop-down list. Specify the TIBCO Administrator server’s host name in the Server field. Click the Update button. Close this window after reviewing the confirmation. Choose the TIBCO Administrator Authentication option. You will see the TIBCO Administrator Configuration area appears. 6. Click the Verify button to complete the configuration. a confirmation message appears in a separate window. 2. 7. TIBCO XML Canon User’s Guide .248 | Chapter 15 Configuring Policies TIBCO Administrator Authentication Follow the instructions below to use TIBCO Administrator for authentication: 1.

TIBCO XML Canon User’s Guide .Authentication Configuration 249 | Figure 140 The Available Roles Page For more information on managing TIBCO Administrator roles. see Managing TIBCO Administrator Roles on page 212.

Figure 141 The Install Tab in the Policies Page TIBCO XML Canon User’s Guide . Information in this tab in uneditable.250 | Chapter 15 Configuring Policies Install Tab The Install tab provides environment information and configuration settings for the current TIBCO XML Canon installation.

TIBCO XML Canon User’s Guide . See Checking Database Consistency on page 252. You must have access to the TIBCO XML Canon server’s operating system to view the entire set of log files. view the Analyzed metadata in the document details page for the document. but you must not treat it as a substitute for accessing log files directly. This is used as the first attempt to diagnose problems remotely.. Figure 142 The Status Tab in the Policies Page A short description has been provided below for each attribute in this tab: • Documents queued for analysis — The number of documents waiting to be analyzed.Server Status 251 | Server Status The Status tab in the Policies page provides information about the current operating status of the TIBCO XML Canon server. — Click this link to view a partial record of the application log for TIBCO XML Canon. This JVM runs on the TIBCO XML Canon server.. • • • • • • Perform a database consistency check to ensure your database meets minimum standards. Maximum memory — The maximum memory that the JVM can consume on the TIBCO XML Canon server. This is not available to other applications that runs on the same machine. To see if a particular document has been analyzed. TIBCO XML Canon will not report document-level or component-level relationships for a document until it has been analyzed. Document being analyzed — The name of the document which is currently being analyzed. Available processors — The number of processors used on the machine which runs the TIBCO XML Canon server. Total memory — The total memory which the TIBCO XML Canon server’s operating system allocates to the JVM. Free memory — The available memory which JVM (Java Virtual Machine) allocates to TIBCO XML Canon. Log.

If there are any inconsistencies. Figure 143 The Inconsistency Error Log TIBCO XML Canon User’s Guide . To checking whether your database meets minimum consistency standards. as described in Connecting to the TIBCO XML Canon Web Interface on page 10. visit the following webpage: http://<hostName>:<portNumber>/xc/rqst/consistencyCheck. TIBCO XML Canon found three types of inconsistencies in the example below: • • • Category has valid parent—3 Document has valid body—1 inconsistencies. an error log will display and categorize them by their error types. TIBCO XML Canon will perform a consistency check on the current database server in this web page.252 | Chapter 15 Configuring Policies Checking Database Consistency TIBCO XML Canon has the ability to check the consistency of the database server it uses. Latest document revision is tagged either latest or deleted—8 inconsistencies. inconsistency.srp where hostName and portNumber are your XML Canon host and port.

2/tomcat/logs/. Review the complete application record and access logs in TIBCO_HOME/xmlcanon/3. TIBCO XML Canon User’s Guide . Review the server status log in the Status page (see Server Status on page 251 for more information).Checking Database Consistency 253 | You can also check the database consistency using other methods: • • • • Check the statistics page of each category (see Managing Categories on page 173 for more information). Periodically check the system which runs the database server for available disk space and memory.

254 | Chapter 15 Configuring Policies TIBCO XML Canon User’s Guide .

page 263 TIBCO XML Canon User’s Guide . page 260 Adding New Memo Properties.COn 255 | Chapter 16 Configuring Custom Properties COn This chapter describes custom properties configuration and management. page 262 Managing Existing Memo Properties. page 256 Configuring New Enumeration Properties. page 258 Managing Existing Enumeration Properties. Topics • • • • • Custom Properties Overview.

remove. Add. If you have the write permission to both the category and the stage of the category. define an enumeration called Department with possible values such as Accounting. you can perform the following functions: • • Add. There are two types of custom properties: • Enumerations — A key value pair. Removing. Memos — A key value pair. For more information. It is an excellent tool to organize and search for documents and components within TIBCO XML Canon. and edit custom properties to components via the component details page (see Editing Custom Properties for Components on page 128). • Adding. and edit custom properties via the document details page (see Updating Document Properties on page 96). and so on. Engineering. The Custom Properties panel lists all currently active custom properties and inactive custom properties (see Figure 144). Click Configure > Custom Properties from the menu bar to open the Custom Properties panel. and Editing Custom Properties If you have the write permission to categories. You define a value list (often a drop-down list) and select a value from the list. The value will be free-form text which is similar to the Comment metadata in documents. This is achieved via either the TIBCO XML Canon web interface or a WebDAV client such as Turbo XML. see Uploading Documents on page 89 and Managing WebDAV Uploads on page 156. remove. you can assign custom properties to a document during its initial upload to a category. TIBCO XML Canon User’s Guide . Architecture. For example. These listed properties are divided into two sections based on their type: Enumerations and Memos.256 | Chapter 16 Configuring Custom Properties Custom Properties Overview Custom properties are user-defined metadata which can be applied to documents and components in TIBCO XML Canon. Configuring Custom Properties An administrator can define new custom properties and manage existing custom properties in the Custom Properties panel.

• • • • To learn more about adding a new enumeration. Click a property name to open its property details page in the Custom Properties panel. see Adding New Memo Properties on page 262. However. an inactive custom property can be reactivated again. If you deactivate a custom property. TIBCO XML Canon User’s Guide . If a custom property is inactive. it will remain in all documents and components which have this property until their next upload or update. it is no longer available to TIBCO XML Canon users. To learn more about adding a new memo. see Managing Existing Memo Properties on page 263. see Configuring New Enumeration Properties on page 258. it is added to the appropriate documents and components and its value can be edited by permitted users. To learn more about configuring and managing enumerations.Custom Properties Overview 257 | Figure 144 The Custom Properties Browser If a custom property is active. To learn more about configuring and managing memos. see Managing Existing Enumeration Properties on page 260.

Click Configure > Custom Properties from the menu bar to open the Custom Properties panel. even if you selected the Components option from the Applies To drop-down list. If you select the Yes radio button in the Required option set. TIBCO XML Canon User’s Guide . Enter the property name in the Name field. Click the Add New Enumeration button from the Enumerations area in the custom properties panel to open the Add New Enumeration Property page (see Figure 145). 2. You cannot change the name of a custom property after it is configured. Figure 145 The Add New Enumeration Property Page 3. 4. Select the No radio button if this custom property does not have to be specified during document uploads.258 | Chapter 16 Configuring Custom Properties Configuring New Enumeration Properties Follow the instructions below to add a new enumeration property to TIBCO XML Canon: 1. this custom property will be required for documents only. Select the Yes radio button from the Required option set if this custom property must be specified during document uploads.

click the Reset button to restore all settings to default. Enter the enumeration entries in the Choices field and press the ENTER key after each entry to separate them. Other characters such as spaces or tabs will not separate the entry. Choose whether this property will be assigned to documents or components. Therefore.Configuring New Enumeration Properties 259 | WebDAV clients other than TIBCO Turbo XML and TIBCO Designer do not recognize the metadata extensions of TIBCO XML Canon. or both of them from the Applies To drop-down list. do not select the Yes radio button for these WebDAV clients because it will prevent documents from uploading. Click the Add Property button to add this property. Each line in the Choices field represents an enumeration entry. 7. Otherwise. TIBCO XML Canon User’s Guide . 6. 5.

Follow the instructions below to manage an existing enumeration property: 1. TIBCO XML Canon User’s Guide . Select the No radio button from the Active option set to deactivate the property. If you deactivate a custom property. 4. It is impossible to change the name of a custom property after it has been configured. After you have configured a new enumeration property. it will remain in all documents and components which have this property until their next upload or update. you can select a name from the active custom properties list in the left-hand frame. Select the Yes radio button from the Required option set if this custom property must be specified during document uploads. 2. Select an enumeration name to open its property details page. Figure 146 The Enumeration Property Details Page 3.260 | Chapter 16 Configuring Custom Properties Managing Existing Enumeration Properties Enumeration properties are managed in the property details page. Click Configure > Custom Properties from the menu bar to open the Custom Properties panel.

click the Reset button to restore all settings to default. Otherwise. Enter additional enumeration entries in the New Choices field and press the ENTER key on the keyboard after each entry to separate them. If you select the Yes radio button in the Required option set. Activate or deactivate existing enumeration entries by selecting the related radio buttons in the Enumeration Choices area. 7. this custom property will be required for documents only. Select the No radio button if this custom property does not have to be specified during document uploads.Managing Existing Enumeration Properties 261 | 5. 9. Click the Update button to update this property. Therefore. WebDAV clients other than TIBCO Designer do not recognize the metadata extensions of TIBCO XML Canon. TIBCO XML Canon User’s Guide . even you selected the Components option from the Applies To drop-down list. or both from the Applies To drop-down list. Select whether this property will be assigned to documents or components. 6. 8. do not select the Yes radio button for these WebDAV clients as it will prevent documents from uploading. Each line in the Choices field represents an enumeration entry. Other characters such as spaces or tabs will not separate the entry.

Select whether this property will be assigned to documents or components. Click the Add Property button to add this property. Enter a name for this memo property in the Name field. Otherwise. 2. this custom property will be required for documents only. Click Configure > Custom Properties from the menu bar to open the Custom Properties panel. This name cannot include the following characters: ' " ? * > < ] | = ) & ! You cannot change the name of a custom property after it has been configured. 4. do not select the Yes radio button for these WebDAV clients because it will prevent documents from uploading. Click the Add New Memo button from the Memos area in the custom properties panel to open the Add New Memo Property page: 3.262 | Chapter 16 Configuring Custom Properties Adding New Memo Properties Follow the instructions below to add a new memo property to TIBCO XML Canon: 1. click the Reset button to restore all settings to default. 7. WebDAV clients other than TIBCO Designer do not recognize the metadata extensions of TIBCO XML Canon. even you selected the Components option from the Applies To drop-down list. Select the No radio button if this custom property does not have to be specified during document uploads. 6. or both from the Applies To drop-down list. 5. If you select the Yes radio button in the Required option set. TIBCO XML Canon User’s Guide . Therefore. Select the Yes radio button from the Required option set if this custom property must be specified during document uploads.

Select the No radio button if this custom property does not have to be specified during document uploads. 4. After a new memo property has been configured. this custom property will be required for documents only. even you selected the Components option from the Applies To drop-down list. 5.Managing Existing Memo Properties 263 | Managing Existing Memo Properties Memo properties are managed in the property details page. do not select the Yes radio button for these WebDAV clients because it will prevent documents from uploading. WebDAV clients other than TIBCO Designer do not recognize the metadata extensions of TIBCO XML Canon. Select the Yes radio button from the Required option set if this custom property must be specified during document uploads. It is impossible to change the name of a custom property after it has been configured. TIBCO XML Canon User’s Guide . Click Configure > Custom Properties from the menu bar to open the Custom Properties panel. Select the No radio button from the Active option set to deactivate the property. Follow the instructions below to manage an existing memo property: 1. 2. Figure 147 The Memo Property Details Page 3. Select a memo name to open its property details page (see Figure 147). it will remain in all documents and components which have this property until their next upload or update. If you select the Yes radio button in the Required option set. Therefore. select a name from the active memo properties list in the left-hand frame. If you deactivate a custom property.

264 | Chapter 16 Configuring Custom Properties 6. click the Reset button to restore all settings to default. TIBCO XML Canon User’s Guide . Select whether this property will be assigned to documents or components. or both from the Applies To drop-down list. 7. Otherwise. Click the Update button to update this property.

Topics • Configuring the Java Virtual Machine on page 266 TIBCO XML Canon User’s Guide .| 265 Appendix A Java Virtual Machine Options This appendix describes how to modify the Tomcat setenv script to set options in the Java Virtual Machine.

Specify JVM Options These steps describe how to specify JVM options by modifying the setenv script. As a consequence of this structure. you must shutdown and restart TIBCO XML Canon.html You can specify values for any of the documented options in the setenv script. See Starting the TIBCO XML Canon Server on page 8 for the shutdown and restart procedure. certain JVM settings can affect XML Canon performance. For example. 4.bat file in an editor. 2.266 | Appendix A Java Virtual Machine Options Configuring the Java Virtual Machine TIBCO XML Canon relies on the Tomcat server. 1. Add a line or lines specifying the new option setting using the syntax: set JAVA_OPTS=%JAVA_OPTS% value where value is the option setting. you can use the Tomcat setenv script to modify the JVM options. The TIBCO XML Canon installation process uses the default Java settings. the maximum memory allocation for XML Canon is determined by the JVM.6.com/javase/6/docs/technotes/tools/windows/java. this line specifies a 2048 MB (or 2 GB) memory allocation in the JVM: set JAVA_OPTS=%JAVA_OPTS% -Xms2048M TIBCO XML Canon User’s Guide . For example. see the Java application launcher documentation. If you find that the default settings do not meet your needs. Windows On Windows platforms. JVM Options For a full list configurable options. Stop the TIBCO XML Canon service. Open the setenv. which are adequate for most users. this documentation is available here: http://java. Navigate to: XMLCANON_HOME\tomcat\bin 3. which is contained in a Java Virtual Machine (JVM).sun. For Java 1. After making any changes to the setenv script. use this procedure to modify the setenv script.

The option settings defined in this line are required. 5.0 set JAVA_OPTS=%JAVA_OPTS% -Xms2048M TIBCO XML Canon User’s Guide . Save and close the setenv. 2. The option settings defined in this line are required. 1. Unix On Unix platforms. Stop TIBCO XML Canon. Open the setenv.6. For example. 6. use this procedure to modify the setenv script. Example Windows This example shows a setenv. this line specifies a 2048 MB (or 2 GB) memory allocation in the JVM: JAVA_OPTS="$JAVA_OPTS -Xms2048M". 4. Navigate to: XMLCANON_HOME/tomcat/bin 3. and must not be modified.export JAVA_OPTS Do not change the initial line of the setenv script. 5. Add a line or lines specifying the new option setting using the syntax: JAVA_OPTS="$JAVA_OPTS value". Restart the TIBCO XML Canon service.bat file that has been modified to increase the memory allocation to 2 GB (on Windows platforms): set JRE_HOME=C:\tibco\tibcojre\1.bat file. and must not be modified. Restart TIBCO XML Canon.Configuring the Java Virtual Machine 267 | Do not change the initial line of the setenv script.sh file in an editor.sh file.export JAVA_OPTS where value is the option setting. Save and close the setenv. 6.

268 | Appendix A Java Virtual Machine Options Unix This example also shows a setenv.bat file that has been modified to increase the memory allocation to 2 GB.0 export JRE_HOME JAVA_OPTS="$JAVA_OPTS -Xms2048M" export JAVA_OPTS TIBCO XML Canon User’s Guide .6. in this case on Unix platforms: JRE_HOME=/opt/tibco/tibcojre/1.

| 269 Index Symbols # portal users 217 B browse by tags 140 categories 48 components 119 DOCTYPE 59 menu 35 building XSLT stylesheets 190 BusinessWorks 5 synchronizing projects TIBCO BusinessWorks synchronizing projects 164 A account tab 44 ActiveMatrix 5 add new portal user 223 new role 202 new stage 233 new user 221 administer categories 173 namespaces 185 administering categories and documents 171 ADMINISTRATOR 196 administrators and purging 177 capability 196 permissions 184 role 199 Altova XMLSpy 166 analyzing documents for components 182 assigning tags 134 authentication controlling access 181 tags 141 authentication tab policies 244 authorization TIBCO Authorization default role 201 available reports 62 C capability ADMINISTRATOR 196 CONNECT 196 categories administering 173 assigning tags 139 browse by tags 140 browsing 48 clone 176 create child 51 delete 53 move 54 overview 46 permissions 174. 197 purge 177 rename 52 tutorial 17 category details page 49 category and stage permissions 197 changes from the previous release of TIBCO XML TIBCO XML Canon User’s Guide .

270 | Index Canon User’s Guide xx characteristics of tags 131 child create category 51 clone category 176 comparing documents 104 component report 63 components 115 analyzing documents 182 browse 119 BusinessWorks and WSDL 118 counts per page 42 details page 120 document relationships 121 in document versions 124 metadata 120 properties 128 relationships 122 search 125 types 116 viewing view components 124 configure menu 37 permissions 207 report parameters 67 stages 232. 104 display documents modified within 42 maximum documents 42 report parameters 67 DOCTYPE managing 193 namespaces 59 document report 63 . 236 CONNECT 196 copy category 176 create new category 51 new report 64 new stage 233 portal user 223 role 202 upload document 89 user 221 current tags link 133 custom properties 255 components 128 enumeration 258 memo 262 customer support xxv TIBCO XML Canon User’s Guide D database consistency 252 databases transaction logs 13 default administrator permissions 184 LDAP role 200 portal role 200 reports 63 role permissions 184 roles 199 stage 231 TIBCO Authorization role 201 user permissions 184 delete category 53 documents 93 purge 177 roles 206 stages 237 tags 145 Designer 5 detailed view 99 details category 49 category administrator 173 components 120 documents 77 differencing engine 104.

Index 271 | documents 75 analyzing 182 assigning tags 134 default WebDAV stage 42 delete 93 details page 77 differencing engine 104. 104 download 91 history tab 82 lock 94 metadata 81 move 92 personal display options 41 properties tab 79 purge 177 relations tab 84 relationship of components 121 search 108 stages 97 subscription 106 unlock 95 update properties 96 update tab 85 uploading 89 validate 101 versions 87 via URL 111 view 98 well-formed 235 download document 91 G general tab policies 241 H help menu 37 history tab documents 82 home page user 39 I install tab policies 250 instances tab namespaces 57 J Java Virtual Machine 265 JVM 265 E enumeration custom properties 258 L LDAP authentication 244 default role 200 queries 210 users 218 LDAP users and roles 209 lock document 94 TIBCO XML Canon User’s Guide F files log files 12 .

272 | Index locks and timeout 148 logging 12 TIBCO XML Canon messages 12 login tutorial 17 N namespaces administering 185 browsing 56 DOCTYPE 59 instances tab 57 overview 46 presentation parameters 190 presentation tab 186 presentations 189 schema tab 57 search 57 uses tab 57 navigating reports 66 new role 202 nomenclature of tags 131 normal users 217 notifications 106 stages 42 viewing 107 M managing existing users 225 managing public IDs 193 members changing role membership 207 memo custom properties 262 menu browse 35 configure 37 help 37 search 36 menu bar 35 metadata components 120 document fields 81 WebDAV 149 move category 54 document 92 O options JVM 265 P paging component count 42 parameters namespace presentation 190 password update 44 TIBCO XML Canon User’s Guide .

Index 273 | permissions 183 category 174 category and stage 197 configure 207 default administrator 184 roles 196 tags 198 user 184 personal options tab 41 policies 239 authentication tab 244 general tab 241 install tab 250 server status tab 251 portal role 200 portal users 217 create new 223 presentation tab namespaces 186 presentations namespace 189 parameters 190 properties components 128 custom 255 update document 96 WebDAV 149 XML Canon 150 properties tab documents 79 public IDs browse and edit 59 managing 193 purge 177 purging and administrators 177 R reassigning tags 138 relations tab documents 84 relationships components 122 documents 121 remove category 53 documents 93 roles 206 stages 237 tags 145 rename category 52 RENESIS player 100 reports available 62 create new 64 default 63 delete 62 display parameters 67 information on 61 overview 61 queued 62 report display 66 reports tab 43 running 70 scheduling 70 searching documents 64 web report tab 41 XSLT documents 72 revisions view document 87 role members 207 Q queries LDAP 210 queued reports 62 quick view 98 TIBCO XML Canon User’s Guide .

contacting xxv synchronizing BusinessWorks projects 164 S scheduling reports 70 schema tab namespaces 57 SchemaDOC view 99 search components 125 criteria 109 documents 108 documents for a report 64 menu 36 namespaces 57 security log files 12 server XML Canon 8 server status tab policies 251 service Windows service 8 setenv script 265 T tags 130 assigning 134 authentication 141 browse 140 category details 132 characteristics 131 document URL 142 make current 136 nomenclature 131 permissions 198 reassigning 138 removing 145 technical support xxv TIBCO ActiveMatrix BusinessWorks 5 TIBCO Administrator authentication 248 default role 201 managing roles 212 users 219 TIBCO XML Canon User’s Guide . 195 activating and deactivating 206 add new 202 administrator role 199 and users 198 capability 196 default LDAP role 200 delete 206 LDAP users 209 managing 205 permissions 196 portal role 200 TIBCO Administrator 212 TIBCO Authorization role 201 tutorial 25 web role 199 running reports 70 stages 229 configuring 236 create new 233 deactivating and deleting 237 default 231 default for WebDAV 42 notifications 42 permissions 197 subscription 106 transitions 230 tutorial 22 WebDAV default 155 startup XML Canon server 8 stylesheets XSLT 190 subscriptions notification 106 support.274 | Index roles 25.

25 category creation 17 login 17 stages 22 user creation 20 WebDAV 29 users 215 and roles 198 capability 196 create new 221 create portal user 223 LDAP 218 managing 225 normal 217 permissions 184 portal 217 TIBCO Administrator 219 tutorial 20 web 219 uses tab namespaces 57 U unauthenticated access control 181 unauthenticated users 219 unlock document 95 update document properties 96 update tab documents 85 upload default WebDAV stage 42 document 89 URL accessing documents 111 unauthenticated access 112.Index 275 | TIBCO Designer 5 as a WebDAV client 161 TIBCO XML Canon log messages 12 TIBCO_HOME xxii tomcat log files 12 transaction logs managing 13 tutorial 16. 181 viewing documents with tags 142 XML Canon 10 V validate documents 101 version control and WebDAV 148 versions view document version 87 viewing components 124 view documents 98 W web interface 34 login 10 menu bar 35 Web Reports 41 web reports 41 web users 219 TIBCO XML Canon User’s Guide .

276 | Index WebDAV 147 DAV tab 40 default stage 42 default upload stage 155 metadata 149 support in XML Canon 148 tutorial 29 uploads 156 version control 148 WebDAV clients 151 TIBCO Designer 161 Windows Web Folder 157 XMLSpy 166 WebDAV properties 149 well-formed 235 Windows service 8 Windows Web Folder 157 X XML Canon authentication 244 features overview 3 home page 39 server startup 8 URL 10 web interface 10 XML Canon properties 150 XML view 99 xmlLog.xml 12 XMLSpy 166 XSLT documents using with reports 72 XSLT stylesheets building 190 TIBCO XML Canon User’s Guide .

Sign up to vote on this title
UsefulNot useful