Tib XML Canon User

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Create a New User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Define Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Create a Role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Upload Documents Using WebDAV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Checking Your Work . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 4 TIBCO XML Canon Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

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

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

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

vi
| Contents
TIBCO ActiveMatrix BusinessWorks and WSDL Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Component Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Component Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Component Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Document Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Component Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Tag Nomenclature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Tag Characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Tags in the Category Detail View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
Assigning Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Assigning Tags to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Making a Previous Document Tag Current . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Reassigning Tags to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
Assigning Tags to Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 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

Contents vii
|
Configuring a Windows Web Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157
Managing Categories and Documents in the Web Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158
Editing Document Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160
Using TIBCO Designer as a WebDAV Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Opening New Projects in Designer. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
Opening Existing Projects in Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Checking-out Project Resources for Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
Checking-in Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
Synchronizing a TIBCO ActiveMatrix BusinessWorks Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Additional Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165
Using XMLSpy as a WebDAV Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Opening Documents from TIBCO XML Canon. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166
Editing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
Saving New Documents to TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
Adding Metadata to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170
Chapter 10 Administering Categories and Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172
Managing Categories. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
ADMINISTRATOR Category Details panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
Configuring Category Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
Cloning Categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Purging Deleted Categories and Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
When / Why Perform the Purge Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Purging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177
Controlling Non-Authenticated URL Access to Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181
Analyzing Documents for Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Understanding Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
Default Role Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Default User Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Default Administrator Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Chapter 11 Administering Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185

Namespace Administration Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Namespace Presentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
DTD Doctype Public IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187
Adding Namespace Presentations. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189
Notes on Building XSLT Stylesheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190
Managing DTD DOCTYPE Public IDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

viii
| Contents
Chapter 12 Configuring Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Roles Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Role Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196
Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198
Default Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Web . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Administrators . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199
Portal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
LDAP Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
TIBCO Authorization Default . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201
Adding New Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202
Managing Existing Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Activating and Deactivating Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Deleting Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206
Changing Default Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Changing Role Members . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207
Changing Category- and Stage-specific Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208
Assigning LDAP Users to Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Role Details Page in LDAP Authentication Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209
Configuring LDAP Queries. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210
Testing LDAP Queries for Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
Managing TIBCO Administrator Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 212
Importing TIBCO Administrator Roles Manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213
Chapter 13 Configuring Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Users Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216
Normal Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Portal Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
LDAP Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218
TIBCO Administrator Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Web (Un-authenticated) User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
Creating a New User. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
Creating Portal Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Managing Existing Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
Chapter 14 Configuring Stages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Stages Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Stage Transitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230
Default Stage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231
Stages Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232
Creating Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Contents ix
|
Configuring Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 236
Notes on Deleting and Deactivating Stages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237
Chapter 15 Configuring Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239

Policies Page Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240
General Policies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
Authentication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
Internal TIBCO XML Canon Authentication Only . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
LDAP Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244
TIBCO Administrator Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248
Install Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250
Server Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251
Checking Database Consistency . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Chapter 16 Configuring Custom Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255

Custom Properties Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256
Configuring New Enumeration Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258
Managing Existing Enumeration Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260
Adding New Memo Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
Managing Existing Memo Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 263
Appendix A Java Virtual Machine Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .265

Configuring the Java Virtual Machine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
JVM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Specify JVM Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .269

x
| Contents

Figures xi
|
Figures
Figure 1 XML Canon Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

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

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

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

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

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

xvi
| Figures

Tables xvii
|
Tables
Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii

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

xviii Tables
|

| 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. While you can store any type of document in XML Canon, it
primarily serves as a central repository for developing and testing XML Schemas.
Additionally, its integration with TIBCO Designer makes TIBCO XML Canon an
ideal source control repository for TIBCO ActiveMatrix BusinessWorks projects.
Topics
• Changes from the Previous Release of this Guide, page xx

• Related Documentation, page xxi
• Typographical Conventions, page xxii
• How to Contact TIBCO Support, page xxv

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

Related Documentation xxi
|
Related Documentation
This section lists documentation resources you may find useful.
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.
• 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.
• TIBCO XML Canon Release Notes Read the release notes for a list of new and
changed features. This document also contains lists of known issues and
closed issues for this release.
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, XML, and XML
schemas. For further information about these formats, see:
http://www.w3.org
http://www.w3.org/TR/XSLT.html
http://www.w3.org/TR/REC-xml/
http://www.w3.org/TR/xmlschema-0/
http://www.w3.org/TR/wsdl/

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

Typographical Conventions xxiii
|
Table 1 General Typographical Conventions (Cont’d)
Convention Use
italic font Italic font is used in the following ways:
• To indicate a document title. For example: See TIBCO ActiveMatrix
BusinessWorks Concepts.
• To introduce new terms For example: A portal page may contain several
portlets. Portlets are mini-applications that run in a portal.
• To indicate a variable in a command or code syntax that you must
replace. For example: MyCommand PathName
Key combinations Key name separated by a plus sign indicate keys pressed simultaneously. For
example: Ctrl+C.
Key names separated by a comma and space indicate keys pressed one after
the other. For example: Esc, Ctrl+Q.
The note icon indicates information that is of special interest or importance,

for example, an additional action required only in certain circumstances.
The tip icon indicates an idea that could be useful, for example, a way to
apply the information provided in the current section to achieve a specific
result.
The warning icon indicates the potential for a damaging situation, for
example, data loss or corruption if certain steps are taken or not taken.
Table 2 Syntax Typographical Conventions
Convention Use
[ ] An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
| A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3

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

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

xxvi Preface
|

|1
Chapter 1 Introduction
This chapter includes an overview of TIBCO XML Canon.
Topics
• TIBCO XML Canon Overview, page 2

• Features, page 3

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

Features 3
|
Features
TIBCO XML Canon features enable you to:

• Manage XML schema documents and their components.
• Collaborate in a distributed development environment.
• Administer XML documents used at the enterprise level.
• Integrate with other interfaces available in the TIBCO product family, such as
TIBCO Designer.
These features are discussed in sections below.
Manage XML Schema Documents and Their Components

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

4
BusinessWorks project. 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.
• Reporting generates customized reports using filtering criteria and
configuration capabilities. These reports can be permission-controlled or
made public to all users.
• Document and Component Relationship Tracking allows you to track and view
the relationships between documents and their components. TIBCO XML
Canon also tracks, with more detail, the relationships between components
within a schema as well as their relationships to other documents.
• Data Dictionary and Type Management provides tools to manage, index,
search, and reuse schema components that are part of corporate vocabularies
and industry standards.
Distributed Collaboration
• Collaborative Repository provides XML-centric source management, along
with control of XML documents that includes check-in, check-out, and
versioning.
• 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, Unix, and Linux platforms.
• Categories offer a hierarchical perspective that visually represents and
analyzes the structure and status of documents within the repository.
Administrators can rename, remove, and add categories as desired.
• Automated Notification allows you to subscribe to relevant documents, such as
XSD schemas, 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.
• Permissions enable administrators to define and regulate the life cycle
requirements for documents internally and externally. That is, administrators
can set permissions to control access from both development and production
perspectives.A user may have a right, or a combination of rights, to read,
write, and delete documents based on the permissions set by the
administrator. In XML Canon, permissions are set based on the life-cycle stage
or on the category level, and access permissions are granted based on the
stage and/or role.
• Web-based User Interface allows anytime and anywhere access to TIBCO
XML Canon, across your network. You can also customize the web interface

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.

6

|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

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 • To start TIBCO XML Canon from a command prompt, type the following
Prompt 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.

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.

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

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

12
Managing Log Files
TIBCO XML Canon log messages are printed to one of several log files,
depending on the message type.
Apache Tomcat Messages

Apache Tomcat prints status messages to its catalina logger. Log files take the
format of catalina.date.log. Catalina log files are located in:
XMLCANON_HOME\tomcat\logs\catalina.date.log
The content and settings of the catalina log files are configured in the
XMLCANON_HOME\tomcat\conf\logging.properties file. For more
information, see http://tomcat.apache.org/tomcat-6.0-doc/logging.html.
Security Messages
The canon_security_info.log file contains messages related to security in
TIBCO XML Canon, such as encryption, obfuscation, and SSL:
XMLCANON_HOME\tomcat\logs\canon_security_info.log
The content and settings of the canon_security_info.log are configured in the
XMLCANON_HOME\tomcat\lib\log4j.properties file. For more information,
see http://wiki.apache.org/logging-log4j/Log4jXmlFormat.
TIBCO XML Canon Messages

The webLog.xml file is the primary log file for the XML Canon server, and
contains all messages related to the XML Canon server:
XMLCANON_HOME\tomcat\work\Standalone\localhost\_\log\xmlLog.xml
The content of the webLog.xml file is determined by the configuration settings in
XMLCANON_HOME\tomcat\webapps\ROOT\WEB-INF\web.xml.
By default, logging to webLog.xml is not enabled. For help configuring this file,
contact TIBCO Support.

Managing Log Files 13
|
Manage Database Transaction Logs

Databases often keep transaction logs. They need to be managed appropriately,
otherwise, they may become unmanageable in a short period of time. You need to
perform one of the following tasks to manage the transaction log:
• Intermittently run an SQL script to prune the transaction logs.
• Back-up and checkpoint the transaction log.
• Set the transaction log recovery model to SIMPLE.

14

| 15
Chapter 3 Quick Tour of TIBCO XML Canon
This chapter provides a tutorial on using and administering TIBCO XML Canon.
Topics
• Quick Tour, page 16

• Checking Your Work, page 32

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. This walk-through teaches you
how to carry out basic tasks as an XML Canon administrative user. 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. It goes through each
task on the list above with a simple example program scenario.
This exercise is designed for users who belong to the TIBCO XML Canon
administrators role. Before you begin, you must have a valid administrator
username and password. If you are logging in to the TIBCO XML Canon server
for the first time, then you must use the administrative credentials that you
created during software installation.
Administering a Simple Program — Overview

This exercise is intended for TIBCO XML Canon administrators.
In this example program, you will configure XML Canon through the creation of
users, roles, categories, and stages. You will assign roles and permissions in order
to control access to documents and administrative tasks. This setup process is
divided into the following tasks:
• Log in to TIBCO XML Canon, page 17
• Create a Category, page 17
• Create a New User, page 20
• Define Stages, page 22
• Create a Role, page 25
• Upload Documents Using WebDAV, page 29
You must complete the tasks in the order presented here.

Quick Tour 17
|
Log in to TIBCO XML Canon

Log in to the XML Canon web interface:
1. 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, and Port is the port
used to access the server, specified during installation (by default, the port is
8080). For example:
— When accessing XML Canon from the same subnet as the NetBIOS domain,
the HostName is the name of the computer where XML Canon is installed.
— When accessing XML Canon outside the subnet of NetBIOS, the HostName
is an IP address or fully qualified host name. For example,
xmlcanon.example.com.
The XML Canon Login page appears.

2. To connect to TIBCO XML Canon for the first time, enter the administrator
username and password you established during the installation.
Note that the username and password are case-sensitive
Click the Submit button. Upon successful login, the Home Page opens. A
menu of options appears at the top.
Create a Category
Categories are the primary organizational unit within the TIBCO XML Canon
server. They are analogous to directories in a file system. When uploading a
document into TIBCO XML Canon, you must select the category in which it will
be stored.
In this example program, you will create two categories.
1. Hover the mouse pointer over the Browse button in the menu bar. Three
options appear below Browse. Click the Categories option (see Figure 2).

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

Quick Tour 19
|
Figure 5 The Industry Standards Category
4. Click the Categories folder again to add another category called Company
Standards following the process described above in step 3.
You have completed the first task of the tour. 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, which opens the Category Details panel. From there, 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, see Chapter 5, Categories, Namespaces, and
Reports.

20
Create a New User

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

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

22
Define Stages
A document (such as an XSD file) can go through numerous revisions during its
life cycle. TIBCO XML Canon server provides a Stage function to facilitate the
workflow and manage the life cycle of stored assets. A stage represents the status
of a document at a given point during its life cycle. 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 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.
For your pilot program, you will create two stages in TIBCO XML Canon:
Development and Production.
click the Stages button from the sub-menu (see Figure 10).
Figure 10 TIBCO XML Canon Menu Bar - 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). 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 11 The Active and Inactive Stage’s List
2. 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).

Quick Tour 23
|
Figure 12 Stage Details Page
3. In the Stage name field, change the name Default to Development.

4. Select the Yes radio button next to the Active option to ensure this stage could
be employed.
5. Ignore the Namespace Resolution option for now.
6. In the Conformance Rules area, select the radio button for Documents do not
need to be well-formed.
The Conformance Rules area specifies the criteria that XML documents must
meet before entering into this stage. The Documents do not need to be
well-formed option is checked by default. This means that XML documents
are not required to be well-formed or valid in order to move to the stage.
7. In the Documents May Transition To area, leave the Default checkbox as
checked.
After the stage is updated, Default listed in this section will be renamed
Development. This check ensures that documents edited while in the Default
stage can be placed back into the Development stage.
8. Click the Update button at the bottom of the panel to save the new stage
configuration.
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.

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

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.
This configuration is done automatically.
The Development stage transition settings should look like:
Figure 15 Stage Transitions Example Settings
For more information on stage configuration, see Chapter 14, Configuring Stages,
on page 229.
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, Create a Role.
Create a Role
Roles play a crucial part in TIBCO XML Canon. They are analogous to groups in
network administrative domains and LDAP. A role determines the member’s
ability to access resources and perform functions within the server.
click the Roles button from the sub-menu, as shown below.
Figure 16 The Menu Bar - the Configure Button
The current roles list appears in the left-hand frame. The Active list of roles
contains pre-defined roles only. These roles are created by the installer during
setup and include Administrators, LDAP Default, Portal, TIBCO
Authorization Default, and Web roles, as shown in the figure below.

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

Quick Tour 27
|
3. Enter information about the new role:

— Enter Pilot in the Name field as the name of this role.
— In the Initial Stage drop-down list, select Development.
— In the Capability drop-down list, select CONNECT.
This option prevents users in this role from carrying out administrative
tasks such as configuring roles, users, stages, policies, and custom
properties.
— Set the Default stage permission to Read, write.
— Set the Default category permission to Read, write.
— Set the Tagging permission to Assign.
Because this role may include people from outside companies, you do not
want to grant this role the permission to delete documents in any
categories.
Note that in order to read, write, or delete a document, the role must be
granted with appropriate permissions on both the document's stage and
the category it belongs to.
— Leave the Stage-specific permissions as Default.

The Stage Specific Permissions section is used to change the role
permissions for a particular stage from the default settings. If you have a
stage for which you want to apply either more or less restrictive
permissions, you would set those permissions in this section.
4. 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.
5. Select the user created in Create a New User, from the list of available users.
Figure 19 Role Membership

28
6. Click Update.
Based on the current configuration (specifically, the default category
permissions), the Pilot role has limited ability to view or work with documents
stored in the Development stage in XML Canon. However, you can modify the
default permissions on a category basis using the Category Details page.
The next step is to give the Pilot role full access to documents in the Industry
Standards category.
7. Hover the mouse pointer over the Browse button in the menu bar. You will
see three pop out options. Click the Categories button.
8. Click the Industry Standards category in the Category tree to open the
Category Details panel in the right-hand frame.
9. In the Pilot role permissions drop-down list, select Read, write, delete, as
shown in Figure 20.
Figure 20 The Rule Permissions Area
10. Click the Update permissions button to update this set of new permissions.
The default category permission settings (read and write, 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.
For more information on configuring roles and administering access to
documents, see Chapter 12, Configuring Roles, on page 195. Also see Chapter 10,
Administering Categories and Documents, on page 171.
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, Upload Documents Using WebDAV.

Quick Tour 29
|
Upload Documents Using WebDAV

TIBCO XML Canon uses WebDAV for communication with all clients. It is very
easy to populate a TIBCO XML Canon server with existing documents.
WebDAV stands for Web-based Distributed Authoring and Versioning.

WebDAV is a set of extensions to the HTTP protocol which allows users to
collaboratively edit and manage files on remote web servers.
There are several resources describing WebDAV. One of the best resources is a
FAQ at the WebDAV.org site:
http://webdav.org/other/faq.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, including Microsoft network
connection tools, which we will use in this exercise to create a connection.
However, 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.
To create a connection using Microsoft network connection tools:
1. To configure a Windows Web Folder in Windows as a WebDAV client:
a. Select My Network Places in the Windows Start menu.
b. Click Add a network place under Network Tasks in the left pane of the
window to launch the Add Network Place Wizard.
c. Click the Next button.
d. Type the TIBCO XML Canon server URL. For example:
e. Click the Next button.

f. Enter your TIBCO XML Canon administrative user’s credentials and click
the Ok button.
g. Specify a name for this WebDAV connection and click the Next button.
h. Click the Finish button.

30
Microsoft Windows has now set up a WebDAV connection to the TIBCO XML
Canon server. You will now see a new window showing all categories under the
root category of the TIBCO XML Canon server (see Figure 21). Note that there is
also a tag directory which allows you to browse through all resources with
assigned tags in XML Canon. For more information on the tag directory, see
Browsing By Tags on page 140.
Figure 21 WebDAV Connection Browser
2. Open another Windows Explorer window in your local file system.

3. Right-click on a local directory and select Copy from the pop-up menu.
4. Right-click on the Industry Standards directory in the WebDAV folder and
select Paste from the pop-up menu.
5. In the TIBCO XML Canon web interface, click the Home button in the menu
bar to open your TIBCO XML Canon home page.
6. 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.
7. 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. Scroll down to the bottom of the page and click the Check All button.
9. Use the Attribute area to add metadata to documents uploaded to the server
through WebDAV. You can include Comments and the Revision Label in these
fields for now. For example, Documents uploaded with webDAV. In the
Revision label field, enter 1.0, as shown in the example below.

Quick Tour 31
|
Figure 22 The DAV Tab
10. Click the Update Attributes button.

11. Return to the Recent tab. You can now see the files uploaded with WebDAV
include both a revision label and the comment you specified.
For more information about managing documents and WebDAV clients, see
Chapter 6, Using Documents, on page 75 and Chapter 9, Working with WebDAV
Clients, on page 147.
You have now completed the task of uploading documents with a WebDAV
client.

32
Checking Your Work
Congratulations! You have completed this tutorial.

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. If
you configured the Pilot role correctly, 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.
Under the Pilot account, you can upload documents from your local file system to
both Industry Standards and Company Standards categories and delete them
again. 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. This can only be done if the document can be validated by the
TIBCO XML Canon. To learn more about how to move documents between
stages, see Managing Documents with Stages on page 97.

| 33
Chapter 4 TIBCO XML Canon Web Interface
This chapter describes the TIBCO XML Canon user interface.
Topics
• Web Interface Overview, page 34

• Menu Bar, page 35
• TIBCO XML Canon Home Page, page 39

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

Menu Bar 35
|
Menu Bar
The menu bar always displays at the top of the web interface in TIBCO XML
Canon. 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.
If your role is assigned with a CONNECT capability, which means you have no
privilege to create a new user account and grant permissions to users, your menu
bar will look like Figure 24. If your role is assigned with an ADMINISTRATOR
capability, you will also see a button called Configure on the menu bar (see
Figure 27 on page 37).
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 browse the submenu by hovering your
mouse over a button under the main menu. For example, if you hover your
mouse over the Browse button, you will see three options appear below this
button.
Browse
There are three options under the Browse button: Categories, Namespaces, and
Reports. You can hover your mouse over the Browse button and click on one of
the three options to access its functions (see Figure 25).
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.
It uses a hierarchical structure to visually display categories and
subcategories. You can grant different permissions for categories and

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

Menu Bar 37
|
Configure (For ADMINISTRATOR Only)

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

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

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 also access the home page by clicking
the Home button in the menu bar at any time.
The TIBCO XML Canon home page provides a summary of recent activities and
customizations under six different tabs.
Recent
If you logged in as a Portal user, you will not have access to the Recent tab. 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. It also provides easy access to works in
progress. If you are in the middle of a project, you can conveniently locate your
project files under this tab when logging in to TIBCO XML Canon.
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.
Figure 29 The Recent Tab in the TIBCO XML Canon Home Page

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

|
Web Report
The Web Report tab (see Figure 31) allows you to monitor data changes in
documents that have been recently modified. TIBCO XML Canon will notify you
when a document of interest has been updated. In order to get these notifications,
you must subscribe to the document notification. For more information on
notification subscription, see Notification Subscription on page 106.
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. You can view the document history,
review the differences between various document revisions, validate the
document, and download the most up-to-date version.
You can also delete a notification under the Web Report tab. 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, User
configurable options include:

42
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. Once the document has reached the
specified number of days, it will be removed from the list.
• Display a maximum of documents modified
Specifies the maximum number of documents to be displayed under the
Recent tab at the same time. For example, if you set the maximum value as 20,
then it will display up to 20 documents in the recent document list.
• 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.
• Default stage for WebDAV upload
Specifies the initial stage when documents are uploaded to TIBCO XML
Canon via WebDAV clients. Since Stage is an attribute of TIBCO XML Canon,
it can only be set on the server side.
• Stage Notifications
Gives you the option to be notified when a document enters a particular stage.
For instance, a Quality Assurance Engineer might be interested in any
document that enters into the Test stage. You can be notified through email,
the web, or both. For more information on web notifications, see Web Report
on page 41.
Only the WebDAV plug-in of TIBCO Turbo XML recognizes the Stage attribute
when it saves to TIBCO XML Canon.

|
Reports
Use the Reports tab to monitor available reports and to configure new reports
including reports in the queue and generated reports. Generated reports are ready
for you to review. (See Figure 33)
• The content of the Reports tab is user-specific.
• 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. This means that, for non-administrator users, the Report tab only
displays reports that are public or created by the user.
Figure 33 The Reports Tab in the TIBCO XML Canon Home Page
• Some reports can be resource-intensive to run. Therefore, TIBCO XML Canon

runs only one report at a time to ensure that running reports does not degrade
overall system performance. Therefore, all reports are entered into a queue
before execution.
• There are two areas under the Reports tab:
— Available Reports shows all executed reports and the results of these
reports.
— Configure Reports and the Select and Setup Report button allow users to
modify report properties.
For information on configuring reports, see Reports Overview on page 61.

44
Account
The Account tab allows you to change your account settings such as password,
username, full name, and email address.
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. Enter the existing
password in the Old password field, and the desired password into both the
New password and Confirm password fields and click the Update password
button.
• The Account Information section allows you to update your user name, the
name associated with the account, and your email address. To change any of
these items, enter the new information in the appropriate field and click
Update settings. Note that if you attempt to change your user name and the
new name is already in use, you will receive an error.

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

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

Overview 47
|
Similar to Categories, namespaces in the XML Canon web interface are also
represented in a hierarchical structure. You can expand and collapse the
hierarchical components of the URI. Full expansion of a namespace in a
namespace browser will yield a listing of its defining schemas and XML
documents that use them. Namespaces are viewed and queried in a namespace
browser.
The namespace browser also provides a configurable namespace search engine
for searching XML namespaces. You can select up to three namespaces in one
search query and use criteria such as document tag, scope, and other searches to
filter the results.
In addition, the namespace browser provides a listing of the XML DTD
DOCTYPE public IDs referenced by XML documents, 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,
see DTD Doctype Public IDs on page 187.
To learn how to browse XML namespaces in TIBCO XML Canon, see Working
with Namespaces on page 56.
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.
You can generate document reports or component reports based on configurable
search criteria.
XML Canon provides two XSLT documents for creating reports by default. One is
for documents and the other one is for components. You can store those
documents anywhere on the server, but it is recommended that you place them
under a special category. If you prefer your own customization, you can modify
the default documents or create new ones.
To learn how to select, setup, run a report, or schedule a report execution, see
Reports Overview on page 61.

48
Using Categories
This section describes how users with CONNECT capabilities can manage
categories and documents. The chapter assumes that the users have full
permissions. If a user does not have full permissions, that user will not be able to
take some of the actions described in this chapter.
For information about tools available to administrators, see Chapter 10,

Administering Categories and Documents.
Roles permissions determine how much content a user can access through the
category browser and the Category Details panel. For more information on
permissions, refer to Roles Overview on page 196.
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.
Figure 35 The TIBCO XML Canon Menu Bar
The category browser appears in the left-hand frame, as shown below. You can
access and manage categories (set permissions, tag, and clone) and documents
from this browser.
Figure 36 Category Browser

Using Categories 49
|
The category browser initially displays top-level categories. To expand a category

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

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

Using Categories 51
|
Tagging If your role has assign or reassign tagging permission, you can also see a Tagging
area in the Category Details panel. For more information on tagging, see
Chapter 8, Using Tags, on page 130 and Roles Overview on page 196.
Creating Child Categories
In order to create a child category, you must have write permission to its parent
category. Otherwise, the Add Child button for this category will be disabled. For
information on changing category permissions, see Managing Categories on
page 173.
Follow the instructions below to create a new category:

1. Click Browse > Categories from the menu bar to access the category browser.
2. 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. Type the name of the child category in the New Child Category field in the
Category Details panel (see Figure 38).
4. Click the Add child button to complete the process. Note that if you do not
have write permission to the parent category, this button is deactivated.
Figure 38 Creating a Category
5. Go to the category browser to verify that the child category has been created.

52
Renaming Categories
Your role must have the write permission to a category or its parent category in
order to rename it. Otherwise, the Rename button will be disabled. For
page 173.
Renaming a category that contains Tag information affects the WebDAV path and
URL address of documents within the category. The WebDAV path will continue
to use the original name even though the category may no longer exist. However,
you can still access a renamed category through its tag.
Follow the instructions below to rename a category:

2. Locate the category you want to rename and click the name of that category to
view its Details panel.
3. Type the new name of the category in the Name field within the Category
Details panel (see Figure 39).
4. Click the Rename button to apply the new category name.
Figure 39 Renaming a Category
5. Go to the Category browser to verify that the category name has been
changed.

Using Categories 53
|
Deleting Categories
Your role must have delete permission to the category in order to delete it. For
page 173.
A TIBCO XML Canon category can only be deleted through the XML Canon web
interface if it meets following conditions:
• The category is empty.
• The category is not locked.
• Only one category is deleted at a time.
XML Canon is WebDAV-enabled and so can be accessed using a WebDAV client.

It is possible to delete categories and documents using a WebDAV client, even if
they do not meet the requirements above. 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. For more information on WebDAV
clients, see Chapter 9, Working with WebDAV Clients, on page 147.
Follow the instructions below to delete a category through a web interface:

1. Click Browse > Categories from the menu bar to access the Category browser.
2. Expand the category you want to delete from the Category browser and delete
all of its content. If a category contains multiple levels of descendents, start
deleting from the lowest level and move upwards after each category
deletion. You must delete the entire content of the parent category (documents
and child categories) before you can delete it.
a. Select a document under the Categories folder to view the Document
Properties.
b. To delete a document, click the Delete... button found in the Detailed
Views area.
See Deleting Documents on page 93 for information on how to delete
documents.
3. Click the name of the category in the category browser after clearing all its
contents.

54
4. Click the Delete... button in the Category Details panel to delete the category.
To preserve the integrity of a tagged collection of categories and documents,

TIBCO XML Canon assigns a special deleted tag to all deleted documents and
moves them to a holding location. This location can only be accessed by an
administrative user. Deleted categories and documents will remain on hold until
they are purged from the database. For information on purging deleted
categories, see Purging Deleted Categories and Documents on page 177.
If the category you are deleting is not empty, 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, your role must be assigned read and write
permissions to that category as well as its destination category. For information
on changing category permissions, see Managing Categories on page 173.
Follow the instructions below to move a category to another location within the
TIBCO XML Canon repository:
2. Expand the categories to view both the category you want to move and the
category you want to move it to.
3. Click on the folder icon associated with the category you want to move as
shown in Figure 41.
Figure 41 Moving a Category - Before Selection

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

56
Working with Namespaces
This section describes how to work with XML namespaces in TIBCO XML Canon.
Browsing Namespaces for Documents

Follow the instructions below to browse namespaces for their associated
documents:
1. Click Browse > Namespaces in menu bar to access the Namespace browser.
(See Figure 43)
Figure 43 The Namespaces Menu Bar in TIBCO XML Canon
2. The Namespace browser appears in the left-hand frame of the browser

window (see Figure 44).
You will see a list of all namespaces that are associated with documents stored
in the TIBCO XML Canon server. This list is categorized by URI scheme (for
example, http://), host name (for example, www.tibco.com), and path (for
example, 2001/XMLCanon).
By default, the namespace browser displays all namespaces in TIBCO XML
Canon because they are filtered by the default Latest tag. This includes all the
documents in the repository. You can also filter namespaces by other tags the
same way you filter the category list in the category browser by tags. For more
information on tagging, see Chapter 8, Using Tags, on page 130.
Figure 44 Namespace Browser
3. Click the sign to expand a namespace path.

4. Click the sign to collapse a namespace path.
A namespace is represented with a button in the namespace browser,
whereas a namespace path is represented with a button.

Working with Namespaces 57
|
5. Select a name of the namespace to see its namespace details page in the
right-hand frame. This page displays the Schemas tab view by default. (See
Figure 45)
Figure 45 The Namespace Details Page
6. Select other tabs to view documents which are associated with the selected
namespace.
— The Schema tab displays a list of schemas that define the selected
namespace. For example, XML schemas with a target Namespace attribute
matching the selected namespace.
— The Instances tab shows a list of documents that use the selected
namespace in an XML <root> tag.
— The Uses tab shows a list of documents that use the selected namespace,
but do not fit under either of the two preceding tabs. For example, an XSLT
file that converts documents from one namespace to another namespace
will be shown under this tab for both namespaces.
The Presentation tab is visible only to users with ADMINISTRATOR capability.

See Chapter 11, Administering Namespaces, on page 185 for more information.
7. Click on a document name in one of the tabs to view its details in the right
panel.
Searching Namespaces
Follow the instructions below to search namespaces within associated documents:
1. Click the Search... button at the bottom of the namespace browser to switch
the namespace browser to a Namespace Search panel (see Figure 46).

58
Figure 46 The Namespaces Search Page
2. Select a namespace you want to search in documents under the Select

namespaces to match area. This action will highlight the selected namespace.
To add another namespace to your search query, click on its name.
TIBCO XML Canon allows you to search with a maximum of three
namespaces. If you select more than three namespaces or none at all, the
namespace Search button becomes inactive.
TIBCO XML Canon allows you to search with a maximum of three namespaces.
3. Click on a pre-selected (highlighted) namespace to deselect a namespace from

your search.
4. Select the search scope from the Search scope drop-down list.
The search scope is either all documents or documents of a particular type.
The default search scope encompasses All documents which searches all
document types in the repository.
5. Select a search constraint from the Search constraint drop-down list. There are
two kinds of matches:
— Match all is the default selection. Permits you to search for documents that
contain references to all selected namespaces.
— Match any allows you to search for documents that contain references to
any selected namespace.

Working with Namespaces 59
|
6. Select a tag from the Document tag drop-down list.

TIBCO XML Canon searches for tags assigned to the documents at the time
the documents were created. These tags are not associated with later versions
of the same document. For more information on tagging, see Chapter 8, Using
Tags, on page 130.
7. Click the Search button at the bottom of the namespace search panel to
perform a search. Your search results will be displayed in the right-hand
frame.
8. Select a document from the Namespace Search Results list to see its details in
the document details page.
9. Click the Return to browsing button to return to the namespace browser.
Browsing and Editing DOCTYPE Public IDs

Follow these instructions to edit DOCTYPE public IDs:
1. Click Browse > Namespaces in the menu bar to access the namespace
browser.
2. Click the Doctypes button in the namespace browser to open DOCTYPE
Listing panel (see Figure 47).
Figure 47 Editing DOCTYPE Public IDs
The DOCTYPE Listing panel displays all public IDs found in the TIBCO XML
Canon repository.
If a user has edited the DTD access path for a public ID, only this user or an
administrative user can change the access path.
3. 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.

60
The access path may be either of the following:

— A relative path in the TIBCO XML Canon server. Such paths will begin with
a forward slash ’/’ representing the server’s root in TIBCO XML Canon (the
Categories category).
— An absolute path represented by fully qualified URL beginning with

http://.
4. Click the Update button to carry out the implementation.
The namespace resolution method for document validation is defined in stage

configuration. If you want to use the access path specified in the DOCTYPE listing
panel to resolve public IDs in your instance documents, ask an administrative
user to make the appropriate stage configurations.
While using the access paths specified in the DOCTYPE listing panel, you must
specify a pseudo or dummy system ID in your instance documents in order to
perform the validation task. Otherwise, the validation tool will treat the
document as invalid.
For more details on managing DOCTYPE public IDs in TIBCO XML Canon,
see DTD Doctype Public IDs on page 187.

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

You can set up TIBCO XML Canon reports from the Report tab in your XML
Canon home page, 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

62
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. You need to understand these reports in
order to understand the report process in TIBCO XML Canon.
• 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. Reports are queued to run and, even if there is not a
queue, it will still takes a few seconds for the report to generate. For instance,
if you were working at 2 p.m. and decided to run a report immediately, there
might be three reports in the queue that are scheduled to run at 2 p.m daily.
The Queued Reports list in the Reports browser tells you what reports are
currently being queued to run.
• Available Reports
These are reports that have already run and the results are available for
review. 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.
Delete The TIBCO XML Canon server grants you with the Delete permission on all
reports you have created or configured. This means you have read-only access to
reports which other users configured. For example, in Figure 49, you can delete
Default Document Report, but you cannot delete the Default Component Report.
If a report is generated by another user and you are not an ADMINISTRATOR

user, the Delete action is not present in your Available Reports list.

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

64
Configuring a New Report
To configure a new report, 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, public versus private)
• Schedules for running the report
These configuration steps are described in the sections below.
Searching Documents for a Report

When you click the Select and Setup Reports button, you will be prompted with
a choice of two default reports: the default document report and the component
report (see Figure 51).
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. These criteria are listed under the area titled Find documents and
components using search criteria. Hide or add certain criteria and choose default
values according to your needs (see Figure 52).

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

66
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... button (see Figure 53). If your search
is based on the component report, you search results will be displayed under the
Components Selected for the Report area.
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. By default, 20 search result records will be displayed per page.
However, you can use the Step drop-down menu to change the number of records
displayed per page. Note that the display number controls the size of steps for
navigation.
Figure 54 Report Navigation Position
Navigation If the search results exceed the maximum display limit set in the Step menu, the
view also includes a Navigation area for you to go through all the pages of the
result list. The Navigation area contains four self-explanatory buttons: Start, Back,
Forward, and End (see Figure 55).

|
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.
• The Back button takes you to the previous page of the results list.
• The Forward button takes you to the next page of the 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.
• End takes you to the end of the document list.
Actions Below the search results, the Actions section allows you to either clear the report
or specify further search parameters.
Figure 56 Report Actions
• Click Clear the Report Parameters to exit the report and return to the default
report list.
• Click Set the Report Data and Display Parameters button to configure the
report data and set the report display parameters.
Continue below for more information about the display options.
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.
The Report Display Parameters screen allows you to set the report actions,
configure the report data, and select the report display parameters. These settings
are described below.

68
Actions Although the Actions buttons are located at the top of the report display
parameters screen, you should review the Report configuration and Report
display parameters sections (described below) before performing any actions.
• Click Review report settings to display a summary of the current report

configuration and parameters, 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.
• Click Clear all settings and restart to exit the report and return to the default
report list.
Configure report Figure 57 Report Display Parameters — Configure report data

data
In this section, you can:

• Provide a name for your report in the Report Name field.
• Assign a Permission to your report:
— Public The report can be viewed by all TIBCO XML Canon users.
— User and Administrator only The report can only be viewed by the user
who created or configured it and users with the ADMINISTRATOR
capability.
• Include additional data in your report such as document properties,
document relationships. To do this, just check the box next to the data type.

|
For an explanation of the various data you may want to include in a report,
refer to Chapter 6, Using Documents, page 75 and Chapter 7, Components,
page 115.
Including a large amount of data in your reports will cause problems with the
cache space that the reports consume. If you generate a long report, you should
include only the most relevant data.
If you choose to run a large report, you may get an error message from the server.
However, the report will be generated to the maximum size allowed by your
administrative policies.
For information on how the administrator sets the maximum report size and
other reporting limits, see Policies Page Overview on page 240.
If the report you are attempting to generate includes documents and components
beyond the maximum report size allowed, you will receive an error about the
documents only. A components over limit error message will only be sent if
documents in the report are not over the maximum size limit.
Report display Figure 58 Report Display Parameters

parameters
For an explanation of these parameters, see Searching Namespaces on page 57 or

Searching for Documents on page 108.
After reviewing the report settings, you have the option of running the report
immediately, scheduling the report execution for a later time, updating the report
settings, or clearing all settings for a new search. Continue with Running or
Scheduling the Report below.

70
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).
Click the Review report settings... button to display a summary of the report
configuration and parameters. This summary consists of the report name,
permission settings, and other parameters.
The report summary is divided into several sections, described here.
Actions The Report Summary screen offers several buttons.
• Run report immediately runs the report with the selected parameters, and
returns you to the Reports tab on the XML Canon Home Page.
• Schedule report runs the report at the specified time. See Schedule below for
more information.
• Update settings returns you to the Report Display Parameters screen, where
you can make changes to your selections. (This screen is described in the
previous section, Setting Report Display Parameters.)
• Clear all settings and restart exits the report and returns to the default report
list.
Schedule The Schedule section is used in conjunction with the Schedule report button.
When you click Schedule report, XML Canon runs the report as specified in the
Schedule section.
You can schedule:
• The frequency:
— Once
— Daily
— Weekly
• The day of the week (or Today).
• The hour of the day.
• The minutes after the hour.
The following example shows a report scheduled to be generated once a day,
starting on Friday at 6:30 p.m.

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

72
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, your XSLT document must
reference the namespace http://canon.na.tibco.com/Reports.
You might find it helpful to use one of the provided default reports,
defaultDocumentReport.xsl or defaultComponentReport.xsl, as a guideline.
These reports are under the XML Canon Reports category. Use the category
browser to open them by following the instruction below (see Figure 61).
1. Click Browse > Categories > Reports from the menu bar and expand the
categories (see Figure 61).
Figure 61 Browsing Categories for Reports
2. Select one of the default reports by clicking on its name to open its document
details page.
The detailed report view opens in the right panel.
3. Scroll down to the Detailed Views area and click the Quick View button (see
Figure 62).
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).

Using an XSLT Document as a Report 73
|
Figure 63 The XSLT Style Sheet for Report
Note that the namespace

http://www.tibco.com/namespaces/2004/XMLCanon/Reports has been used
in this stylesheet.
You can review this stylesheet for guidance in designing your own report using a
XSLT document. You can also contact TIBCO support for further guidance.

74

| 75
Chapter 6 Using Documents
This chapter provides instructions on using and managing documents in TIBCO

XML Canon.
Topics
• Documents Overview, page 76

• Document Details Page, page 77
• Viewing Different Document Versions, page 87
• Uploading Documents, page 89
• Downloading Documents, page 91
• Moving Documents, page 92
• Deleting Documents, page 93
• Locking and Unlocking Documents, page 94
• Updating Document Properties, page 96
• Managing Documents with Stages, page 97
• Viewing Document Content, page 98
• Validating Documents, page 101
• Using the Differencing Engine, page 104
• Notification Subscription, page 106
• Searching for Documents, page 108
• Accessing Documents via URL, page 111

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

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. Figure 64 shows the Properties
tab of a document details page.
Figure 64 Document Details Page
Tabs
The document details page contains four tabs which are located at the top of the
page. Select one of these tabs to see different information about the document:
• Select the Properties tab to see the document properties, including its custom
properties. See Properties Tab on page 79 for more information.
• Select the History tab to view the document revision history and subscribe to
web and/or email notification on future changes to the document. You can

78
also use the differencing engine to view differences between versions. See
History Tab on page 82 for more information.
• Select the Relations tab to see the document associations with other
documents. See Relations Tab on page 84 for more information.
• Select the Update tab to update the document properties. See Update Tab on

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

80
This section also includes a row of buttons that perform more actions. See
Document Details Buttons below for more information about these options.
Tagging If your role permits you to assign tags, you will be able to see a Tagging area
below the Detailed Views area. For more information on tagging and tagging
permissions, see Chapter 8, Using Tags, on page 130 and Roles Overview on
page 196.
Document Details Buttons

You will see a row of buttons at the bottom of the document details page. They
enable you to perform operations (such as lock, validate, view, or save) on
documents in TIBCO XML Canon providing you have the necessary permissions
to carry out the operations.
If you do not have the appropriate permission to perform certain functions (for
example, delete documents), the corresponding buttons are disabled. Also,
depending on the type of document you are viewing, some buttons may be active
while others may be inactive. Figure 66 shows a view of all the buttons present
with all permissions granted to a user’s role.
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. Refer to Locking and Unlocking
Documents on page 94 for more information.
• Quick view displays the current document’s content as a plain text file in a
new browser window. See Viewing Document Content on page 98 for more
information.
• Save as downloads a copy of the current document to your local system. See
Downloading Documents on page 91 for more information.
• Validate validates the current document. See Validating Documents on
• Delete deletes the current document from the server. See Deleting
Documents on page 93 for more information.
• Components displays all components in the current document. For more
information on components, see Chapter 7, Components, on page 115.
• Analyze performs an logical analysis of the current document. For more
information, see Analyzing Documents for Components on page 182.

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

82
Table 3 Document Metadata
Save date The date when the currently selected version was uploaded.
Analyzed Indicates whether the schema or XML document has been logically analyzed. 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.
Documentation Any annotations within the XSD schema to be read by humans (for example, the
content within all <documentation> tags in an XSD schema).
Application Any annotations within the XSD schema for consumption by an application. (For
information example, the content within all <appinfo> tags in an XSD schema)
History Tab
The History tab in the document details page shows a revision history of the
selected document in TIBCO XML Canon.
Figure 67 shows a typical History tab view in the document details page.
Figure 67 Document Details Page - the History Tab

|
Notifications The Notifications area allows you to subscribe to notifications about updates on
the current document. Notifications can be sent via email, via the web, or both
depending on the subscriber’s selection. For more information, see Notification
Subscription on page 106.
Document history The Document history area displays a list of all revisions of the document. It also
displays some applicable metadata for each revision. Refer to Table 3, Document
Metadata, on page 81 for descriptions of all metadata.
You can view the document details for a different version by clicking on its
revision label or the button next to it. For more information, see Viewing Different
Document Versions on page 87.
If a previous document version existed in a stage or category in which you do not

have the read permission, you will not be able to access its document details page.
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. 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 document to see if it is well-formed. See Validating
Documents on page 101.
• Delete removes the document. 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.

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

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

86
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.
View on page 98.
• 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.

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.

88
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.
View on page 98.
• Validate checks the validity of the selected document. See Validating
• Delete removes the document from the server. Note that, unless you are an
administrator, you can only delete unlocked documents that you created.

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.

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

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.

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

Deleting Documents 93
|
Deleting Documents
You must have delete permission for the document category and its stage in order
to delete it.
You can only delete one document at a time from the TIBCO XML Canon web
interface. However, WebDAV support offers an efficient way to delete multiple
documents. For more information on WebDAV clients, see Chapter 9, Working
with WebDAV Clients, on page 147.
Follow the instructions below to delete a document from the web interface:
2. Find the desired document in the category browser and click on the name of
the document to view its details page.
3. Click the Delete... button in the Detailed Views area.
4. Click the Ok button when prompted with a pop-up window.
To maintain the referential integrity of tagged categories and documents, 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. Documents which have been assigned the
deleted tag no longer have the latest tag. These documents will remain on the
server until they are purged. For information on purging deleted documents, see
Purging Deleted Categories and Documents on page 177.

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

2. Find the document you want to lock and click on the document name to view
its details page.
3. Click the Lock button at the bottom of the document details page to lock the
document.

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. However, you may launch your
email client directly from the document details page to email the user who locked
the document. See step 2 for more information.
Follow the instructions below to unlock a document:
2. Find the locked document in the category browser and click on the name of
When a document is locked, 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 on the name of the user (in
blue font) to send an email to this user.
Figure 75 A Document Locked by Pat
3. Click the Unlock button at the right of the Locked By attribute to release the
document lock. Note that this button is only available to lock owners and
administrators.

96
Updating Document Properties
You can only update metadata of the latest version of a document. You cannot
access the Update tab when you are viewing an earlier version of a document.
Follow the instructions below to update document properties:

2. Find the desired document in the category browser and click on the document
name to view its details page.
3. Click the Update tab at the top of the document details page.
4. Update the properties in their corresponding text fields and from their
drop-down lists.
You can update various document properties, including custom properties, as
shown in Figure 76.
For more information on changing the document stage, see Managing
Documents with Stages on page 97.
Figure 76 Updating Document Properties
5. Click the Update properties button at the bottom of this tab to complete the
update.
After you update document properties, the document will be saved as a new
version.

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

98
Viewing Document Content
There are two ways to view the document content in TIBCO XML Canon: quick
view and detailed view. 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.
Note that there might be several detailed views available to you depending on
your document type. TIBCO XML Canon provides three types of detailed views:
• XML view — Available for XML documents only. The XML view displays the
content of a document in a nesting structure by tags. These tags are
automatically color-coded by the browser depending on their levels.
• SchemaDOC — Available for XML schema and DTD documents only. 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.
• Namespace Presentation — User-defined. See Namespace Presentation on
This section describes the quick view and the two default detailed views.
Quick View
The quick view allows you to view the content of an XML document in plain text.
Follow the instructions below to view an XML document using the quick view:
3. Click the Quick View button at the bottom of the document details page.
You will now see a new browser window displaying the document content in
plain text as shown in Figure 77.
If the browser recognizes the suffix of the document (for example, .doc or
.pdf), it will display this document in the appropriate application. If the
format of the document can be displayed natively by the browser (for
example, HTML or XHTML), the browser will show the content in its
rendered form.

Viewing Document Content 99
|
Figure 77 Document Quick View
Detailed View
TIBCO XML Canon provides two detailed views of XML documents by default,
XML view and SchemaDOC.
XML View
The XML view is for displaying XML documents. Follow the instructions below
to view an XML document using the XML view:
3. Click XML view in the Detailed Views area.
SchemaDOC View
The SchemaDOC view is available for schemas and DTDs only. Follow the
instructions below to view a schema using the SchemaDOC view:

100
3. Click SchemaDOC in the Detailed Views area.
You are prompted to install the RENESIS Player. This is required to view the
SchemaDOC graphical diagrams.
The RENESIS Player is available as a free download from

http://www.examotion.com/.
Figure 78 shows a SchemaDOC view of a sample schema. The diagram at the

top shows a graphical representation of the breakdown hierarchy structure
model of all elements. It also displays the relevant metadata and the indented
source code at the bottom of the window.
Figure 78 The SchemaDOC View

Validating Documents 101
|
Validating Documents
The document validation refers to schema checking (such as XSD or DTD syntax
checking), and XML validation. TIBCO XML Canon provides you with two
methods to validate these documents:
• Validate a document from its document details page.
• Validate a document on your local file system by the document path from the
Category Details panel. This option is useful if the document needs to be valid
before it is uploaded into a stage which enforces document validation.
Validating in the Document Details Page

Follow the instructions below to validate a document from its document details
page:
3. Click the Validate button at the bottom of the document details page.
After the validation process, you will see a results page that either displays
errors (if the document is invalid) or indicates no errors (if the document is
valid).
Validation is disabled for TIBCO ActiveMatrix BusinessWorks process

documents. As a result, the Validate button is disabled. Therefore, 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 a Category Details panel

Follow the instructions below to validate any document on your local file system
from a Category Details panel:
2. Click the name of any category to view its Category Details panel.

102
3. Click the Validate Document... button in the Document Actions area.
Validation is disabled for TIBCO ActiveMatrix BusinessWorks 5.x process

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

Validating Documents 103
|
— Location only. TIBCO XML Canon will try to resolve schema references
based only on the value of the schema Location attribute.
When resolving public IDs with this option, TIBCO XML Canon uses only
the URLs specified in the instance documents.
5. Click the Validate... button to start validating the document.
After validation, if the document is not valid, you will see a results page
showing all errors within the document.
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.g. from
8080 to 8081).
Instead of making changes to your TIBCO XML Canon documents to
accommodate the port change, you can ask your systems administrator to define
port aliases in the server.xml file. This file and more instructions are located in
TIBCO_HOME/xmlcanon/tomcat/conf.

104
Using the Differencing Engine
TIBCO XML Canon provides an XML differencing engine, which enables you to
view the differences between two document versions or revisions.
Follow the instructions below to view differences between two document
versions:
3. Click the History tab at the top of the document details page (see Figure 79).
4. In the Base column of the Document History area, select the version you want
to use as the base version.
5. In the Mod (Modified) column, select the version you want to use as a
modified version to compare to the Base version.
6. Click the Show differences button at the bottom of the Document History
area to launch the XML differencing engine (see Figure 80).
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. Figure 80 shows a typical results view of the differencing engine. It
detects an inserted element in the modified version.

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

106
Notification Subscription
TIBCO XML Canon provides two modes of receiving notifications from the
server: the web interface and email. 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.
• Stage subscription — Notifies the user when a document moves into a
subscribed stage.
Subscribing to Documents
Follow the instructions below to subscribe to a document notification:
3. Click the History tab at the top of the document details page.
4. Check the appropriate checkbox (or checkboxes) to select the notification
method. Notification can be received from the server through a web report,
email, or both.
5. Click the Update button to apply the subscription.
Subscribing to Stages
Follow the instructions below to subscribe to a stage for notification:
1. Click the Home button from the menu bar to open the TIBCO XML Canon
home page.
2. Click the Personal options tab in the TIBCO XML Canon home page.

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

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

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

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

date
Stage Search for documents in a particular stage. The default is blank, which
represents documents in all stages.
Revision label Search for documents that contain the specified string in the document Revision
label.
User Search for documents that were last modified by a specific user.
Locked by user Searches for documents that are currently locked by a specific user.

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

112
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 %20 . For
instance, category Level 1 is changed to Level%201 in the URL.
Accessing Tagged Documents

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.

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, root.xsd can be accessed without user authentication via the
following URL:
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>

114

| 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

116
| Chapter 7 Components
Components Overview
Components are building blocks which make up the abstract data model of XML
Schema, DTD, WSDL, and other logically analyzable documents. TIBCO XML
Canon analyzes schemas, DTDs, WSDL, and TIBCO ActiveMatrix BusinessWorks
Process Definition documents. TIBCO XML Canon server logically analyzes the
document in order to catalog its constituent components during its initial load.
After that, TIBCO XML Canon creates a searchable dictionary of all the
components in the repository, allowing you to browse and easily search through
all documents and components.
A user with the ADMINISTRATOR privilege can also force a logical analysis on
documents in the repository. For more information, see Analyzing Documents for
Components on page 182.
Component search is one of the most powerful features of TIBCO XML Canon. It
allows you to search for components transparently. This is achieved by analyzing
schemas and XML documents during their check-in, and for every version. For
more information on component searching, see Searching for Components on
page 125.
Component Types
Table 5, below, lists components indexed by TIBCO XML Canon.
Table 5 Indexed Components in TIBCO XML Canon
Component Description
Elements The basic building blocks of XML markup. Elements serve as containers for
character data, entity, or character references, processing instructions or PIs
comments, markup text, and other elements.
Collectively, the various items that make up an element are known as its content.
A content model of an element defines the element's structure.
Phantom A presumed element declaration in DTD documents. It only contains ATTLIST

Element declarations but does not contain any ELEMENT definition. In general, you cannot
find this element in well-designed DTD documents.
Attributes Components that are declared within elements to add information by appending
simple properties to them.
Simple Types A primitive, simple data type (such as string), where the content only includes
characters.

Components Overview 117
|
Table 5 Indexed Components in TIBCO XML Canon
Component Description
Model Group The collection name for elements which are grouped together for easy reference in
an XML document.
Attribute The collection name for attributes which can appear in more than one element in
Group an XML document.
Complex Type An element that contains other elements or attributes.

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

118
TIBCO ActiveMatrix BusinessWorks and WSDL Components

In addition to the logical analysis of the standard schema and DTD components,
TIBCO XML Canon also analyzes WSDL documents and TIBCO ActiveMatrix
BusinessWorks process definition documents. Refer to TIBCO ActiveMatrix
BusinessWorks and TIBCO Designer documentation for more information on
WSDL and TIBCO ActiveMatrix BusinessWorks process definition components.

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.

120
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
Name The name of the component.
Namespace The namespace to which the component belongs (if any).
Type The type of the component (such as element and attribute).

Component Details Page 121
|
Table 6 Component Metadata
Defining The document which defines the component.
Document
Stage The stage in which the component’s defining document

resides.
Defining The defined context of the current component. For example,

Component if the current component is a top-level component, then the
value of this attribute is Top Level Component.
Documentation Any documentation for the component in the defining

document (such as XML comments in DTD and the value of
the <annotations> tag in XSD).
Application The content in the component’s <appInfo> tag in XSD.

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.

122
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
Name The name of the component being used.
Role Indicates how the component is used by the current

component.
Type The type of the component being used.
Namespace 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
Usage Role Indicates how the current component is used.

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

that uses it.

124
Viewing Components
Follow the instructions below to view the components of a document:

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.

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

126
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.
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.
5. 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.
• Click on the name of a defining document to view its document details
page in the right-hand frame.
• Click New search at the top left of the results frame to begin a new
component search.
• Click Modify search at the top right of the results frame to modify your
search criteria for another search query.

Searching for Components 127
|
Table 9 Component Search Criteria
Criterion Description
Component Search for a component by its entire name or part of its
name name.
Component Search for components of a particular type (such as element,

type attribute, and simple type).
Documentation Search for components that contain commentary strings in

an XML comment or in the <documentation> tag of an XSD
schema document.
Document Search for all components in defining documents by the

name defining document’s name. You can search by its entire
name or part of its name.
Application Search for components that contain application information

information strings within the <appInfo> tag of an XSD schema
document.
Stage Search for components in documents which belong to the

specified stage. The default is All stages, which represents
documents in all stages throughout the repository.
Component Search for components that belong to namespaces. You can

namespace search for the exact name or part of the name.
Document type Search for components in documents of a particular

document type (such as XSD).
Document tag Search for components by the tag of their defining

documents. The default tag is Latest, which includes all
current documents in the TIBCO XML Canon repository.

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

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

130
| Chapter 8 Using Tags
Chapter 8 Using Tags
This chapter describes how to use tags in TIBCO XML Canon.
Topics
• Tags Overview, page 131

• Assigning Tags, page 134
• Browsing By Tags, page 140
• Viewing Documents via URL with Tagging Information, page 142
• Removing Tags, page 145

Tags Overview 131
|
Tags Overview
Tagging in general is a labelling, recognizing, and identifying mechanism. In

TIBCO XML Canon, it allows you to label, identify, and recognize a particular
revision of a document or a set of documents effectively. 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.
The tag information can be used to access external documents or applications
using unique URLs. This URL contains information specific to the tag. 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. If a
document has multiple tags during its development cycle, each revision group
(under the same tag) will be accessible at the same time via their unique URLs.
For more information on accessing tagged documents via URLs, see Accessing
Documents via URL on page 111.
Most version control systems (VCS) use tags. In fact, 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.
Tag Nomenclature
The rules of naming tags are defined as follows:
• The name of the tag must be meaningful. It is a string identifier and has the
maximum length of 256 characters. This string consists of alphanumeric
(A-Z0-9), dash (-), underscore (_), and does contain any spaces.
• The case of the tag depends on the database configuration. If the database you
are using is case-sensitive, the tag name will also be case-sensitive.
• Tagging is an association between a label and a document or category in
TIBCO XML Canon.
Tag Characteristics
Tags in TIBCO XML Canon have the following characteristics:
• Each document in TIBCO XML Canon must have one of two tags: Latest or
Deleted.
• The Latest tag is assigned to the most current revision of every document in
TIBCO XML Canon.

132
• When a tagged document is deleted from TIBCO XML Canon, it is assigned

the Deleted tag instead of the Latest tag. 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). However, the assigned tag stays with the same
document version despite the document status.
• Although a document can have more than one tag, the same tag cannot be
assigned to more than one version of the same document.
• A single document revision can have multiple tags.
• Tags assigned to earlier document revisions can be reassigned to the most
current version (Latest).
• Tags can be assigned to categories in XML Canon.
Tags in the Category Detail View

Tag details are located in the category details view. The details view lists all tags
which have been assigned to the category, including the Latest tag (see
Figure 92). Furthermore, the Tags property offers a mechanism for removing tags,
providing you have the permission to remove tags.
Figure 92 The Tag Property in the Category Details View
As you see in Figure 92, there are two symbols which represent two status of a tag
in category details view.
• The emerald icon (green, diamond-shaped symbol) represents a fixed tag
which cannot be removed (such as the Latest tag and the Delete tag).
The Delete tag will be marked on a category instead of the Latest tag after it has
been deleted but before purging.

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

134
Assigning Tags
This section provides instructions on assigning tags to documents and categories

in TIBCO XML Canon. 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).
You may assign multiple tags to one document revision. However, since each tag
in TIBCO XML Canon is unique and identifies a particular revision of a
document, you may not assign the same tag to two different revisions of the same
document.
• You must have the assign tagging permission to assign tags to documents.
• You must have the remove tagging permission to delete tags from documents.
• You must have the reassign tagging permission to assign a new tag to a
previously tagged revision.
You need to have all three permissions above to complete the remaining functions
described in this chapter. For more information on tagging permissions, see Roles
Overview on page 196.
Assigning Tags to Documents

Tags can only be assigned to the latest revision of documents. Therefore, the
revision must be currently assigned the latest tag in order to assign a tag to an
earlier revision of a document.
Follow the instructions below to assign a tag to a document revision:
2. Click on the document name to view its document details.
3. View the revision history of the document under the History tab. Note that the
highlighted version is assigned the Latest tag by default (see Figure 94).

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

136
6. Type the name of an existing tag, or select a tag from Current Tags in the
Tagging area at the bottom of this tab.
The name of the tag must be less than 256 characters in length and must contain
only letters, numbers, dashes, and underscores.
7. Click the Update button to complete the tag assignment.

8. Review the document revisions under the History tab.
The added tag name is now displayed in the Tags list of the selected revision.
When a document is assigned a tag, the tag is implicitly assigned to its category as
well as to all ascendant categories, all the way up to the root category.
Making a Previous Document Tag Current

The Latest tag can be used as an indicator of whether a document is the most
current one. Therefore, one way to make a previous document current is to assign
the Latest tag to a previous version.
To make an earlier revision current:
(Alternately, use the Search function to locate a category.)
2. Click on the document name to view its details.
3. View the history of this document under the History tab. Note that the
highlighted version is tagged with Latest by default. The Make Selected
Revision Latest button is deactivated because the highlighted version already
represents the latest version.
4. Highlight the revision (or tag) you want to make current by clicking on its
corresponding document button. Note that the Make Selected Revision Latest
button is now active, as shown in Figure 96.

Assigning Tags 137
|
Figure 96 Before Clicking the Make Selected Revision Latest Button
5. Click the Make Selected Revision Latest button.

6. If you received the error message explained above because the document was
not locked, click the Go Back To Make Changes button to return to the
History tab.
7. An older revision of the document has now been made current (or, in other
words, assigned with the Latest tag, as shown in Figure 97). You can verify
the result under the History tab.
Figure 97 After Clicking the Make Selected Revision Latest Button
8. Unlock the Latest revision of this document.

138
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.
To reassign a document tag:
2. Click on a document name to view its document details.
3. View the history of this document including its tag record under the History
tab.
4. Click on the document icon button corresponding to the revision you want to
assign a new tag to.
5. Select the Properties tab to view the revision details.
6. Assign the revision with an existing tag under the Tagging area. Type the
name of a new or existing tag, or select a tag from the Current Tags link in this
area.
7. Click the Update button to complete the tag assignment.
8. The OldRevision tag is now assigned to revision 1.1. You can verify the result
under the History tab:

Assigning Tags 139
|
Assigning Tags to Categories

In order to tag documents in TIBCO XML Canon more efficiently, you can assign
tags to their parent categories instead. This tags all the document groups under
the category. In effect, assigning a tag to a category captures the latest revisions of
its documents.
Follow the instructions below to assign a tag to all documents within a category:
2. Select a category you want to tag from the category browser and view its
Category Details panel.
3. Type the name of an existing tag, or select a tag you want to assign from
Current Tags in the Tagging area.
The name of the tag must be less than 256 characters in length and can contain
only letters, numbers, dashes, and underscores.
4. Click the Update button to complete the tagging operation.

5. The tag has been applied to the latest revision of all documents in this
category. You can verify the result by viewing their document details pages.

140
Browsing By Tags
Tagging is an useful filtering mechanism for browsing categories or namespaces,

or searching for documents or components. It acts as a marker of a specific
revision of documents, and represents metadata (properties) of documents and
their categories.
Browsing Categories by Tags

Follow the instructions below to browse categories by a specific tag:
You can classify the category by tag by changing the value in the by tag
option. The default value is Latest.
2. The tag name linked to the tag picker is a pop-up window that displays all
available tags in TIBCO XML Canon. Click on the tag link on the top-right to
launch the tag picker.
3. Select the name of the tag you want to use as a filter for categories. 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.
Furthermore, the value of the by tag option is changed to the selected tag.

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. These users will not be
able to modify documents or their tags. Non-authenticated users will only be able
to view documents and categories that the Web user has permission to see. For
more information on the Web user, refer to Web (Un-authenticated) User on
page 219.
As an example of the interaction of authentication and tagging, assume we have a
document on the category path /CatA/CatB/doc.txt which has been tagged
with MyTag. 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 tag ("latest" tag is implied) With Tag

No either: http://<hostname>:<portnumber>/pub/tag/M
yTag/CatA/CatB/doc.txt
authentication http://<hostname>:<portnumber>/
pub/CatA/CatB/doc.txt
http://s<hostname>:<portnumber>
/xc/canon/CatA/CatB/doc.txt
Authenticated http://<hostname>:<portnumber>/ http://<hostname>:<portnumber>/tag/MyTag

CatA/CatB/doc.txt /CatA/CatB/doc.txt
Both authenticated and non-authenticated users can use tags to browse

documents, but note that the paths are different.

142
Viewing Documents via URL with Tagging Information
Without tagging, TIBCO XML Canon only permits access to the latest document
version. However, the tagging function enables you to access a specific revision of
a document by way of a tag-specific URL.
Figure 98 shows the history of an XSD Schema in TIBCO XML Canon. The t1 and
t2 tags are user-assigned tags, whereas the Latest tag is an implicit tag in the tags
column.
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.xsd
To access the document with the t2 tag:

http://xmlcanon:8088/tag/t2/MyTestProject/XSDs/alpha.xsd
For the most current version (with the latest tag), use:
http://xmlcanon:8088/tag/Latest/MyTestProject/XSDs/alpha.xsd

Viewing Documents via URL with Tagging Information 143
|
Alternatively, you can use the document WebDAV path because it implicitly links
to the latest revision:
http://xmlcanon:8088/MyTestProject/XSDs/alpha.xsd
The latest document revision can be accessed by two URL formats:

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.
Category Depth
The document path used in a TIBCO XML Canon category can also be used in a
Unix file system. The document URL reflects the hierarchical structure in the
repository by separating individual categories with a forward slash '/'.
The figure below shows a typical example of a TIBCO XML Canon category
browser. There are two subcategories under the BW Projects category which
represent two BW projects, BW Test_01 and BW Test_02. This manual will
explain category depth using the subcategory of BW Test_02, XSDs and all
documents under XSDs as an example.
Use the following URL to access the document invoice.xsd in its latest revision:
http://xmlcanon:8088/BW%20Projects/BW%20Test_02/XSDs/invoice.xsd
A revision of invoice.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. The root server category
(Categories) is not part of the category path.

144
Hints for Using a URL with Tagging Information

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

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. This permission is not granted by
default to any role, including administrators. To assign a tag remove permission,
an administrator must update the tagging permissions in the role details page.
For more information on tagging permissions, see Tag Permissions on page 198.
Tags can be removed from individual documents on their document details

pages, or from a collection of documents by way of the category details page for
their host category.
If a document has been untagged under a host category, the rest of tags in this
category will remain.
Removable tags will be marked with an X-shaped button next to the tag name
in the document or category details view. If you do not have remove permission,
you will only see the green diamond-shaped icon next to the tag.
Removing Tags from Documents

Follow the instructions below to remove a document tag:
2. Select a document from the document browser to view its details page.
3. Open the Properties tab.
4. In the Document properties section, select the tag you want to remove and
click the button next to the tag name.
5. Confirm the tag removal by clicking the OK button in the pop-up dialog.

146
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.
A category may contain documents which have been assigned various tags.
Therefore, 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. For more
information on browsing categories by tags, see Browsing By Tags on page 140.
Follow the instructions bellow to remove a tag from a category.

2. Select a category from the category browser to view its Category Details
panel.
3. In the Category details section, select the tag you want to remove and click the
button next to the tag name.
4. Confirm the tag removal by clicking the OK button in the pop-up dialog.
Removing tags from a large number of documents can be time consuming,

depending on the complexity of your project. It may take several minutes to
complete.

| 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.
Topics
• WebDAV Support in TIBCO XML Canon, page 148

• WebDAV Client Overview, page 151
• Using TIBCO XML Canon with WebDAV Clients, page 155
• Using Windows Web Folders, page 157
• Using TIBCO Designer as a WebDAV Client, page 161
• Using XMLSpy as a WebDAV Client, page 166

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. WebDAV has the advantages of collaborative authoring and
file management. TIBCO XML Canon supports WebDAV and therefore enables
the user to edit and manage resources on the server with WebDAV clients.
The ability to manage resources in TIBCO XML Canon with WebDAV may vary
with the level of support a WebDAV clients offers.
WebDAV and Version Control

WebDAV does not imply full implementation of version control functionalities as
its name suggests. The name merely refers to the ability to provide document
versioning through a locking mechanism, which prevents simultaneous edits to
the same document.
Before using a WebDAV client to update a document, you must first lock the
document in TIBCO XML Canon. To do so, 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. This action prevents other
users from editing the document while it is being revised. You must remember to
unlock the document after editing, and then to reload the new version via the
WebDAV client in order to make it available to other users.
If the document is left unlocked when dowloaded with the WebDAV client, you
cannot revise the document from the TIBCO XML Canon web interface.
When a document fails to save, you will receive an error message which varies
from client to client. If you cannot save documents via a WebDAV client, contact
your TIBCO XML Canon administrator who will review the TIBCO XML Canon
log for the cause of the problem.
TIBCO XML Canon does not use timeout locks on documents or categories. Only
the user who locks the document or an administrator can unlock the document
through its Document Details page.

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, save date, and size) when the resource is saved to the server.
These metadata are then used for filtering search queries in TIBCO XML Canon.
Most of the metadata captured by TIBCO XML Canon is easily mapped to the
corresponding WebDAV properties. Table 11 lists WebDAV properties and their
associated metadata in TIBCO XML Canon. TIBCO XML Canon also exposes its
custom properties as WebDAV properties. However, these properties cannot be
updated using a WebDAV client.
Custom properties, including revision labels and comments, can be updated via
the DAV tab of the TIBCO XML Canon user home page.
Table 11 Mapping WebDAV Properties to TIBCO XML Canon Metadata
WebDAV Property TIBCO XML Canon Metadata

creationdate Date of the initial document load
displayname Name
getcontentlanguage Not supported
getcontentlength Size (bytes)
getcontenttype Mime type
gettag Not supported
getlastmodified Last modification date (applies to category only)
lockdiscovery Locked by (the user who locked the document)
resourcetype Not supported
source Not supported
supportedlock 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.

150
The following properties are specific to XML. Properties marked with an * are
optional. 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.
Table 12 TIBCO XML Canon Properties
TIBCO XML Canon

Meaning
Property Name
modifiedByName The name of the user who last modified the document.
versionLabel* The version label of the document provided by the user.
comment* Comments about the document provided by the user.
stageId Identifies the document’s current stage. If this identifier is

specified by the client, it must always match an existing stage ID
on the transition list for the current stage.
stageName The name of the stage associated with the document.
revision The revision number of the document.
analyzed States if the document has been analyzed.
schemaType XML schema type such as XSD (XML Schema Definition) and
DTD (Document Type Definition), if the document matches a
schema type.
documentation The string representation of <documentation> element. It returns the

content of <annotation> as text. For example, < will be escaped as
<.
appinfo The string representation of <appinfo> element. It returns the

content of <annotation> as text.
rootNamespace The root namespace information of a document.
governingNamespace The governing namespace information of a document.
conformingStage* Conforms a document stage. Its value must match an existing

stage ID.
Metadata such as revision label, comment and custom properties are updated
through the DAV tab in the home page of the TIBCO XML Canon web interface.

WebDAV Client Overview 151
|
WebDAV Client Overview
Many vendors supply WebDAV client software, and some are available for
download from the web free of charge. However, the level of WebDAV support
and the available features vary from client to client. Nevertheless, 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.
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. For
example, using copy and paste tools.
• TIBCO Designer — A design-time tool for developing and testing TIBCO
ActiveMatrix BusinessWorks processes. TIBCO Designer is integrated with
TIBCO XML Canon through a WebDAV plug-in, which enables you to use
XML Canon as a central repository for collaborative development and
management of your TIBCO ActiveMatrix BusinessWorks projects.
• Altova’s XMLSpy — A popular Integrated Development Environment (IDE)
for XML with WebDAV support.
Tips for Using WebDAV Clients

There are many commercial and open-source WebDAV clients which vary in their
WebDAV support and feature set. Therefore it is not practical to state the
interactions between every client and TIBCO XML Canon. However, you can read
this section for an overview of how XML Canon works with WebDAV clients.
Managing Categories and Documents

Categories on the TIBCO XML Canon server resemble regular file system folders
and documents resemble regular files. The level of support and functions of
WebDAV vary over clients, but basic functions will still be provided. These
functions include moving categories and documents, by cut and paste, drag and
drop, upload, download, and delete functions.
Permissions
Your ability to view categories and documents on the server depends on your role
permissions, regardless of the WebDAV client used with TIBCO XML Canon. For
instance, a category will not display if you do not have the permission to view it.

152
Tags
Tagged documents on the TIBCO XML Canon server are accessible as read-only
resources via WebDAV clients. XML Canon makes such documents available
through the tag folder under the root folder (categories). Each tag is
represented as a folder with the same tag name under the tag folder (see
Figure 99). You can open one of these tag folders and browse all resources
assigned to a particular tag.
The tags folder is read-only and for document viewing purposes only. You will
not be able to edit any documents within the tags folder.
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. Clients such as Windows Web Folder and XMLSpy do not
have these features. In cases where the WebDAV client does not support locking,
you must lock and unlock documents manually via the TIBCO XML Canon web
interface in order to modify them. For more information, see Locking and
Unlocking Documents on page 94.
Failing to lock a document before downloading it for editing could jeopardize

other document updates, because other users can access and modify the same
document without your knowledge. This could cause your copy of the document
to miss updates made by others. If this happens, data will be lost.
Check-in Properties
TIBCO Designer allows you to update the document properties directly during
check-in, but other WebDAV clients do not provide this feature. However, you can
update properties after the check-in via the DAV tab of the TIBCO XML Canon
home page. See Using TIBCO XML Canon with WebDAV Clients on page 155 for
more information.

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. For more information on specifying a default upload
stage, see Using TIBCO XML Canon with WebDAV Clients on page 155.
If a default upload stage has not been specified, TIBCO XML Canon will assign a
stage to the document to users with write permissions. If there is more than one
stage to choose from, the initial upload stage for a document will be ambiguous.
In this case, TIBCO XML Canon will assign the first document stage in the
transitional configuration of all stages. It is therefore better to avoid the
ambiguous default upload stage.
TIBCO Designer also enables you to transit documents into a different stage at
check-in time. You must use the DAV tab of the TIBCO XML Canon home page to
change the document stage. See Managing Documents with Stages on page 97 for
more information.
Error Messages
The error messages received during WebDAV operations vary from client to
client. If you cannot perform certain operations via a WebDAV client, ask your
TIBCO XML Canon administrator to review TIBCO XML Canon logs to find the
cause.
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,
/xc/canon may be dropped from the URL. For example, the path above
would become simply:
or
WebDAV://<hostName>:<portNumber>/<categoryPath>/<documentName>
depending on the WebDAV client.

When you use this type of path, authentication is not based on the Web role.
Instead, you will be prompted to authenticate manually, and access is granted
based on the your role memberships.
• Manual user authentication is required when xc/canon is omitted from the
URL. Therefore, this path is not recommended for runtime scenarios unless
your application is designed to provide essential parameters to process
standard HTTP authentication automatically.

154
• The root category (Categories) is not included in the URL.

• Many web browsers will automatically use %20 to represent the space
character in a URL string. You must replace all space characters in URLs to
access the document, if your application does not process the space character
automatically. For example, to access the address.xsd document under the
My XSDs category, use:
http://xmlcanon:8088/My%20XSDs/address.xsd
• The port number is not required in the URL if the server is configured to use
port 80 or 433.

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. This
section provides instructions for various WebDAV-related tasks in the TIBCO
XML Canon web interface.
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. Although the server has a
built-in logic to assign a stage to the document during its initial upload, it is
recommended that you specify a default stage for WebDAV uploads to eliminate
ambiguity when uploading a document via WebDAV clients.
The default stage for WebDAV uploads is user-specific. It is set via the Personal
Options tab in the home page of the web interface.
Follow the instructions below to specify a default stage for WebDAV uploads:
1. Log in to the TIBCO XML Canon server via its web interface.
2. You will see the TIBCO XML Canon home page. If not, click the Home button
in the menu bar to open this page.
3. Click the Personal Options tab from the home page (see Figure 100).
Figure 100 Specifying a Default Upload Stage
4. Select a default upload stage from the Default stage for WebDAV upload
drop-down list.
5. Click the Update Options button.

156
Managing WebDAV Uploads

TIBCO Designer is integrated with TIBCO XML Canon. It includes a WebDAV
plug-in that simplifies document check-in and check-out. 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.
Follow the instructions below to view documents uploaded through a WebDAV
client and update their properties.
1. Log in to the TIBCO XML Canon web interface using the same credentials you
used in WebDAV.
2. Click the DAV tab under the home page.
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. Select a document or a set of documents you want to update from the Update
column of the Documents area.
4. In the Attributes area, enter a brief comment, a revision label, all required
custom properties, and any optional custom properties.
5. Click the Update Attributes button to complete the properties update.
The document is removed from the list under the DAV tab after its properties
have been updated.
6. Ensure the list is clear, which means all documents are up-to-date. Update the
properties of other documents under the DAV tab until the list is clear.

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

158
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.
Browsing Categories and Documents

Follow the instructions below to browse documents in TIBCO XML Canon
through a Web Folder:
1. Open My Network Places from one of the following locations:
• The Start menu
• My Computer from the desktop
• Windows Explorer
2. 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.
The Web folder displays all TIBCO XML Canon categories within your read
permission as folders. The representation is the same as a local file system. If
you have the view tag permission, you will also see a tag folder (see
Figure 102). To find out more about the tag folder, see Accessing Documents
via URL on page 111.
Figure 102 The Tag Folder under the Root Directory
3. View the Web Folder in the same way as you would view a local system
folder. Double click the tag folder to browse the TIBCO XML Canon
repository by tags.

Using Windows Web Folders 159
|
4. Double-click a document to view it.
Do not double-click a document for editing. Instead, lock the document using the
TIBCO XML Canon web interface and then download it using the Web Folder
before making any modifications.
Adding Categories and Documents

Follow the instructions below to add a child category:
1. Navigate to the level where you want to make a new category and right-click
the blank area in the category content window.
2. Select New in the pop-up menu and click the Folder option.
3. A new folder is displayed with the default name, New Folder, selected. Type a
name for this folder, and then press the ENTER key.
Adding Documents to a Category

Follow the instructions below to add documents to a category:
1. Select a document or a set of documents from your local file system.
2. Copy the document or a set of documents to a category in the Web Folder
using drag and drop.
Deleting Categories and Documents

Follow the instructions below to delete categories and documents:
1. Select the categories and documents to be deleted.
2. Press the DELETE key on your keyboard and click the OK button to confirm
the deletion.
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. This fails because
the content of the tag category is read-only.
• If the document in the category is locked by another user.
• If you do not have delete permission to a child category of this category.
• If you do not have write permission to a document stage within the category.

160
Editing Documents
You must manually lock the documents in TIBCO XML Canon in order to
download them for updates, because Windows Web Folder does not provide a
lock mechanism.

1. Lock the document you want to edit by following the steps described in
Locking and Unlocking Documents on page 94.
2. Open the Web Folder to select the locked document and copy this document
into a local directory.
Do not double click a document for editing. Instead, lock the document using the
TIBCO XML Canon web interface and then download it using the Web Folder
before making any modifications.
3. Edit the document on your local file system.

4. Copy the modified document from the local directory to its original location
in the Web Folder to replace the old, unedited document.
5. Unlock the document 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. See
Using TIBCO XML Canon with WebDAV Clients on page 155 for more
information.

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 Designer allows for check-out and check-in of TIBCO
ActiveMatrix BusinessWorks projects, as well as metadata updates of project
documents. With this integration, TIBCO XML Canon servers as an excellent
source control repository of TIBCO ActiveMatrix BusinessWorks projects.
Opening New Projects in Designer

Follow the instructions below to open a new project in TIBCO Designer:
1. Open TIBCO Designer and select New Empty Project.
2. Click the XML Canon tab in the Save Project dialog (see Figure 103).
Figure 103 The XML Canon Tab in TIBCO Designer
3. Setup a project by filling in the following fields.

— 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. Follow the
format:
http://<hostname>:<portnumber>/<categoryPath>.
where <categoryPath> is the location where you want to save the new
TIBCO XML Canon project. See Specifying URLs in WebDAV Clients on
— Username and Password — A valid username and password for TIBCO
XML Canon.
— TIBCO messaging encoding — The character encoding for messaging (for
example, ISO8859-1 or UTF-8).

162

5. Select Multi-User from the menu bar and click the Check In Changes option.
6. 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. Open TIBCO Designer and select Open existing project.
2. Click the TIBCO XML Canon tab in the Open Project dialog.
3. Click Browse at the right of the TIBCO XML Canon category field.
4. Specify the URL of the TIBCO XML Canon server (for example, canon:8080)
and click the Connect button.
5. Enter a valid TIBCO XML Canon username and password.
6. Browse to the project folder and click the Select Folder button.
8. Follow the instructions in the Checking-in Changes section to check in your
project for the first time.
Checking-out Project Resources for Editing

When using TIBCO XML Canon as a version control system for TIBCO
ActiveMatrix BusinessWorks projects, you cannot edit project resources before
you check-out the resources.
Follow the instructions below to check-out a resource:
1. Select the resources you want to change in the project tree.
2. Select Acquire-Check out Resource from the resource’s right click menu or
the Multi-User menu.
When checking-out resources, you must check-out a folder before you rename,
move, delete, or edit the folder.

|
Checking-in Changes
Once you update your project, you can apply your changes to the project in
TIBCO XML Canon during check-in.
When you check in a project (or one of its resources), you can add metadata to the
modified project documents or to new documents that have been created during
the check-out. 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.
You must synchronize the project after you check-in your updates in order to
prevent synchronization conflicts that can later cause check-out difficulties.
Follow the instructions below to check in your changes to TIBCO XML Canon:
1. Select Multi-User from the menu bar in TIBCO Designer.
2. Click Check In Changes to open the TIBCO XML Canon Check In dialog.
TIBCO Designer displays any document that has been added moved,
modified, or deleted in this dialog.
Figure 104 Checking-in Documents with TIBCO Designer
3. Select a document and click the Properties button to specify the document
properties. The XLM Canon Properties dialog box opens (see Figure 105).
Figure 105 The XML Canon Properties Dialog

164
4. Add metadata to this document by filling in the fields:

— Current Version # — One increment higher than the previous version.
— Comment — Any comments on the current version. This maximum length
of this field is 256 characters.
— Revision label — A string value to specify this revision.
— Stage — The desired stage of the document in TIBCO XML Canon.
5. Click OK to return to the XML Canon Check In dialog box, shown in
Figure 104. Repeat step 3 and step 4 until you have finished specifying all
desired properties.
6. Click Check in selected to check in only the selected documents, or click
Check in all to check in all documents.
Synchronizing a TIBCO ActiveMatrix BusinessWorks Project

Synchronization obtains the latest files for a particular project. Use
synchronization to:
• Monitor which files have been added, moved, modified, or deleted.
• Synchronize all files or select specific files for synchronization.
You need to synchronize your project often to ensure your project reflects the
changes made by other users.
Follow the instructions below to synchronize a TIBCO ActiveMatrix

BusinessWorks project:
1. Select the project from the Project tab in TIBCO Designer, then click
Multi-User from the menu bar.
2. Click Synchronize Project to open the synchronization panel (see Figure 106).

|
Figure 106 Synchronizing a BusinessWorks Project
3. Click the Synchronize all button to synchronize all project files, or click the
Synchronize selected button after selecting a file or a set of files to
synchronize.
During the synchronization process, TIBCO Designer will display any
conflicts it discovers along with potential solutions.
Additional Notes
Because TIBCO XML Canon automatically treats all resources in a TIBCO
ActiveMatrix BusinessWorks project as a part of the revision control system, the
Add Resource to RCS menu item in Designer’s Multi-User menu is deactivated
when you are using TIBCO XML Canon.
For more information on using TIBCO ActiveMatrix BusinessWorks with TIBCO
XML Canon, 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.

166
Using XMLSpy as a WebDAV Client
Altova XMLSpy is a popular development environment for XML. Because it is

WebDAV-enabled, XMLSpy can serve as WebDAV client for TIBCO XML Canon.
From XMLSpy, users can download documents from and upload documents to
the TIBCO XML Canon server. This section provides instructions on how to use
Altova XMLSpy with TIBCO XML Canon.
Opening Documents from TIBCO XML Canon

Follow these steps to open a document from TIBCO XML Canon in Altova
XMLSpy:
1. Start XMLSpy.
2. Select Open from the File menu (or press Ctrl+O) to launch the Open dialog.
3. Click the Switch to URL button at the bottom of the Open dialog, as shown in
Figure 107.
Figure 107 XMLSpy Open Dialog — Switch to URL

Using XMLSpy as a WebDAV Client 167
|
4. Enter your TIBCO XML Canon information in the fields:

— User and Password — Enter your TIBCO XML Canon user name and
password.
— If desired, check the "remember password between application starts" box.
— Available Files Server URL — your TIBCO XML Canon server URL, using
the format:
http://<server_host>:<port_number>
For example, http://xmlcanon:8080. See Specifying URLs in WebDAV

Clients on page 153 for more information.
5. Click Browse to browse categories in TIBCO XML Canon.
If you did not provide your username and password before clicking Browse
button, XMLSpy prompts you with an Enter Network Password dialog. Enter
your TIBCO XML Canon credentials to continue.
The Open URL dialog should display the TIBCO XML Canon category tree
with all of the resources stored on the server, as shown in Figure 108.
Figure 108 The TIBCO XML Canon Category Tree in XMLSpy
6. Expand one of the categories in TIBCO XML Canon to browse its contents,
then select a document (such as XSD or WSDL).

168
7. Double-click a document to open it in XMLSpy.
If you click Open rather than double-clicking the document, you must:
— Select the document in the XMLSpy browser to display its fully qualified
WebDAV URL in the File URL field, as shown in Figure 108.
— Replace (escape) all spaces in the File URL (which gives the WebDAV path)
with %20.
Editing Documents
If you use XMLSpy to edit TIBCO XML Canon documents, you must use the lock
and unlock functions provided in the TIBCO XML Canon web interface, because
XMLSpy does not provide a check-out and check-in function.

Follow the instructions below to use Altova XMLSpy to edit a document that is
stored in TIBCO XML Canon:
1. Lock the document in TIBCO XML Canon using the web interface. For
detailed instructions, see Locking and Unlocking Documents on page 94.
2. In XMLSpy, open the document and make the desired changes. See Opening
Documents from TIBCO XML Canon above for more information about
opening documents in XMLSpy.
3. Save the edited document as the same URL in XMLSpy.
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.
4. Unlock the document in TIBCO XML Canon using the web interface. For
detailed instructions, see Locking and Unlocking Documents on page 94.

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. In XMLSpy, open the document that you would like to save to TIBCO XML
Canon.
2. Select Save As… from the File menu to launch the Save As dialog.
3. Click the Switch to URL button at the bottom of the Open dialog, as shown in
Figure 107 on page 166.
4. Enter your TIBCO XML Canon information in the fields:
— User and Password — Enter your TIBCO XML Canon user name and
password.
— If desired, check the "remember password between application starts" box.
— Available Files Server URL — your TIBCO XML Canon server URL, using
the format:
http://<server_host>:<port_number>
For example, http://xmlcanon:8080.

5. Click Browse to browse categories in TIBCO XML Canon.
If you did not provide your username and password before clicking Browse
button, XMLSpy prompts you with an Enter Network Password dialog. Enter
your TIBCO XML Canon credentials to continue.
The Open URL dialog should display the TIBCO XML Canon category tree
with all of the resources stored on the server, as shown in Figure 108 on
page 167.
6. Select a category from the TIBCO XML Canon category tree, or click New
Folder to create a new category.
When you select a target category, its WebDAV path appears in the File URL
field.

170
7. In the File URL field, append the document name to the WebDAV path. For
example, to add the document alpha.xsd to a category, update the File URL
http://xmlcanon:8080/MyProject/Sample_01/XSDs/
to read
http://xmlcanon:8080/MyProject/Sample_01/XSDs/alpha.xsd
The WebDAV path shown in the File URL may not contain spaces. If the
WebDAV path or document name includes spaces, you must replace each
space with %20.
8. Click Save to save the document to the TIBCO XML Canon server.
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. Therefore, you must
add the metadata through the DAV tab of your TIBCO XML Canon home page
immediately after you update or upload your documents. See Using TIBCO XML
Canon with WebDAV Clients on page 155 for more information.

| 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 172

• Managing Categories, page 173
• Cloning Categories, page 176
• Purging Deleted Categories and Documents, page 177
• Controlling Non-Authenticated URL Access to Documents, page 181
• Analyzing Documents for Components, page 182
• Understanding Permissions, page 183

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.
• Configure the stage permission in the role configuration page.
If you are an administrator, you can control access levels to an XML project with
categories permission. For example, you can create multiple child categories in a
project category, where each category relates to a different section of the project.
You can also group developers into different roles according to the section or
category they work on, and then grant each role and category a different set of
permissions. As a result, different developers working on different sections will
have a different set of permissions.
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. Usually, you
will set more restrictions as the level of the stage goes higher. 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. For more
information on administrating documents via stages, see Chapter 14, Configuring
Stages, on page 229.
You can specify which XML documents are made public from the development
stage to the publishing stage. This can be achieved by configuring the category
and the stage permissions for the default Web role (an un-authenticated role). See
Controlling Non-Authenticated URL Access to Documents on page 181 for more
information.
The roles, categories, and stages permissions in TIBCO XML Canon provide an
administrator with an easy and powerful mechanism to control document access.
For more information on permissions and roles, see Chapter 12, Configuring
Roles, on page 195.
This chapter also discusses cloning and purging which are two important
functions related to document administration.

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.
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, but which includes some additional
functions.
• The Recursive Unlock button (available to Administrators only) removes all
locks on documents within the category. If a document has been locked by
another user, Recursive Unlock removes restrictions on the document.

174
• The Clone... button enables you to clone an entire category with all its
sub-categories, documents, metadata, and history. For more information, see
Cloning Categories on page 176.
• The Statistics link provides the statistical details of a category, including the
number of sub-categories and documents.
• The buttons and settings in the Role Permissions section enable you to set
category permissions. See Configuring Category Permissions below for
details on these options.
See Using Categories on page 48 for more details on the Category Details panel.
Configuring Category Permissions

Document access can be controlled by configuring category permissions. 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:
\
2. Select a category from the category browser to open its Category Details
panel.
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.

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

176
Cloning Categories
An administrator has the ability to clone a category. This means that TIBCO XML
Canon creates an exact copy of the category including all its contents (all
properties and permissions of child categories, all properties, histories, and tag of
documents, and all child categories and documents under the cloned category).
Many source code management systems using cloning, which is analogous to a
branching mechanism. However the difference between cloning and branching
are:
• A clone must be accessed via a new path.
• Data is copied rather than shared.
Cloning helps you to retrieve a project at an earlier stage by saving the project at
that particular point. You can also create a development template and clone the
template in order to start a new development branch.
Follow the instructions below to clone a category:
2. Select a category to be cloned from the category browser.
3. Click the Clone... button.
4. Click the OK button in the pop-up dialog.

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

Purging Deleted Categories and Documents 177
|
Purging Deleted Categories and Documents
After deletion via the web interface or a WebDAV client, categories and
documents are moved to a special holding area of the TIBCO XML Canon
repository. Use the purge function to remove these categories and documents
completely from the repository.
• Only administrators have the ability to perform the purge function.
• An administrator can only purge documents within the Deleted holding area.
• The document will be assigned with a Delete tag when it is ready to be
purged.
For more information on how documents are deleted, see Deleting Documents on
page 93.
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.
• Remove documents with the Delete tag to reduce TIBCO XML Canon
overhead (such as disk space, memory use, 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.
We recommend regular purges to maintain system health.
Purging
Click Configure > Policies from the Administrator menu to open the Policies
page (see Figure 111).
Figure 111 The Policies Menu Bar in TIBCO XML Canon

178
View or perform the following options within the Policies page:

• General Policies Configuration
• Authentication Configuration (Internal, LDAP, and TIBCO Administrator)
• Installation information
• Purge information and functions
• TIBCO XML Canon server status and logs
For more information on administering policies, refer to Chapter 15, Configuring
Policies, page 239.
Purge Tab Select the Purge tab to open the Purge View.
Figure 112 Purge Options
There are three purge options:

• Purge Untagged permanently removes all documents and categories that do
not have associated delete tags.
• Purge All permanently removes all deleted documents and categories,
regardless of whether tags are assigned. Use this option to remove all deleted
resources.
• The Purge selected link opens a list of purgeable resources. You can then
select those resources you wish to delete permanently. See Purging Selected
Documents below.
Confirmation After purging resources using the Purge All or Purge Untagged buttons, a
confirmation message similar to the one shown here prints, indicating the number
of documents and categories purged:

Purging Deleted Categories and Documents 179
|
Purging Selected Documents

The Purge tab contains two lists of deleted resources, as shown in Figure 113.
• Purgeable resources
• Deleted but not purgeable resources
Figure 113 Purging Selected Documents
When all deleted documents have already been purged, this panel displays only
the message, No resources available for purging.

180
Purgeable Resources
Documents ready to be permanently deleted are listed in the purgeable resources
area.
1. Check the checkbox next to a document to select it for purging.
Alternately, you can click the Select All button to select all documents for
purging, or click Select None to deselect all documents.
2. Click the Purge Selected button to purge the selected documents.
A confirmation dialog box is displayed.
Purging a large number of documents from the repository is a time consuming

operation. It may take several minutes to complete.
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. These metadata
must be removed before the purge process.
The administrator must have the assign, reassign, and remove tags permission to
remove these tags. For more information on removing tags, see Removing Tags on
page 145.
Documents will move to the Purgeable Resources area and are ready to be purged
after the removal of the additional metadata. Follow the procedures described in
Purging Selected Documents on page 179 to permanently delete these documents
from the TIBCO XML Canon repository.
The Purge All button, available in the initial Purge Options screen, overrides this
restriction and deletes all resources, including those listed as not purgeable.
Restart
Some purge-related data cannot be removed from the database while the XML
Canon server is running. Following a purge, these data are removed only at
startup.
You need to restart the TIBCO XML Canon service or daemon to perform the final
clean up and update process. For example, 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.

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, the program is given the same access levels as a Web
user. 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.
The administrator has the ability to turn off the URL access using a policy,
regardless of the existence and placement of the Web user. For further
information, see HTTP Addressability in General Policies on page 241
Read permission is required for a Web user to access documents.

If the Web user role has read permission to view documents stored in category A
and stage A, but does not have read permission to view documents stored in
category B and stage B, then the role only has the ability to view documents in
category A and stage A, not category B and stage B.
A web role with the CONNECT capability has the read permission to view
documents in all categories and stages by default. However, 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. Therefore, an
administrator controls the visibility of categories and documents for the Web user.
For information on Web users and tagging, refer to Tags and Authentication on
page 141.

182
Analyzing Documents for Components
TIBCO XML Canon has the ability to analyze schemas, DTDs, WSDL files, and
TIBCO ActiveMatrix BusinessWorks Process Definition files. 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.
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.
Follow the instructions below to perform a document analysis:
1. Click Browse > Categories to open the category browser.
2. Select a document from the category browser to open its document details
page.
3. Click the Analyze button at the bottom of the document details page.

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

tags, reassign tags to documents and categories, and remove tags.
Users with membership in multiple roles are granted a combination of the highest
permissions from each role. As a result, a user with multiple roles may have
greater permissions than any single role grants.
These permissions settings are described in more detail in Role Permissions on
page 196. See also Changing Default Permissions on page 207.

184
Default Role Permissions

When a new role is created, the default permissions settings are None, meaning
that role members do not have access to view or edit TIBCO XML Canon
categories and documents. To grant role members access, an administrator must
assign permissions in two places:
• In the role details page. Here an administrator grants role members tagging
permissions, stage permissions, and default category permissions. At a
minimum, each role must have read permission to at least one category and
one stage.
• In the category details page. Here an administrator can grant permissions
specify to the category to each configured role in TIBCO XML Canon.
Permissions entered for a role in the category details page supercede default
category permissions settings from the role details page.
Default User Permissions

A new user has no view or edit permissions until the user is assigned to a role.
Although the administrator is prompted to chose a role during user creation, it is
possible to create a new user without assigning a role. Similarly, an administrator
can remove a user from all roles, or deactivate all roles which the user is a member
of. The result is the same: the user has no roles, and therefore no permissions.
When this happens, the user cannot log in to the TIBCO XML Canon web
interface.
Portal Users Portal Users are the exception to this rule. By default, portal users are assigned to
the Portal role, which has read-only permissions to all categories. However, as
with any other role, an administrator can change the defaults Portal role
permissions by editing the role and category details pages.
For more information on how portal users are created, see Creating Portal Users
on page 223.
Default Administrator Permissions

By default, the Administrators role has read, write, and delete permissions for all
categories and stages. However, administrators do not have remove permissions
for tags.
In order to give administrators the tag remove permission, navigate to the
Administrator role details page and edit the Tagging Permission field. See
Changing Default Permissions on page 207 for more information.

| 185
Chapter 11 Administering Namespaces
This chapter describes namespace administration which can only be accessed by

an administrator in TIBCO XML Canon.
Topics
• Namespace Administration Overview, page 186

• Adding Namespace Presentations, page 189
• Notes on Building XSLT Stylesheets, page 190
• Managing DTD DOCTYPE Public IDs, page 193

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.
• The ability to edit DTD Doctype public IDs.
Namespace Presentation
When browsing namespaces, Administrators have access to an additional tab, as
shown in Figure 114.
The Presentation tab enables a TIBCO XML Canon administrator to introduce
namespace presentations. Namespace presentations are XSLT-defined detailed
views for documents which belong to a particular namespace. XSLT stylesheets
can be used to define a customized view for a document in addition to its
standard detailed views (XML view, ProcessDOC, and SchemaDOC) which are
provided by TIBCO XML Canon. You can access namespace presentations in the
same way you access the standard detailed views in a document detail page. For
more information on viewing documents, see Viewing Document Content on
page 98.
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. The Add Detailed View
area is where additional presentations will be added.
For more information, see Adding Namespace Presentations on page 189.

Namespace Administration Overview 187
|
DTD Doctype Public IDs

Administrators also have access to the Doctypes button, located at the bottom of
the namespaces browser, as shown in Figure 115.
Figure 115 Administrators — Namespace Browser
Instance documents which use a public ID in the DOCTYPE must include a

resolvable system ID. Otherwise, they will be considered as invalid by the TIBCO
XML Canon validation tool.
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. The DOCTYPE list
in TIBCO XML Canon will ease this process and make this change in a single,
centralized place throughout the XML development process without tracking
instance documents.
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. An administrator also has the ability to specify the access path
of a DTD that each public ID points to in this page.
After the validation of an instance document which uses a public ID in the
DOCTYPE is validated, TIBCO XML Canon will attempt to resolve this public ID
according to the method defined in the stage configuration (see Chapter 14,
Configuring Stages, on page 229 for more information). If you set the value of
Namespace Resolution to Namespace Only, 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.

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

Adding Namespace Presentations 189
|
Adding Namespace Presentations
Follow the instructions below to add a namespace presentation:

1. Create an XSLT stylesheet for your intended namespace.
2. Upload the XSLT stylesheet into TIBCO XML Canon (see Uploading
Documents on page 89).
3. Validate the document (see Validating Documents on page 101)
4. Click Browse > Namespaces from the menu bar to open the namespace
browser.
5. Select a namespace in the namespace browser to open its namespace details
page.
6. Click the Presentation tab.
7. Click the Lookup... button in the Add Detailed View area.
You will see a pop-up window with a list of all candidate XML stylesheets.
They represent different styles of the namespace display. TIBCO XML Canon
will display XSLT files in the Uses tab of the namespace only.
The detailed view always uses the latest revision of the document. Therefore, it is
fine to make revisions to an XSLT stylesheet which is used for a namespace
presentation.
8. Select a validated XSLT stylesheet from the list.

9. Name the namespace presentation in the Detailed View Name field.
10. Click the Add view button.
You will see the newly created namespace presentation in the Available Detailed
Views area. For more information on viewing documents, see Viewing Document
Content on page 98.
Every user has the ability to view the namespace presentation in the document
details page regardless of the permission assigned to the XSLT stylesheet.

190
Notes on Building XSLT Stylesheets
This section provides information on building your own namespace presentation

XSLT stylesheets in TIBCO XML Canon. By reading this section, you will gain a
sophisticated understanding of how TIBCO XML Canon applies namespace
presentation XSLT stylesheets to XML documents.
Review this section before you start building your XSLT stylesheet for namespace
presentations.
XSLT Processor
TIBCO XML Canon uses Xalan 2.7.0 as its XSLT processor. It allows you to take
advantage of certain features that are specific to Xalan, such as the extension
functions. See http://xml.apache.org/xalan-j/ for more information.
Namespace Presentation Parameters

When you select a namespace presentation in the Detailed Views area of the
document details page, 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. See
Table 13 for more information on these parameters:
Table 13 Namespace Presentation Parameters
Parameter name Meaning

xmlcanon.user.name The username of the user for detailed view
access.
xmlcanon.user.full.name The full name of the user for detailed view

access.
xmlcanon.source.file.name The name of files listed in the detailed view.
xmlcanon.source.file.folder The category path of the file in the detailed

view.
xmlcanon.lock.user.name The name of the user who locked the

document.
xmlcanon.lock.user.full.name The full name of the user who locked the

document, if any.

Notes on Building XSLT Stylesheets 191
|
Table 13 Namespace Presentation Parameters
Parameter name Meaning

xmlcanon.lock.user.email The email address of the user who locked the
document, if any.
xmlcanon.stylesheet.folder The stylesheet category. You will use this to

reference stylesheet documents and image
files from the generated HTML.
Referencing Other Stylesheets

Do not use absolute URLs when referencing other stylesheets through
xsl:include or xsl:import. These two elements support absolute or relative
category paths in TIBCO XML Canon.
Reference the same stylesheet within a category:
• The two examples below are supported:
<xsl:include href="/XSLT/mystylesheet.xsl"/>
<xsl:include href="mystylesheet.xsl"/>
• The example below is not supported:

<xsl:include href=
"http://www.example.com/XSLT/mystylesheet.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.
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. Be aware of this limitation if you are going to include
external references such as images or stylesheets.
Caching
TIBCO XML Canon does not cache the results of namespace presentations. If your
XSLT stylesheets are too complex or the documents the users want to view are too
large, the namespace presentation will not respond.
Increase the available memory for the TIBCO XML Canon JVM (Java Virtual
Machine) if this happens. See General Policies on page 241 for more information.

192
Error Documents
The XPath function document() always returns a document whether there are
errors or not. You will get different types of errors while importing documents.
For example, an error document will be generated (as shown below) if the target
document was not found:
<xce:errorDocument
xmlns:xce="http://www.example.com/namespaces/ErrorDocument">
<xce:errorCode>FILE_NOT_FOUND</xce:errorCode>
<xce:errorParameter>FileName.xml</xce:errorParameter>
</xce:errorDocument>
The potential error codes and their descriptions are listed in Table 14.
If you do not have read permission to a document, document() will also return an
FILE_NOT_FOUND error.
Table 14 Error Codes
Error code Descriptions

FILE_NOT_FOUND The target file was not found.
Parameter (1): file name.
IO_EXCEPTION An unexpected problem occurred during file access.

Parameters (2): file name, error message.
PARSE_EXCEPTION A parsing error occurred. The error message

parameters indicate the problem area.
Parameters (5): public ID, system ID, line number,
column number, error message.
SAX_EXCEPTION A generic parsing problem occurred (no specific

location information is provided).
Parameters (2): file name, error message.

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. Click Browse > Namespaces from the menu bar.
2. Click the Doctypes button in the namespace browser to open the DOCTYPE
Listing panel.
3. Specify the access path of DTD files for each public ID displayed in the page
for clarification. 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. 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://.
4. Configure your stages by choosing the Namespace only option or the
Namespace then location option from the namespace Resolution drop-down
list. See Configuring Stages on page 236 for more detailed instructions.

194

| 195
Chapter 12 Configuring Roles
This chapter describes role management and configuration.
Topics
• Roles Overview, page 196

• Default Roles, page 199
• Adding New Roles, page 202
• Managing Existing Roles, page 205
• Assigning LDAP Users to Roles, page 209
• Managing TIBCO Administrator Roles, page 212

196
| Chapter 12 Configuring Roles
Roles Overview
Roles determine user access levels to functions and features when a user connects
to TIBCO XML Canon. Different users will have different permissions for specific
categories or stages depending on their roles. A role will either be assigned with
administrator capabilities or connect capabilities.
• ADMINISTRATOR capabilities include complete access to the TIBCO XML
Canon repository and administrative functionalities.
• 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.
Role Permissions
There are three kinds of permissions in TIBCO XML Canon: category permissions,
stage permissions, and tag permissions, as described in Understanding
Permissions on page 183.
These permissions are configured in the role details panel, shown here:
Figure 117 The Role Details Panel — Permissions

Roles Overview 197
|
Category and Stage Permissions

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

198
Tag Permissions
Tag permissions grant different levels of tag management to a role in TIBCO XML
Canon. It is role specific rather than category or stage specific. Each role is
assigned with specific tag permissions at the time of configuration. For more
information about tags, see Chapter 8, Using Tags, on page 130.
An administrator has the ability to assign one or a combination of the tag
permissions to each role in the role details page.
• Assign — Permits the role to create a new tag and assign it to categories or
documents.
• Reassign — Permits the role to assign an existing tag to a different revision of
the same document.
• Remove — Permits the role to delete a tag from a category or document. Note
that this permission is not granted to any role by default. To delete tags, an
administrator must first grant the remove permission to the appropriate role.
Users
Users in TIBCO XML Canon will either belong to a single role or multiple roles.
Single role users will inherit all permissions assigned to that role. Multiple roles
users have the highest permission level of these roles which reflect a combination
of their access to different stages, categories, and tags.
Adding users to multiple roles is an effective way to establish a unique set of

permissions without having to define a new role.
Depending on the authentication settings of your TIBCO XML Canon server,

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.
• 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. If no roles are assigned to users after the
LDAP queries, it will use the LDAP default 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.

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

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

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. 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. These permissions are viewed and
changed in the role details page, and category-specific permission changes are
made in the Category Details panel.
An administrator has the ability to modify, deactivate, and delete this role.

202
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, follow the instructions in this section to add a new role.
• LDAP — If TIBCO XML Canon is using an LDAP server for authentication,
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.
• TIBCO Administrator — If TIBCO XML Canon is using TIBCO
Administrator for authentication, follow the instructions in Authentication
Configuration on page 244 to add TIBCO Administrator roles, then configure
them as a native role in TIBCO XML Canon.
For more information on authentication settings, see Authentication
Configuration on page 244.
To add a new role to TIBCO XML Canon:
1. Click Configure > Roles from the menu bar to open the Add New Role page.
2. Click the Add New Role button at the bottom of the Roles panel in the
left-hand frame. You will see the Add New Role page in the right-hand frame.
Figure 118 Add New Role

Adding New Roles 203
|
3. Enter a role name in the Name field.

Role names must be unique and case-insensitive. They cannot include special
characters except hyphens, underscores, colons, and full stops.
4. Choose a default stage for new document uploads from the Initial Stage
drop-down list. This enables all members under this role to save the new
document in the default stage in TIBCO XML Canon.
If you deactivate or delete a role’s default initial stage that is not configured
with a transition into another, the role will not be able to upload documents.
5. Select the ADMINISTRATOR option for an administrative role or the

CONNECT option for a regular role from the Capability drop-down list.
6. Select the appropriate permissions from the three drop-down lists:
— Default Stage Permission — The default initial permission for stages.
— Default Category Permission — The default inti al permission for
categories.
— Tagging Permission — The default inti al permission for editing tags.
For detailed information about each permission, see Roles Overview on
page 196.
7. If you are going to apply the permissions set in the Default Stage Permission
drop-down list to all stages, then ignore the Stage Specific Permissions area.
Otherwise, select a different set of permissions from each stage’s drop-down
list individually.
Unlike the overall stage permission you set in step 6, The Stage Specific
Permissions area allows you to grant permission to each stage individually.
8. Click the Add role and set members >> button to switch to the Membership
tab.

204
Figure 119 The Membership
Because this is a new role, its Current Members area is initially empty. The Not
Members area initially displays all users created by TIBCO XML Canon.
9. Add members to the role by checking the boxes in front of their usernames in
the Not Members area.
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.
10. Click the Update button. You will now see all members you selected in the
Current Members area.

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

206
Activating and Deactivating Roles

The Roles panel in the left-hand frame is divided into two sections: the Active
section and the Inactive section. 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. In other words, users in the Inactive
role list are deactivated and do not have any role permissions. They cannot log on
to TIBCO XML Canon unless they have an account in the active roles list.
Newly created roles are active by default.
Follow the instructions below to activate or deactivate a role:

1. Click the role you want to activate or deactivate in the Roles panel.
2. Select the Yes or No radio button to activate or deactivate the role in the
Active selector.
3. Click the Update button at the bottom of the role details page.
Deleting Roles
Web, Portal, and LDAP Default are three default roles which can only be
deactivated but cannot be deleted.
Use the deactivate and reactivate functions to manage roles rather than delete and
create roles repeatedly.
Follow the instructions below to delete a role:

1. Select a role to delete in the Roles panel.
2. Click the Delete button at the bottom of the role details page.

Managing Existing Roles 207
|
Changing Default Permissions

Follow the instructions below to change role permissions:
1. Select a role from the Roles panel.
2. To modify the role settings, update the fields described here:
— Capability — Select the role capability as ADMINISTRATOR or
CONNECT.
Changing role capability does not set the corresponding permissions

automatically. You must manually set the role permissions in all the
permission drop-down lists.
— Default stage permission — Change the default stage permissions for the
role. Note that this permission does not change the role’s stage permission
if the role already has stage-specific permissions.
— Default category permission — Change default category permissions for
the role. Note that this permission does not change the role’s categories
permission if the role already has category-specific permissions.
— Tagging permission — Change tag permissions for the role. This
permission does not affect tags that have been previously assigned by
members of this role.
Changing Role Members

Follow the instructions below to change members of a role:
1. Select a role to be changed from the Roles panel.
2. Click the Membership tab (see Figure 121).
Figure 121 The Membership Tab

208
The Membership tab provides two lists: a list of users who are members
currently and a list of users who are not members. You can also view LDAP
users who logged on to the server recently in the Current Members area. They
were assigned to the role based on the LDAP query of the role.
Click send email in the Current members title bar to send emails to all role
members.
3. Uncheck the checkboxes in front of member names in the Current Members

area to remove members from the role then click the Update button. You can
click the Update button in either area (the Current Members area or the Not
Members area).
4. Check the checkboxes in front of member names in the Not Members area to
add members to the role, then click the Update button. You can click the
Update button in either area (the Current Members area or the Not Members
area).
Changing Category- and Stage-specific Permissions

You are allowed to change a role’s category-specific permissions in the Category
Details panel. See Managing Categories on page 173 for more information.
You are allowed to change a role’s stage-specific permissions in the role details.
Follow the instructions below to change stage-specific permissions:
1. Click the role to change from the Roles panel.
The Stage Specific Permissions area in the role details page lists each stage
individually with their own permission drop-down lists.
2. Select a permission set from the corresponding drop-down list to change the
role’s stage permissions for each stage.

Assigning LDAP Users to Roles 209
|
Assigning LDAP Users to Roles
When TIBCO XML Canon is configured with LDAP authentication, users can log
in with their LDAP username and password. These users are not in the XML
Canon user list. In this case, TIBCO XML Canon uses LDAP queries to assign an
user with one or more TIBCO XML Canon roles.
After an LDAP user successfully logs in to TIBCO XML Canon for the first time,
TIBCO XML Canon automatically creates an account for the user. An
administrator will manually modify the role memberships for users.
Role Details Page in LDAP Authentication Mode

If your TIBCO XML Canon server uses LDAP authentication, the role details page
for each role will look similar to Figure 122. You will be able to specify an LDAP
query and a query context for each role in the role details page.
Figure 122 Role Details Page in LDAP Authentication Mode

210
When an LDAP login occurs, all queries with their accompanying query contexts
are evaluated. The user is assigned to a role if the result of the query evaluation is
true. The number of roles assigned to a user depends on the number of true
responses after the LDAP query evaluation. If none of the LDAP query
evaluations return true, 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. After that, TIBCO XML Canon authenticates the user
using its own authentication mechanism.
Configuring LDAP Queries

Follow the instructions below to configure LDAP role queries:
1. Select the role to be configured from the Roles panel.
2. (Optional) Specify your query context in the LDAP query context field. TIBCO
XML Canon uses this value to filter the LDAP query.
If you specify a value in the LDAP query context field, make sure that you
specified a valid organization unit within the organization root when you
configured LDAP authentication for TIBCO XML Canon. For more
information, see Authentication Configuration on page 244.
3. Specify the query string in the LDAP query field.

LDAP queries (string representations of LDAP search filters) are defined by
the Network Working Group Request for Comments 2254 (RFC 2254). Read
the documentation in http://rfc.net/rfc2254.html for complete
information on search filters and syntax.
Include the (uid={0}) condition in your query string, where variable {0} will
be replaced by the TIBCO XML Canon login username automatically. This
condition ensure that only one user will be returned by the query (see the
example in Figure 123).
Apply the query above on multiple roles to place an LDAP user into multiple
roles.
4. Click the Update button at the bottom of the page.

Figure 123 shows an LDAP query example. 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.

Assigning LDAP Users to Roles 211
|
Figure 123 The LDAP Query Example
Testing LDAP Queries for Roles

In TIBCO XML Canon, you can test your LDAP query configurations using the
Role lookup feature in the LDAP tab of the Users panel. 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.
2. Click the LDAP tab in the Users panel.
3. Enter the username and click the Show button in the Role Lookup field at the
bottom of the LDAP tab.
Rewrite your LDAP queries in the role details pages until you are satisfied
with the lookup result.

212
Managing TIBCO Administrator Roles
When TIBCO XML Canon is configured with TIBCO Administrator

authentication, users will log in to TIBCO XML Canon using their TIBCO
Administrator credentials.
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. You will see these imported roles along with other roles in the Roles panel.
Figure 124 shows a Roles panel after an TIBCO Administrator user logged into
TIBCO XML Canon for the first time. This user belongs to the CanonDev role. You
will see CanonDev and Guests roles from the Active role list. These two TIBCO
Administrator roles are imported when users who belong to these roles log in.
Note that they are both marked with the (T) prefix.
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, except the TIBCO Administrator
users who belong to these roles are unchangeable.
Figure 125 shows the Membership tab of the CanonDev role. Note that the TIBCO
Administrator user, tibuser, in the Current Members area (marked with the (T)
prefix) does not have a checkbox like other TIBCO XML Canon users. Therefore,
you can only add or remove TIBCO XML Canon users under this tab.

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).
TIBCO Administrator roles are imported with permissions equivalent to the

Portal role. You must manually assign their permissions after they are imported.
Importing TIBCO Administrator Roles Manually

Follow the instructions below to manually import TIBCO Administrator roles
from the Policies page:
1. Click Configure > Policies from the menu bar to open the Policy
Configuration page.
2. Click the Authentication tab in the Policy Configuration page.
If TIBCO XML Canon is using TIBCO Administrator for authentication, you
will see the TIBCO Administrator Server Configuration area.
3. Click Manage TIBCO Administrator Roles >>.
A page will display all current roles in TIBCO Administrator.
4. Click the Add button on the right-hand side to add a role. If you want to
remove a role, click Delete.
5. Go to the role configuration page to assign permissions to the added role.

214

| 215
Chapter 13 Configuring Users
This chapter describes user configuration and management in TIBCO XML

Canon.
Topics
• Users Overview, page 216

• Creating a New User, page 221
• Creating Portal Users, page 223
• Managing Existing Users, page 225

216
| Chapter 13 Configuring Users
Users Overview
TIBCO XML Canon supports several user types:

• Normal users, which are created by a TIBCO XML Canon administrator.
• Portal users, 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.
• LDAP users, which are created, authenticated, and managed by an LDAP
server that is external to TIBCO XML Canon.
• TIBCO Administrator users, which are created, authenticated, and managed
by a TIBCO Administrator that is external to TIBCO XML Canon.
Users Panel
TIBCO XML Canon enables you to create new user accounts, view and edit the
profiles of existing users, and deactivate or reactivate users via the users panel.
Click Configure > Users from the menu bar to access the users panel.
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. It is used to configure users in TIBCO XML Canon. You will
see a Normal tab and a Portal tab at the top of the Users panel. You may also see
an LDAP tab or a TIBCO Administrator tab depending on the authentication
setting in TIBCO XML Canon.
Administrator User When you install TIBCO XML Canon, you are prompted to
create an initial administrative account. The administrator user name specified
during installation is also created automatically. This user can be modified,
deactivated, or deleted, but be sure to maintain at least one active user with an
ADMINISTRATOR capability at all times.

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

distinguish from other users during configuration activities. The # character
must be used in front of the username when logging in.

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

Users Overview 219
|
TIBCO Administrator Users

If TIBCO XML Canon is configured with TIBCO Administrator authentication,
the TIBCO Administrator tab will display users who logged in with their TIBCO
Administrator credentials. 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. An administrator can also edit, deactivate, or activate
their role membership.
The administrator can also look up TIBCO Administrator users’ current role
memberships in the Role Lookup area.
The role lookup operation will fail if users who belong to that role are not
currently logged in to TIBCO XML Canon.
Web (Un-authenticated) User

The Web user is created by TIBCO XML Canon for un-authenticated,
programmatic access to TIBCO XML Canon. When an external application or
document makes an URL reference to a document within the TIBCO XML Canon
repository, they will automatically log in to TIBCO XML Canon as Web users.
TIBCO XML Canon provides this unauthenticated access to allow external
sources to access TIBCO XML Canon documents without any credentials.
TIBCO XML Canon deals with Web users internally and does not need to be
recognized by external applications or documents. Web users are shown in the
TIBCO XML Canon user interface in order to allow an administrator to control
unauthenticated external access. For more information on making
un-authenticated URL access to documents, see Accessing Documents via URL on
page 111.

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

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. For more information on LDAP and TIBCO
Administrator users, refer to Authentication Configuration on page 244.
Follow the instructions below to create a user:
1. Click Configure > Users from the menu bar to open the Users panel.
2. 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, as shown here:
3. Enter a username for this new user in the User Name field. Follow the rules
below to create the username:
• This username must be unique.
• Usernames are case-sensitive and must not contain any spaces.
• Do not include the following special characters in the username: ' " ? *
> < ] | = ) & !
• The initial character of the username must not be the # character, because
that character is used as an indicator for Portal users.

222
4. Enter the full name of the user in the Full Name field. This field can contain
spaces.
5. Enter a valid email address for this user in the Email Address field.
6. Specify a password in the Password field follow the rules below:
• Passwords are case-sensitive.
• Do not include the following special characters in the password: ' " ? *
> < ] | = ) & !
7. Re-enter the password to confirm it in the Confirm Password field.

8. Check the checkboxes next to the roles you want to assign to the user in the
Role Membership area.
For more information about roles, see Chapter 12, Configuring Roles, on
page 195.
Web and Portal roles are special roles and cannot be manually assigned to users.
They can only be automatically assigned by TIBCO XML Canon.
9. Click the Add user button.

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

224
4. Enter a valid email address for the user in the Email Address field.
5. Specify a password in the Password field follow the rules below:
• Passwords are case-sensitive.
• Do not include the following special characters in the password: ' " ? *
> < ] | = ) & !
6. Re-enter the password to confirm it in the Confirm Password field.

7. Click the Submit button.
Figure 128 Create a Portal User in the TIBCO XML Canon Portal User Page
After the submission, TIBCO XML Canon will log you in as a portal user. You
will see the portal homepage. To log in at a later time, re-enter the username
and password provided in the TIBCO XML Canon Portal User Page in the
TIBCO XML Canon login page.

Managing Existing Users 225
|
Managing Existing Users
Click on a username in the Users panel to modify existing user profiles. The user
details page enables you to activate or deactivate users and edit users’ details
such as username, full name, email address, and password (see Figure 129).
Deactivated users are listed in the Inactive area of the users panel. These users
will no longer be able to log in to TIBCO XML Canon.
Deactivating an user has an effect similar to that of deleting a user. It is safer to

deactivate a user before deletion in case you need to reactivate the user later.
Figure 129 The User Details Page
Click the Update user button or the Update password button to save changes
after editing the user profile.
LDAP Users The LDAP user details page is uneditable except for the activation or deactivation
and delete functions.

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

Managing Existing Users 227
|
If the LDAP configuration is correct, role results will be shown as shown here:
If the LDAP configuration is incorrect, an error will be reported when you

attempt to look up the roles.
For more information on LDAP authentication, see Authentication Configuration
on page 244.
Because role memberships are dynamically computed when log in, LDAP users
will appear to be members of the role which was assigned to them during their
last login.

228

| 229
Chapter 14 Configuring Stages
This chapter describes stage configuration and management by an administrator.
Topics
• Stages Overview, page 230

• Creating Stages, page 233
• Configuring Stages, page 236

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

When configuring a stage, the administrator selects the stages that a document
can transition to. For example, a document in the Development stage may be able
to transition to Testing, but not to Production.

Stages Overview 231
|
Documents may transition from

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

232
Stages Panel
Click Configure > Stages from the Administrator menu bar.
Figure 131 The Stage Button in the Menu Bar
The Stages browser displays in the left-hand frame, and contains an Active list
and an Inactive list of stages (shown below).
Figure 132 The Stages Browser

Creating Stages 233
|
Creating Stages
Follow the instructions below to create a new stage:

1. Click Configure > Stages from the menu bar to open the Stages panel.
2. Click the Add New Stage button at the bottom of the Stages panel.
The Add New Stage page will appear in the right-hand frame (as shown in
Figure 133).
Figure 133 The Add New Stage Page
3. Specify a stage name in the Stage Name field.

Stage names cannot include special characters with exceptions of hyphens,
underscores, colons, and full stops.
4. Select the radio button yes from the Transition to self option if the documents
will remain in this stage after revision.
If you select the radio button no, the documents must transition out of the
stage after they are updated to a new revision.

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

Creating Stages 235
|
transition into this stage based on this setting. There are three available
options:
— Documents do not need to be well-formed — Any document can
transition into this stage.
— Documents must be well-formed — Only documents that are well-formed
can transition into this stage.
— Documents must be valid — Only valid instance documents and valid
schemas or DTDs can transition into this stage.
When the Documents must be valid option is selected, XML documents

without reference to a schema or DTD are not allowed into the stage because
they are not valid.
7. Select the stage or stages which documents can transition into from the
Documents May Transition To area.
8. Select the stage or stages which documents can transition from in the
Documents May Transition From area.
In Figure 133, documents in the Design stage can transition into the Default,
Development, Production, or Testing stage. They can also transition from the
Deprecated, Development, Production, and Testing stage.
If you are creating stages for the first time, create all stages before configuring
the document transition settings.
9. Click the Add stage button.

After creating a stage, you must also configure role permissions for the stage. See
Changing Default Permissions, page 207 for more information.

236
Configuring Stages
This section describes how to configure stages as an administrator. For

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

Configuring Stages 237
|
Notes on Deleting and Deactivating Stages

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

238

| 239
Chapter 15 Configuring Policies
This chapter describes policy configuration and management.
Topics
• Policies Page Overview, page 240

• General Policies, page 241
• Authentication Configuration, page 244
• Install Tab, page 250
• Server Status, page 251
• Checking Database Consistency, page 252

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.
Click Configure > Policies from the menu bar to open the Policies page.
You can see five tabs at the top of the policies page. A brief description has been
provided below:
• Policies contains the configurable properties of the TIBCO XML Canon server.
See General Policies on page 241 for more information.
• Authentication allows you to specify the way TIBCO XML Canon
authenticates user logins. See Authentication Configuration on page 244 for
more information.
• Install contains the current TIBCO XML Canon installation information.
• Purge enables you to purge documents and categories that have been deleted
by users. Purging frees up space on the database server. See Purging Deleted
Categories and Documents on page 177 for more information.
• Status states the current status of the TIBCO XML Canon server. See Server
Status on page 251 for more information.

General Policies 241
|
General Policies
This section describes the configurable policies in the Policies tab.
Figure 135 The Policies Tab in the Policies Page
There are thirteen policies to specify in this tab. Click on the property’s
corresponding Update button to update the property setting. See descriptions for
each policy below.
Each policy can only be updated by its corresponding Update button.
• 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.

242
• HTTP addressability — Specifies whether external documents or

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

General Policies 243
|
display an error message instead. If a user schedules a report that exceeds the
defined limit, the report will be generated with the maximum number of
documents only and also display an error message.
If the number of documents and components are both over the limits, the
error message will only indicate the number of documents exceeds the limit.
• Reporting limits (components) — Specifies the maximum number of

components in a single report.
If an user attempts to run a report immediately and the number of
components exceeds the defined limit, TIBCO XML Canon will not run the
report and will display an error message instead. If a user schedules a report
that exceeds the defined limit, 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, the
error message will only indicate the number of documents exceed the limit.

244
Authentication Configuration
Authentication configuration allows you to configure the way TIBCO XML

Canon authenticates its users. This will be achieved under the Authentication tab
(see Figure 136). 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.
TIBCO XML Canon first authenticates users as internal users. If the internal
authentication does not produce a match, it will query the LDAP server or TIBCO
Administrator in the Authentication tab.
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, TIBCO XML Canon will use its own authentication mechanism to log in
users who were created and managed in TIBCO XML Canon.
Internal authentication is always available and can be used in conjunction with

either an LDAP server or TIBCO Administrator for authentication.
LDAP Authentication
Follow the instructions below to use an LDAP server for authentication:
1. Select the LDAP Authentication radio button.
2. Click the Update button.
You will see an LDAP Configuration area in the Authentication tab (see
Figure 137).

Authentication Configuration 245
|
Figure 137 The Authentication Tab — LDAP Authentication
3. Specify the host name of the LDAP server in the LDAP Server field.
4. Check the Secure checkbox if the LDAP server uses a secure connection.
If you check the Secure checkbox, the LDAP Server field must begin with
ldaps://.
• Login DN (optional): This option is optional.

• Login DN password: The DN password for the LDAP server. Passwords are
case-sensitive. This is optional and depends on your configuration.
5. Specify the root entry for your LDAP server in the Organization Root field.
Only users under this LDAP root have access to TIBCO XML Canon.
You can click the Suggest button to view the list of candidate organization
roots (see Figure 138).
Figure 138 The List of Candidate Organization Roots

246
6. 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. (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. Use (samaccountname={0}) rather than the default query
(uid={0}) for more accurate results.
— 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.
For example, if you want to limit users who log in to TIBCO XML Canon
by setting their location attribute to Anytown, 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). Read
the documentation in http://rfc.net/rfc2254.html for complete
information on search filters and syntax.
7. Click the Update button at the bottom of the page.
For information on assigning role membership to LDAP users, see Assigning
LDAP Users to Roles on page 209.
Troubleshooting LDAP with Microsoft Active Directory

If you are using Microsoft Active Directory with TIBCO XML Canon and an
LDAP directory, you will receive a message similar to the following:
LDAP: error code 49 - 80090308: LdapErr: DSID-0C09030B, comment:
AcceptSecurityContext error, data 525, v893]
If this happens, you have possibly specified an invalid Login DN or a bad

password. Read the notes below to find a solution to the problem.
Testing Login DN
A login DN works correctly with native Microsoft LDAP applications, but does
not work with LDAP components in TIBCO XML Canon. This is because
Microsoft LDAP applications use non-standard LDAP extensions. Therefore, you
need to test the DN with a third-party LDAP client before you test it with TIBCO
XML Canon. The JXplorer (http://pegacat.com/jxplorer/) is a testing tool that
resolves this problem.

|
If your DN does not work with third-party LDAP clients, see the section below for
the way to conform non-standard DNs to the common LDAP format.
Non-standard LDAP DNs

Microsoft Active Directory allows for non-standard DNs. Try the following
options in the example below:
Example:
Full name: Some User
Login name: suser
Email address: suser@example.com
NT Domain: domain
Options:
• Use the full name of users as the value of the cn= clause for your DN. (For
example, use cn=Some User instead of cn=suser)
• Use the domain name with the login name. (For example, domain\suser or
domain/suser) instead of the typical comma-separated list of LDAP
assignments (such as cn=xxx, dc=yyy, ...)
• Use the email address on its own. (For example, suser@example.com) instead
of a normal LDAP specification.

248
TIBCO Administrator Authentication

Follow the instructions below to use TIBCO Administrator for authentication:
1. Choose the TIBCO Administrator Authentication option.
2. Click the Update button. You will see the TIBCO Administrator Configuration
area appears.
Figure 139 The Authentication Tab — TIBCO Administrator Authentication
3. Select the protocol used by TIBCO Administrator from the Protocol

drop-down list.
4. Specify the TIBCO Administrator server’s host name in the Server field.
5. Specify the port number used by the TIBCO Administrator server.
6. Click the Verify button to complete the configuration.
If the verification is successful, a confirmation message appears in a separate
window. Close this window after reviewing the confirmation.
7. Click the Update button.
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).

|
Figure 140 The Available Roles Page
For more information on managing TIBCO Administrator roles, see Managing

TIBCO Administrator Roles on page 212.

250
Install Tab
The Install tab provides environment information and configuration settings for
the current TIBCO XML Canon installation. Information in this tab in uneditable.
Figure 141 The Install Tab in the Policies Page

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.
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. TIBCO XML Canon will not report document-level or
component-level relationships for a document until it has been analyzed. To
see if a particular document has been analyzed, view the Analyzed metadata
in the document details page for the document.
• Available processors — The number of processors used on the machine
which runs the TIBCO XML Canon server.
• Free memory — The available memory which JVM (Java Virtual Machine)
allocates to TIBCO XML Canon. This JVM runs on the TIBCO XML Canon
server.
• Total memory — The total memory which the TIBCO XML Canon server’s
operating system allocates to the JVM. This is not available to other
applications that runs on the same machine.
• Maximum memory — The maximum memory that the JVM can consume on
the TIBCO XML Canon server.
• Document being analyzed — The name of the document which is currently
being analyzed.
• Log... — Click this link to view a partial record of the application log for
TIBCO XML Canon. You must have access to the TIBCO XML Canon server’s
operating system to view the entire set of log files. This is used as the first
attempt to diagnose problems remotely, but you must not treat it as a
substitute for accessing log files directly.
Perform a database consistency check to ensure your database meets minimum

standards. See Checking Database Consistency on page 252.

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

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).
• Review the server status log in the Status page (see Server Status on page 251
for more information).
• Review the complete application record and access logs in
TIBCO_HOME/xmlcanon/3.2/tomcat/logs/.
• Periodically check the system which runs the database server for available
disk space and memory.

254

COn 255
|
Configuring Custom Properties

COn
Chapter 16
This chapter describes custom properties configuration and management.
Topics
• Custom Properties Overview, page 256

• Configuring New Enumeration Properties, page 258
• Managing Existing Enumeration Properties, page 260
• Adding New Memo Properties, page 262
• Managing Existing Memo Properties, page 263

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. It is an excellent tool to organize and
search for documents and components within TIBCO XML Canon.
There are two types of custom properties:
• Enumerations — A key value pair. You define a value list (often a drop-down
list) and select a value from the list. For example, define an enumeration
called Department with possible values such as Accounting, Architecture,
Engineering, and so on.
• Memos — A key value pair. The value will be free-form text which is similar
to the Comment metadata in documents.
Adding, Removing, and Editing Custom Properties

If you have the write permission to categories, you can assign custom properties
to a document during its initial upload to a category. This is achieved via either
the TIBCO XML Canon web interface or a WebDAV client such as Turbo XML. For
more information, see Uploading Documents on page 89 and Managing WebDAV
Uploads on page 156.
If you have the write permission to both the category and the stage of the
category, you can perform the following functions:
• Add, remove, and edit custom properties via the document details page (see
Updating Document Properties on page 96).
• Add, remove, and edit custom properties to components via the component
details page (see Editing Custom Properties for Components on page 128).
Configuring Custom Properties

An administrator can define new custom properties and manage existing custom
properties in the Custom Properties panel. Click Configure > Custom Properties
from the menu bar to open the Custom Properties panel.
The Custom Properties panel lists all currently active custom properties and
inactive custom properties (see Figure 144). These listed properties are divided
into two sections based on their type: Enumerations and Memos.

Custom Properties Overview 257
|
Figure 144 The Custom Properties Browser
If a custom property is active, it is added to the appropriate documents and

components and its value can be edited by permitted users. If a custom property
is inactive, it is no longer available to TIBCO XML Canon users. However, an
inactive custom property can be reactivated again.
If you deactivate a custom property, it will remain in all documents and

components which have this property until their next upload or update.
Click a property name to open its property details page in the Custom Properties
panel.
• To learn more about adding a new enumeration, see Configuring New
Enumeration Properties on page 258.
• To learn more about configuring and managing enumerations, see Managing
Existing Enumeration Properties on page 260.
• To learn more about adding a new memo, see Adding New Memo Properties
on page 262.
• To learn more about configuring and managing memos, see Managing
Existing Memo Properties on page 263.

258
Configuring New Enumeration Properties
Follow the instructions below to add a new enumeration property to TIBCO XML
Canon:
1. Click Configure > Custom Properties from the menu bar to open the Custom
Properties panel.
2. 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).
Figure 145 The Add New Enumeration Property Page
3. Enter the property name in the Name field.
You cannot change the name of a custom property after it is configured.
4. 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.
If you select the Yes radio button in the Required option set, this custom
property will be required for documents only, even if you selected the
Components option from the Applies To drop-down list.

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. Therefore, do not select
the Yes radio button for these WebDAV clients because it will prevent documents
from uploading.
5. Enter the enumeration entries in the Choices field and press the ENTER key
after each entry to separate them.
Each line in the Choices field represents an enumeration entry. Other
characters such as spaces or tabs will not separate the entry.
6. Choose whether this property will be assigned to documents or components,
or both of them from the Applies To drop-down list.
7. Click the Add Property button to add this property. Otherwise, click the Reset
button to restore all settings to default.

260
Managing Existing Enumeration Properties
Enumeration properties are managed in the property details page. After you have
configured a new enumeration property, you can select a name from the active
custom properties list in the left-hand frame.
It is impossible to change the name of a custom property after it has been

configured.
Follow the instructions below to manage an existing enumeration property:

Properties panel.
2. Select an enumeration name to open its property details page.
Figure 146 The Enumeration Property Details Page
3. Select the No radio button from the Active option set to deactivate the
property.

Managing Existing Enumeration Properties 261
|
5. Select the No radio button if this custom property does not have to be
If you select the Yes radio button in the Required option set, this custom property
will be required for documents only, even you selected the Components option
from the Applies To drop-down list.
WebDAV clients other than TIBCO Designer do not recognize the metadata
extensions of TIBCO XML Canon. Therefore, do not select the Yes radio button for
these WebDAV clients as it will prevent documents from uploading.
6. Select whether this property will be assigned to documents or components, or

both from the Applies To drop-down list.
7. Activate or deactivate existing enumeration entries by selecting the related
radio buttons in the Enumeration Choices area.
8. Enter additional enumeration entries in the New Choices field and press the
ENTER key on the keyboard after each entry to separate them.
Each line in the Choices field represents an enumeration entry. Other
characters such as spaces or tabs will not separate the entry.
9. Click the Update button to update this property. Otherwise, click the Reset

262
Adding New Memo Properties
Follow the instructions below to add a new memo property to TIBCO XML
Canon:
Properties panel.
2. Click the Add New Memo button from the Memos area in the custom
properties panel to open the Add New Memo Property page:
3. Enter a name for this memo property in the Name field. This name cannot
include the following characters: ' " ? * > < ] | = ) & !
You cannot change the name of a custom property after it has been
configured.
property will be required for documents only, even you selected the
extensions of TIBCO XML Canon. Therefore, do not select the Yes radio button for
these WebDAV clients because it will prevent documents from uploading.

7. Click the Add Property button to add this property. Otherwise, click the Reset

Managing Existing Memo Properties 263
|
Managing Existing Memo Properties
Memo properties are managed in the property details page. After a new memo
property has been configured, select a name from the active memo properties list
in the left-hand frame.
It is impossible to change the name of a custom property after it has been

configured.
Follow the instructions below to manage an existing memo property:

Properties panel.
2. Select a memo name to open its property details page (see Figure 147).
Figure 147 The Memo Property Details Page
3. Select the No radio button from the Active option set to deactivate the
property.
property will be required for documents only, even you selected the
extensions of TIBCO XML Canon. Therefore, do not select the Yes radio button
for these WebDAV clients because it will prevent documents from uploading.

264

7. Click the Update button to update this property. Otherwise, click the Reset

| 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.
Topics
• Configuring the Java Virtual Machine on page 266

266
| Appendix A Java Virtual Machine Options
Configuring the Java Virtual Machine
TIBCO XML Canon relies on the Tomcat server, which is contained in a Java
Virtual Machine (JVM). As a consequence of this structure, certain JVM settings
can affect XML Canon performance. For example, the maximum memory
allocation for XML Canon is determined by the JVM.
The TIBCO XML Canon installation process uses the default Java settings, which
are adequate for most users. If you find that the default settings do not meet your
needs, you can use the Tomcat setenv script to modify the JVM options.
After making any changes to the setenv script, you must shutdown and restart
TIBCO XML Canon. See Starting the TIBCO XML Canon Server on page 8 for the
shutdown and restart procedure.
JVM Options
For a full list configurable options, see the Java application launcher
documentation. For Java 1.6, this documentation is available here:
http://java.sun.com/javase/6/docs/technotes/tools/windows/java.html
You can specify values for any of the documented options in the setenv script.
Specify JVM Options

These steps describe how to specify JVM options by modifying the setenv script.
Windows On Windows platforms, use this procedure to modify the setenv script.
1. Stop the TIBCO XML Canon service.
2. Navigate to:
XMLCANON_HOME\tomcat\bin
3. Open the setenv.bat file in an editor.

4. 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. For example, this line specifies a 2048 MB (or
2 GB) memory allocation in the JVM:
set JAVA_OPTS=%JAVA_OPTS% -Xms2048M

Configuring the Java Virtual Machine 267
|
Do not change the initial line of the setenv script. The option settings defined in
this line are required, and must not be modified.
5. Save and close the setenv.bat file.

6. Restart the TIBCO XML Canon service.
Unix On Unix platforms, use this procedure to modify the setenv script.
1. Stop TIBCO XML Canon.
2. Navigate to:
XMLCANON_HOME/tomcat/bin
3. Open the setenv.sh file in an editor.

4. Add a line or lines specifying the new option setting using the syntax:
JAVA_OPTS="$JAVA_OPTS value";export JAVA_OPTS
where value is the option setting. For example, this line specifies a 2048 MB (or
2 GB) memory allocation in the JVM:
JAVA_OPTS="$JAVA_OPTS -Xms2048M";export JAVA_OPTS
Do not change the initial line of the setenv script. The option settings defined
in this line are required, and must not be modified.
5. Save and close the setenv.sh file.

6. Restart TIBCO XML Canon.
Example
Windows This example shows a setenv.bat file that has been modified to increase the
memory allocation to 2 GB (on Windows platforms):
set JRE_HOME=C:\tibco\tibcojre\1.6.0
set JAVA_OPTS=%JAVA_OPTS% -Xms2048M

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, in this case on Unix platforms:
JRE_HOME=/opt/tibco/tibcojre/1.6.0
export JRE_HOME
JAVA_OPTS="$JAVA_OPTS -Xms2048M"
export JAVA_OPTS

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

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

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

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

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

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

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

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

Tib XML Canon User

Enviado por

Dados do documento

Descrição original:

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Tib XML Canon User

Enviado por

Direitos autorais:

Formatos disponíveis

TIBCO XML Canon™

Chapter 2 Running TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7

Chapter 3 Quick Tour of TIBCO XML Canon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15

TIBCO XML Canon User’s Guide

Chapter 4 TIBCO XML Canon Web Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Chapter 5 Categories, Namespaces, and Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

TIBCO XML Canon User’s Guide

Chapter 6 Using Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .75

Chapter 7 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

TIBCO XML Canon User’s Guide

Chapter 8 Using Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Chapter 9 Working with WebDAV Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147

TIBCO XML Canon User’s Guide

Chapter 10 Administering Categories and Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171

Chapter 11 Administering Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185

TIBCO XML Canon User’s Guide

Chapter 12 Configuring Roles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Chapter 13 Configuring Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215

Chapter 14 Configuring Stages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

TIBCO XML Canon User’s Guide

Chapter 15 Configuring Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .239

Chapter 16 Configuring Custom Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .255

Appendix A Java Virtual Machine Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .265

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

Figure 1 XML Canon Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxii

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

TIBCO XML Canon™ is a comprehensive development platform for storing and

• Changes from the Previous Release of this Guide, page xx

TIBCO XML Canon User’s Guide

Changes from the Previous Release of this Guide

TIBCO XML Canon User’s Guide

This section lists documentation resources you may find useful.

TIBCO XML Canon Documentation

Other TIBCO Product Documentation

TIBCO XML Canon User’s Guide

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

TIBCO XML Canon User’s Guide

Table 1 General Typographical Conventions (Cont’d)

The note icon indicates information that is of special interest or importance,

Table 2 Syntax Typographical Conventions

TIBCO XML Canon User’s Guide

Table 2 Syntax Typographical Conventions

TIBCO XML Canon User’s Guide

How to Contact TIBCO Support

TIBCO XML Canon User’s Guide

TIBCO XML Canon User’s Guide

This chapter includes an overview of TIBCO XML Canon.

• TIBCO XML Canon Overview, page 2

TIBCO XML Canon User’s Guide

TIBCO XML Canon Overview

TIBCO XML Canon User’s Guide

TIBCO XML Canon features enable you to: