User’s Guide

User’s Guide
TIBCO ActiveMatrix BusinessWorks™
Plug-in for MDM
User’s Guide
Software Release 2.0
March 2016
Two-Second Advantage®
Important Information
SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR
BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED
ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED
SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY
OTHER PURPOSE.
USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A
LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT,
OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT
WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS
DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR
CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF
THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR
USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.
This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part
of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.
TIBCO, Two-Second Advantage, TIBCO ActiveMatrix BusinessWorks, TIBCO Designer, TIBCO Administrator, TIBCO
Runtime Agent, TIBCO Hawk, and TIBCO MDM are either registered trademarks or trademarks of TIBCO Software Inc. in
the United States and/or other countries.
Enterprise Java Beans (EJB), Java Platform Enterprise Edition (Java EE), Java 2 Platform Enterprise Edition (J2EE), and all
Java-based trademarks and logos are trademarks or registered trademarks of Oracle Corporation in the U.S. and other
countries.
All other product and company names and marks mentioned in this document are the property of their respective owners and
are mentioned for identification purposes only.
THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL
OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME
TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC
OPERATING SYSTEM PLATFORM.
THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES
ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED
IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR
CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.
THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR
INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT
NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.
Copyright © 2016 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vii
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
Other TIBCO Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
xvii
xvii
xvii
xvii
Chapter 1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Overview of TIBCO MDM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Overview of the Plug-in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Chapter 2 Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
Creating a TIBCO Designer Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
Creating an MDM Connection Shared Resource. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Creating a TIBCO ActiveMatrix BusinessWorks Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Adding Activities to a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Testing a Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Deploying a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Defining Global Variables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Chapter 3 MDM Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
MDM Palette Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Shared Resource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
MDM Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
iv
| Contents
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Add Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
20
20
22
22
24
24
Modify Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
25
25
27
27
30
31
Query Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
32
32
34
35
37
38
Delete Record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
39
39
40
41
42
42
Text Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
43
43
44
45
45
Get Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
46
46
46
47
47
Upload Data Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
49
49
49
51
51
Import Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Contents v
|
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Upload And Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Query Work Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Reassign Work Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Approve Work Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Reject Work Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Close Work Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Advanced . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Get Event Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Get Import Event Detail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
vi
| Contents
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Wait For Event Completion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
84
84
84
85
86
Chapter 4 Using Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Overview of Sample Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
MDMPluginSamples Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Precondition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Upload-Import-Approve-Query Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Search Address Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
89
89
89
91
Appendix A Managing MDM Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Managing Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
Appendix B Trace Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Figures vii
|
Figures
Figure 1
TIBCO MDM Overview. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Figure 2
MDM Palette . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Figure 3
The Upload-Import-Approve-Query Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89
Figure 4
The Search Address Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
viii
| Figures
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Tables ix
|
Tables
Table 1
General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv
Table 2
MDM Connection Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Table 3
Add Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Table 4
Add Record Advanced Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 5
Add Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Table 6
Add Record Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Table 7
Add Record Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
Table 8
Modify Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
Table 9
Modify Record Advanced Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 10
Modify Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
Table 11
Modify Record Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Table 12
Modify Record Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
Table 13
Query Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Table 14
Query Record Advanced Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Table 15
Query Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Table 16
Query Record Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Table 17
Query Record Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
Table 18
Delete Record Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 19
Delete Record Advanced Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Table 20
Delete Record Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Table 21
Delete Record Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Table 22
Delete Record Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Table 23
Text Search Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Table 24
Text Search Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
Table 25
Text Search Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Table 26
Text Search Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Table 27
Get Data Source Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 28
Get Data Source Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
x
| Tables
Table 29
Get Data Source Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Table 30
Get Data Source Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Table 31
Upload Data Source Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Table 32
Upload Data Source Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 33
Upload Data Source Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Table 34
Upload Data Source Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Table 35
Import Records Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
Table 36
Import Records Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 37
Import Records Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 38
Import Records Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 39
Upload And Import Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 40
Upload And Import Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Table 41
Upload And Import Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Table 42
Upload And Import Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Table 43
Query Work Item Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
Table 44
Query Work Item Advanced Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Table 45
Query Work Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 46
Query Work Item Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Table 47
Query Work Item Error Output. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 48
Reassign Work Item Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
Table 49
Reassign Work Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Table 50
Reassign Work Item Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
Table 51
Reassign Work Item Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
Table 52
Approve Work Item Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Table 53
Approve Work Item Advanced Setting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Table 54
Approve Work Item Input. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Table 55
Approve Work Item Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Table 56
Approve Work Item Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Table 57
Reject Work Item Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Table 58
Reject Work Item Advanced Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Table 59
Reject Work Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Table 60
Reject Work Item Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Tables xi
|
Table 61
Reject Work Item Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Table 62
Close Work Item Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Table 63
Close Work Item Advanced Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Table 64
Close Work Item Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Table 65
Close Work Item Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Table 66
Close Work Item Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78
Table 67
Get Event Detail Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Table 68
Get Event Detail Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Table 69
Get Event Detail Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Table 70
Get Event Detail Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81
Table 71
Get Import Event Detail Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Table 72
Get Import Event Detail Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Table 73
Get Import Event Detail Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Table 74
Get Import Event Detail Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Table 75
Wait For Event Completion Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Table 76
Wait For Event Completion Input . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84
Table 77
Wait For Event Completion Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85
Table 78
Wait For Event Completion Error Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Table 79
Upload-Import-Approve-Query Process Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90
Table 80
Search Address Process Activities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91
Table 81
Log Property. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
xii
| Tables
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
| xiii
Preface
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM is designed as a plug-in
integrated with TIBCO ActiveMatrix BusinessWorks to help with metadata
management. You can use this plug-in to utilize all the benefits of TIBCO
ActiveMatrix BusinessWorks without any coding. It is assumed that you are
familiar with the basic concepts of the TIBCO environment and TIBCO MDM.
Topics
•
Related Documentation, page xiv
•
Typographical Conventions, page xv
•
Connecting with TIBCO Resources, page xvii
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
xiv
| Related Documentation
Related Documentation
This section lists documentation resources you may find useful.
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM Documentation
The following documents form the TIBCO ActiveMatrix BusinessWorks Plug-in
for MDM documentation set:
•
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM Installation Read this
manual for instructions on site preparation and installation.
•
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM User’s Guide Read this
manual for instructions on how to use the product to utilize all the benefits of
TIBCO MDM without any coding.
•
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM 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™
•
TIBCO Designer™
•
TIBCO Administrator™
•
TIBCO Hawk®
•
TIBCO Runtime Agent™
•
TIBCO® MDM
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Preface xv
|
Typographical Conventions
The following typographical conventions are used in this manual.
Table 1 General Typographical Conventions
Convention
Use
ENV_NAME
TIBCO products are installed into an installation environment. A product
installed into an installation environment does not access components in
other installation environments. Incompatible products and multiple
instances of the same product must be installed into different installation
environments.
TIBCO_HOME
An installation environment consists of the following properties:
•
Name Identifies the installation environment. This name is
referenced in documentation as ENV_NAME. On Microsoft Windows,
the name is appended to the name of Windows services created by
the installer and is a component of the path to the product shortcut in
the Windows Start > All Programs menu.
•
Path The folder into which the product is installed. This folder is
referenced in documentation as TIBCO_HOME.
TIB_bwpluginmdm_HOME
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM is installed into a
directory within TIBCO_HOME. This directory is referenced in
documentation as TIB_bwpluginmdm_HOME. The default value of
TIB_bwpluginmdm_HOME depends on the operating system. For example,
on Windows systems, the default value is C:\tibco\bw\plugins\mdm.
TIBCO_JRE_HOME
Java Runtime Enviornment (JRE) is packaged with TIBCO products, and
is installed into a directory within TIBCO_HOME. This directory is
referenced in documentation as TIB_JRE_HOME. The default value of
TIB_JRE_HOME depends on the operating system. For example, on
Windows systems, the default value is C:\tibco\tibcojre\1.6.0.
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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
xvi
| Typographical Conventions
Table 1 General Typographical Conventions (Cont’d)
Convention
Use
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]
italic font
Key combinations
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 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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Preface xvii
|
Connecting with TIBCO Resources
How to Join TIBCOmmunity
TIBCOmmunity is an online destination for TIBCO customers, partners, and
resident experts. It is a place to share and access the collective experience of the
TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety
of resources. To register, go to http://www.tibcommunity.com.
How to Access TIBCO Documentation
You can access TIBCO documentation here:
http://docs.tibco.com
How to Contact TIBCO Support
For comments or problems with this manual or the software it addresses, 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.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
xviii Connecting with TIBCO Resources
|
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
|1
Chapter 1
Introduction
This chapter gives an overview of TIBCO MDM and TIBCO ActiveMatrix
BusinessWorks Plug-in for MDM.
Topics
•
Overview of TIBCO MDM, page 2
•
Overview of the Plug-in, page 4
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
2
| Chapter 1
Introduction
Overview of TIBCO MDM
TIBCO MDM is an enterprise application that allows you to ensure your master data to be
consistent, complete, and accurate throughout your organization, enterprise systems, and
partners. It provides a comprehensive approach to manage and synchronize master data
within your organization.
TIBCO MDM is based on a flexible business process automation framework that employs
workflow and user-configurable business rules to streamline processes required by the
enterprise, such as record modification, security, synchronization and publication, and
new record introduction. It works in conjunction with multiple, heterogeneous systems
that affect or use master data information. It also automates global data synchronization
with external trading partners through industry standard datapools, such as 1SYNC.
Figure 1 TIBCO MDM Overview
You can enter data into the application through the user interface, databases, text files,
XML messages, or any other format used within your organization. Data is managed in
repositories. A repository defines syntax and semantics of data and provides secure access
to data. You can define business processes and rules to manage information, including
publishing information to other systems or trading partners.
Key Features:
•
Extensible Data Model
•
Validation Rules
•
Industry Templates
•
Audit and Governance Trail for Reporting
•
Synchronization
•
Service Oriented Architecture
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Overview of TIBCO MDM 3
|
See the TIBCO MDM documentation for more information.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
4
| Chapter 1
Introduction
Overview of the Plug-in
TIBCO ActiveMatrix BusinessWorks is an easy-to-use integration software that provides
world-class integration technology in a rapid deployable solution that manages the entire
lifecycle of integration projects. TIBCO ActiveMatrix BusinessWorks uses the TIBCO
Designer graphical user interface (GUI) to define business processes, and uses the TIBCO
ActiveMatrix BusinessWorks process engine to execute them.
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM integrates with TIBCO
ActiveMatrix BusinessWorks and can be installed separately. You can use this plug-in to
utilize all the benefits of TIBCO MDM without any coding. The plug-in includes one
shared resource and 17 activities, which can be divided into the following groups.
•
MDM Connection Shared Resource Contains all necessary parameters to connect to
an MDM server. The MDM Connection shared resource must be specified when
running any MDM activity.
•
Record Group Includes the Add Record, Modify Record, Query Record, Delete
Record, and Text Search activities. You can do CRUD operations on records and
conduct index entity fuzzy queries with these activities.
•
Data Source Group Includes the Get Data Source, Upload Data Source, Import
Records, and Upload And Import activities. You can upload record data to the data
source, and import records to repositories.
•
Work Item Group Includes the Query Work Item, Reassign Work Item, Approve
Work Item, Reject Work Item, and Close Work Item activities. You can query,
reassign, approve, reject and close work items generated by the MDM server.
•
Event Group Includes the Get Event Detail, Get Import Event Detail, and Wait For
Event Completion activities. You can get event information for a specified event ID,
and wait for an event to complete.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
|5
Chapter 2
Getting Started
This chapter describes the basic steps required to configure and run TIBCO ActiveMatrix
BusinessWorks Plug-in for MDM in TIBCO Designer.
Topics
•
Overview, page 6
•
Creating a TIBCO Designer Project, page 7
•
Creating an MDM Connection Shared Resource, page 8
•
Creating a TIBCO ActiveMatrix BusinessWorks Process, page 9
•
Adding Activities to a Process, page 10
•
Testing a Process, page 11
•
Deploying a Project, page 12
•
Defining Global Variables, page 13
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
6
| Chapter 2
Getting Started
Overview
TIBCO ActiveMatrix BusinessWorks is a scalable, extensible, and easy to use integration
platform that allows you to develop and test integration projects. TIBCO ActiveMatrix
BusinessWorks includes a graphical user interface, TIBCO Designer, for defining business
processes, and an engine that executes the processes.
For detailed information about how to configure processes, see TIBCO Designer
documentation, which can be accessed from the Help > Designer Help menu option in
TIBCO Designer.
A typical configuration session entails the following steps:
1. Creating a TIBCO Designer Project, page 7
2. Creating an MDM Connection Shared Resource, page 8
3. Creating a TIBCO ActiveMatrix BusinessWorks Process, page 9
4. Adding Activities to a Process, page 10
5. Testing a Process, page 11
6. Deploying a Project, page 12
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Creating a TIBCO Designer Project 7
|
Creating a TIBCO Designer Project
The TIBCO Designer GUI is used to configure the plug-in. When starting TIBCO
Designer, you must create or select a project. A project contains the configuration files
that define options used during runtime.
To create a TIBCO Desinger project, complete the following steps:
1. Start TIBCO Designer.
Execute one of the following platform-specific commands to open the TIBCO
Designer window:
— On Microsoft Windows
Select Start > All Programs > TIBCO > TIBCO Designer version_number >
TIBCO Designer.
Or
From a command window, run
TIBCO_HOME\designer\version_number\bin\designer.exe.
— On UNIX
From a command window, run TIBCO_HOME/designer/version_number/bin/designer.
2. Click the New Empty Project button in the startup dialog.
3. In the Multi-File Project tab, click the
button and navigate to the location where
you intend to save the project, or directly type the path in the Project Directory field.
4. Click the OK button to save the project and the TIBCO Designer GUI appears with
the newly created project.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
8
| Chapter 2
Getting Started
Creating an MDM Connection Shared Resource
After creating a TIBCO Designer project, you need to add an MDM Connection shared
resource and configure it.
The MDM Connection shared resource is used for all MDM activities. It specifies all
necessary parameters to establish a connection between the plug-in and the MDM system.
To create an MDM Connection shared resource, complete the following steps:
1. In the project panel, expand the project folder created in Creating a TIBCO Designer
Project on page 7.
2. Click the MDM palette in the palettes panel, and drag the MDM Connection icon to
the design panel on the right.
3. Configure the created MDM Connection shared resource. See MDM Connection on
page 18 for more information.
4. Click the Apply button to save the configuration.
5. Click the Save button to save the Project.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Creating a TIBCO ActiveMatrix BusinessWorks Process 9
|
Creating a TIBCO ActiveMatrix BusinessWorks Process
After creating a TIBCO Designer project, and configuring MDM Connection shared
resource, you need to create TIBCO ActiveMatrix BusinessWorks processes to deal with
certain workflows.
To create a process, complete the following steps:
1. In the project panel, expand the project folder.
2. Click the Process palette in the palettes panel and drag the Process Definition icon to
the design panel on the right.
3. Configure the process. See TIBCO Designer User’s Guide for more information.
4. Click the Apply button to save the configuration.
5. Click the Save button to save the project.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
10
| Chapter 2
Getting Started
Adding Activities to a Process
After creating the process, you can add the plug-in activities to it.
To add an activity to a process, complete the following steps:
1. Double-click a process in the project panel. The Start and End activities appear in the
design panel.
2. Expand the MDM palette in the palettes panel, and drag one or more activities to the
design panel.
3. Create transitions between activities in the design panel.
4. Configure each activity in the process. See MDM Palette Overview on page 16 for
more information.
5. Click the Save button to save the project.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Testing a Process 11
|
Testing a Process
After creating and configuring a process, you can test it in TIBCO Designer. This allows
you to check if the process works properly before you deploy it. See TIBCO
BusinessWorks Process Design Guide for detailed information about using test mode.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
12
| Chapter 2
Getting Started
Deploying a Project
Before deploying a project that you have configured, you need to generate an Enterprise
Archive file (EAR file) that contains the configuration of the process definition you want
to deploy. You can upload the archive to TIBCO Administrator to deploy the associated
application. See TIBCO ActiveMatrix BusinessWorks Administration for more
information.
To deploy a project, complete the following steps:
1. From the menu bar, select Tools > Create Project EAR to create an Enterprise
Archive.
2. Double-click the Enterprise Archive and select Process Archive.
3. In the Processes tab, click the Browse button to specify the process definitions to
include.
4. Click the Apply button.
5. Click the Build Archive button in the Enterprise Archive panel. An Enterprise
Archive file is generated by TIBCO Designer and then you can deploy it by using
TIBCO Administrator.
6. Start TIBCO Administrator and create an application by uploading the EAR file.
7. Deploy the application and start the process.
You can define multiple Enterprise Archive resources for a single Designer project. For
each archive, you can choose the processes to include.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Defining Global Variables 13
|
Defining Global Variables
Global variables provide an easy way to set defaults for use throughout your project. See
TIBCO Designer User’s Guide for details.
This section specifies how to create a new global variable. Complete the following steps to
create a new variable:
1. Start TIBCO Designer.
2. Click the Global Variables tab, and then click the
dialog appears.
3. Click the
button, the Global Variables
button and a new gloabal variable is added to the list.
4. Type a name and value for the variable in the Name field and Value field respectively.
5. Click the OK button.
Click the
button to delete a global variable. Click the
button to add a variable
group. To update a predefined global variable, double-click the variable, then update the
name, value, and other attributes.
The input data (string constants) should be entered using double quotes. However, you
may encounter validation error. For more information, on XPATH and data type
representation and handling in BusinessWorks refer to the Chapter XPath in the TIBCO
ActiveMatrix BusinessWorks™ Process Design Guide.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
14
| Chapter 2
Getting Started
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
| 15
Chapter 3
MDM Palette
This chapter describes the MDM palette, which includes one shared resource and 17
activities for TIBCO ActiveMatrix BusinessWorks Plug-in for MDM.
Topics
•
MDM Palette Overview, page 16
•
MDM Connection, page 18
•
Add Record, page 20
•
Modify Record, page 25
•
Query Record, page 32
•
Delete Record, page 39
•
Text Search, page 43
•
Get Data Source, page 46
•
Upload Data Source, page 49
•
Import Records, page 52
•
Upload And Import, page 55
•
Query Work Item, page 58
•
Reassign Work Item, page 64
•
Approve Work Item, page 68
•
Reject Work Item, page 72
•
Close Work Item, page 76
•
Get Event Detail, page 80
•
Get Import Event Detail, page 82
•
Wait For Event Completion, page 84
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
16
| Chapter 3
MDM Palette
MDM Palette Overview
The MDM palette includes one shared resource and 17 activities, as shown in Figure 2.
Figure 2 MDM Palette
Shared Resource
The shared resource for TIBCO ActiveMatrix BusinessWorks Plug-in for MDM is listed
as below:
•
MDM Connection
Activities
To achieve different functionalities, the 17 activities can be divided into the following
groups:
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
MDM Palette Overview 17
|
•
Operations on record:
— Add Record
— Modify Record
— Query Record
— Delete Record
— Text Search
•
Operations on data source:
— Get Data Source
— Upload Data Source
— Import Records
— Upload And Import
•
Operations on work item:
— Query Work Item
— Reassign Work Item
— Approve Work Item
— Reject Work Item
— Close Work Item
•
Operations on event:
— Get Event Detail
— Get Import Event Detail
— Wait For Event Completion
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
18
| Chapter 3
MDM Palette
MDM Connection
Shared Resource
The MDM Connection shared resource contains all necessary parameters to connect to an
MDM server. The MDM Connection shared resource must be specified when running any
MDM activity.
Configuration
The Configuration tab contains the fields shown in Table 2.
Table 2 MDM Connection Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the MDM connection.
The default name is MDM Connection.
Description
No
(Optional) A short description of the shared resource.
Click the
button and add the description in the Description dialog.
MDM Server
URL
Yes
Company Name
Yes
(Required) The company name configurated in the MDM server that you want to work
on.
User Name
Yes
(Required) The user name existed in the specified company that you want to work on.
Password
Yes
(Required) The password of the user that you input in the User Name field.
Encrypt Password
Yes
(Optional) Check the checkbox to encrypt password when exchanging information with
an MDM server.
(Required) The URL of the MDM server that you want to connect to.
For example: http://host:port.
After configuring MDM Connection, click the Test Connection button to test the
connection to the MDM server that you have configured.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
MDM Connection 19
|
Note: If the MDM server is enabled with SSL connection, complete the following steps to
connect to the MDM server with SSL connection:
1. Enable JSSE: Add java.property.TIBCO_SECURITY_VENDOR=j2se to the designer.tra
file and bwengine.tra file at design time and at runtime respectively.
2. Import the certificate obtained from the MDM server into Java key store cacerts
located in TIBCO_JRE_HOME\lib\security.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
20
| Chapter 3
MDM Palette
Add Record
Activity
The Add Record activity is used to add records and the relative relationship to
repositories.
Configuration
The Configuration tab contains the fields shown in Table 3.
Table 3 Add Record Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Add Record.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Repository
No
(Required) Specifies the name of repository where records are stored.
Click the Select button to open the Repository dialog. All available repositories are
listed in the drop-down list of the dialog. Select one to apply to your current activity.
Note: When the selected repository model is complex and involves many related
repositories, you need to increase the value of tibco.env.HEAP_SIZE in
designer.tra and bwengine.tra at design time and at runtime respectively.
Record State
No
(Optional) Specifies the states of the record that you want to save: Confirmed,
value is Unconfirmed.
Unconfirmed, or Draft. The default
•
Confirmed: Saves
•
Unconfirmed:
•
Draft:
as confirmed records.
Saves as unconfirmed records.
Saves as draft records.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Add Record 21
|
Table 3 Add Record Configuration (Cont’d)
Field
Command
Qualifier
Global
Var?
No
Description
(Optional) Specifies the qualifier of the command: Validate/Process,
Validate/NoProcess, NoValidate/Process, or NoValidate/NoProcess. The
default option is Validate/Process.
Note: When Record State is set to Draft, only the Validate/Process and
NoValidate/Process options are displayed.
•
Validate/Process:
•
Validate/NoProcess: Validates records, and saves them without initiating the
New Record Introduction Edit workflows.
•
NoValidate/Process: Does not validate records, but saves them and initiates the
Validates records, saves them, and initiates the New Record
Introduction Edit workflows.
New Record Introduction Edit workflows.
•
File Type
Attributes
No
(Optional) Specifies how to upload a file with file type attributes. This field appears
when any attribute defined in the selected repository model is a file type attribute. The
default option is ATTACHMENT.
•
Execution Mode
No
NoValidate/NoProcess: Does not validate records, but saves them without
initiating the New Record Introduction Edit workflows.
ATTACHMENT: Indicates that the client will send the file as SOAP attachments to
the MDM server.
(Optional) Specifies the modes of execution: SYNCHR or ASYNCHR. The default option is
SYNCHR.
•
SYNCHR: The client
•
ASYNCHR: The client invokes a service, but does not wait for the completion of the
invokes a service, and waits for the completion of the
workflow execution.
workflow execution.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
22
| Chapter 3
MDM Palette
Advanced
The Advanced tab has the following fields as shown in Table 4.
Table 4 Add Record Advanced Setting
Field
Classify Records
Manually
Global
Var?
Description
No
(Optional) Check this checkbox to manually classify records into the specified
classification code by using Classification Scheme while adding a record.
Note: This checkbox appears only when the selected repository model is defined
with manual classification scheme or mixed classification scheme. When this
checkbox is checked, ClassificationSchemes is added to the repository node in
the Input tab.
Input
The input for the activity is listed and described in Table 5.
Table 5 Add Record Input
Input Item
Description
Context
(Optional) Specifies the context variables of the activity.
You can specify the value of Name and Value.
Transaction
Repository
Attribute
Group
(Optional) Specifies group attributes of records. Each attribute is assigned to an
attribute group: Unassigned, System or New Group. The default attribute group
UNASSIGNED holds all attributes that do not belong to any specific group.
•
PRODUCTID: Record ID. When PRODUCTID is not specified, a PRODUCTID will be
generated automatically if users have configured rulebase on the MDM server;
otherwise, an error is returned.
•
PRODUCTIDEXT:
•
EFFECTIVEDATE:
Record ID extension. Optionally used to identify a record.
The effective date of the record. If you do not apply an effective
date to a record, it is internally set to the current system date. By default, this
attribute is not enabled for repositories, you must add this attribute manually to
repositories if you want to add a future effective dated version to a record.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Add Record 23
|
Table 5 Add Record Input (Cont’d)
Input Item
Description
Classification
Schemes
(Optional) The ClassificationSchemes attribute allows you to organize records
based on their attributes. You can specify the value of Name, Action, and
ClassificationCode.
•
Name:
•
Action:
•
ClassificationCode:
The name of classification scheme you want to specify.
The classification action you want to take. The value is Classify.
The code of the classification scheme. Each node
represents one level in the classification code hierarchy.
Note: The ClassificationSchemes attribute is added to the repository node when the
Classify Records Manually checkbox is checked in the Advanced tab.
Relationship
(Optional) Specifies the relationship of records in repositories. After selecting an
available relationship name, you can specify the corresponding relationship attributes
and attributes in the target repository.
•
Incremental: When the value is set to True, the relationship is only added to the
specified record. When the value is set to False, the newly specified relationship
is added, and all other relationships are deleted. By default, the value is set to True.
•
Delete:
The relative relationship between records is deleted when the value is set
to True, and the relative relationship between records is added when the value is
set to False.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name
and password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is
second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
24
| Chapter 3
MDM Palette
Output
The output for the activity is listed and described in Table 6.
Table 6 Add Record Output
Output Item
Description
Result
Returns the execution result to indicate whether the execution succeeds or not.
The node contains the following three elements:
Transaction
Response
TransactionR
esult
•
Severity:
Can be Error, Warning, or Info.
•
Code:
•
Description:
The error code.
A readable description of the error.
Returns detailed information of the repository and ResultList:
•
Repository: Contains
•
ResultList: Contains
the repository attributes and relationship information.
errors, warnings or informational messages. The element
has one or more entries.
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not mean the successful completion of the command. However, a failure
does mean that the command is aborted.
The element also captures details such as Result, SuccessCount, EventID,
EventStatus, EventState, Action, and so on.
•
SuccessCount:
Indicates the number of records successfully processed.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 7.
Table 7 Add Record Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Modify Record 25
|
Modify Record
Activity
The Modify Record activity is used to modify records and the relative relationship in
repositories.
Configuration
The Configuration tab contains the fields shown in Table 8.
Table 8 Modify Record Configuration
Field
Global
Var?
Description
Name
No
(Required) The name of the activity in the process definition.
The default name is Modify Record.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Execution Mode
No
(Optional) Specifies the modes of execution: SYNCHR or ASYNCHR. The default option is
SYNCHR.
•
SYNCHR: The client
•
ASYNCHR: The client invokes a service, but does not wait for the completion of the
invokes a service, and waits for the completion of the
workflow execution.
workflow execution.
Repository
No
(Required) Specifies the name of repository where records are stored.
Click the Select button to open the Repository dialog. All available repositories are
listed in the drop-down list of the dialog. Select one to apply to your current activity.
Note: When the selected repository model is complex and involves many related
repositories, you need to increase the value of tibco.env.HEAP_SIZE in
designer.tra and bwengine.tra at design time and at runtime respectively.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
26
| Chapter 3
MDM Palette
Table 8 Modify Record Configuration (Cont’d)
Field
Global
Var?
Record State
No
Description
(Optional) Specifies the states of the record that you want to save: Confirmed,
value is Unconfirmed.
Unconfirmed, or Draft. The default
Command
Qualifier
File Type
Attributes
No
No
•
Confirmed: Saves
•
Unconfirmed:
•
Draft:
as confirmed records.
Saves as unconfirmed records.
Saves as draft records.
(Optional) Specifies the qualifier of the command: Validate/Process,
Validate/NoProcess, NoValidate/Process, or NoValidate/NoProcess,
Validate/ProcessOnDataChange, and NoValidate/ProcessOnDataChange. The
default option is Validate/ProcessOnDataChange.
•
Validate/Process: Validates records, saves them, and initiates the New Record
Introduction Edit workflows.
•
Validate/NoProcess: Validates records, and saves them without initiating the
New Record Introduction Edit workflows.
•
NoValidate/Process: Does not validate records, but saves them and initiates the
New Record Introduction Edit workflows.
•
NoValidate/NoProcess: Does not validate records, but saves them without
initiating the New Record Introduction Edit workflows.
•
Validate/ProcessOnDataChange: Validates records, processes and saves them
only when the data has changed for the specified records. If the data has not
changed, the records will not be processed or saved, yet it will be validated.
•
NoValidate/ProcessOnDataChange: Does not validate records, but processes
and saves them when the data has changed for the specified records.
(Optional) Specifies how to upload a file with file type attributes. This field appears
when any attribute defined in the selected repository model is a file type attribute. This
default option is ATTACHMENT.
•
ATTACHMENT:
Indicates that the client will send the file as SOAP attachments to
the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Modify Record 27
|
Advanced
The Advanced tab has the following fields as shown in Table 9.
Table 9 Modify Record Advanced Setting
Field
Classify Records
Manually
Global
Var?
Description
No
(Optional) Check this checkbox to manually classify records into the specified
classification code by using Classification Scheme while modifying a record.
Note: This checkbox appears only when the selected repository model is defined
with manual classification scheme or mixed classification scheme. When this
checkbox is checked, ClassificationSchemes is added to the repository node in
the Input tab.
Modify Future
Effective Dated
Version
No
(Optional) Check this checkbox to modify a specified future effective dated version
if:
•
The version number is specified;
•
The specified version is future effective dated and active.
Note: This checkbox appears only when the selected repository model is enabled
with EffectiveDate attribute. When this checkbox is checked, RecordVersion is
added to the repository node in the Input tab.
Modify in Work
Item Context
No
(Optional) Check this checkbox to modify record in work item context. To modify
record in work item context, you should have the Edit when record is in workflow
permission.
Note: When this checkbox is checked, the WorkItemReference node appears in
WorkItem in the Input tab.
Input
The input for the activity is listed and described in Table 10.
Table 10 Modify Record Input
Input Item
Context
Description
(Optional) Specifies the context variables of the activity.
You can specify the value of Name and Value.
VERSION_POLICY
(Optional) The version update is managed by specifying the appropriate version policy
in the context. The context variable contains the following two values:
•
New
: Creates a new version.
•
Correct:
Updates the existing version of the record without creating a new version.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
28
| Chapter 3
MDM Palette
Table 10 Modify Record Input (Cont’d)
Input Item
Description
Transaction
WorkItemReference
(Optional) Specifies the workitem ID that you want to reference.
Note: The node appears only when the Modify in Work Item Context checkbox is
checked in the Advanced tab.
Repository
RecordVersio
n
(Optional) Identifies the record version to be modified.
Note: The attribute appears only when the Modify Future Effective Dated Version
checkbox is checked in the Advanced tab.
PRODUCTI
D
(Required) ID of the record to be modified. You must specify PRODUCTID of the record
to be modified.
PRODUCTI
DEXT
(Optional) ID extension of the record to be modified. Optionally used to identify a
record.
Attribute
Group
(Optional) Specifies group attributes of records. Each attribute is assigned to an attribute
group: Unassigned, System or New Group. The default attribute group UNASSIGNED holds
all attributes that do not belong to any specific group.
•
PRODUCTID:
Record ID. Optionally used to modify PRODUCTID of the specified
record.
Classification
Schemes
•
PRODUCTIDEXT: Record ID extension. Optionally used to modify PRODUCTIDEXT of
the specified record.
•
EFFECTIVEDATE: The effective date of the record. If you do not apply an effective
date to a record, it is internally set to the current system date. By default, this
attribute is not enabled for repositories, you must add this attribute manually to
repositories if you want to add a future effective dated version to a record.
(Optional) The ClassificationSchemes attribute allows you to organize records based
on their attributes. You can specify the value of Name, Action, and
ClassificationCode.
•
Name:
•
Action:
•
ClassificationCode:
The name of classification scheme you want to specify.
The classification action you want to take. The value is Classify.
The code of the classification. Each node represents one
level in the classification code hierarchy.
Note: The ClassificationSchemes attribute is added to the repository node in the
Input tab only when the Classify Records Manually checkbox is checked in the
Advanced tab.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Modify Record 29
|
Table 10 Modify Record Input (Cont’d)
Input Item
Description
Relationship
(Optional) Specifies the relationship of records in repositories. After selecting an
available relationship name, you can specify the corresponding relationship attributes
and attributes in the target repository.
•
Incremental: When the value is set to True, the relationship is only added to the
specified record. When the value is set to False, the newly specified relationship is
added, and all other relationships are deleted. By default, the value is set to True.
•
Delete: The relative relationship between records is deleted when the value is set to
True, and the relative relationship between records is added when the value is set to
False.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name
and password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is
second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
30
| Chapter 3
MDM Palette
Output
The output for the activity is listed and described in Table 11.
Table 11 Modify Record Output
Output Item
Description
Result
Returns the execution result to indicate whether the execution succeeds or not.
The node contains the following three elements:
Transaction
WorkItemRef
erence
Response
TransactionRe
sult
•
Severity:
Can be Error, Warning, or Info.
•
Code:
•
Description:
The error code.
A readable description of the error.
Returns the workitem ID that you referenced.
Note: The node appears only when the Modify in Work Item Context checkbox is
checked in the Advanced tab.
Returns the following information:
•
Repository:
•
ResultList:
Contains the repository attributes and relationship information.
Contains errors, warnings or informational messages. The element
has one or more entries.
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not mean the successful completion of the command. However, a failure
does mean that the command is aborted.
The element also captures details such as Result, SuccessCount, EventID,
EventStatus, EventState, Action, and so on.
•
SuccessCount:
Indicates the number of records successfully processed.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Modify Record 31
|
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed inTable 12.
Table 12 Modify Record Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
32
| Chapter 3
MDM Palette
Query Record
Activity
The Query Record activity is used to query records based on the filter criteria.
Configuration
The Configuration tab contains the fields shown in Table 13.
Table 13 Query Record Configuration
Field
Global
Var?
Description
Name
No
(Required) The name of the activity in the process definition.
The default name is Query Record.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies where the input data is connected.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Repository
No
(Required) Specifies the name of repository where records are stored.
Click the Select button to open the Repository dialog. All available repositories are
listed in the dialog. Select one to apply to your current activity.
Note: When the selected repository model is complex and involves many related
repositories, you need to increase the value of tibco.env.HEAP_SIZE in
designer.tra and bwengine.tra at design time and at runtime respectively.
Perspective
No
(Optional) Specifies the perspective name within the selected repository.
Click the Select button to open the Perspective dialog. All available perspective names
are listed in the dialog. Select one to apply to your current activity.
Note: The field appears only when the selected repository model is defined with
Perspective.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Query Record 33
|
Table 13 Query Record Configuration (Cont’d)
Field
Global
Var?
Output Map
No
Description
(Optional) Specifies the output map name of the selected repository model.
Click the Select button to open the Output Map dialog. All available output map
names are listed in the dialog. Select one to apply to your current activity.
Note: The field appears only when the selected repository model is defined with
Output Map.
Record State
Command
Qualifier
No
No
(Optional) Specifies the states of the record that you want to query: NONE, All,
Confirmed, Unconfirmed, Latest, Draft, or Rejected. The default value is
Confirmed.
•
NONE: Does
•
All:
•
Confirmed: Queries confirmed records.
•
Unconfirmed:
•
Latest:
•
Draft:
•
Rejected:
not specify record state for the query.
Queries all the records.
Queries unconfirmed records.
Queries the latest confirmed or unconfirmed records.
Queries draft records.
Queries rejected records.
(Optional) Specifies the qualifier of the command: NONE, or RelatedRecords. The
default value is NONE.
Note: When Command Qualifier is set to RelatedRecords, any option for the Record
State and Active fields will not take effect.
File Type
Attributes
No
•
NONE: No
•
RelatedRecords: Get related records. This option displays only when the
selected repository model contains any related repository.
command qualifier.
(Optional) Specifies how to return a file with file type attributes. This field appears
when any attribute defined in the selected repository model is a file type attribute. The
default option is HREF.
•
HREF: Indicates that the client would like the server to return a hyperlink into the
application, from where client can download the files represented by the file type
attributes.
•
ATTACHMENT: Indicates that the client would like the server to return the file as
SOAP attachments to the application.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
34
| Chapter 3
MDM Palette
Table 13 Query Record Configuration (Cont’d)
Field
Future Dated
Record
Global
Var?
No
Description
(Optional) Queries records by FED options, and the returned records are based on FED
options. The default option is No FED.
Note: The field appears only when the selected repository model is defined with the
Effective attribute.
Active
No
•
No FED:
Does not include Future Effective Date records.
•
Only FED:
•
Include FED:
Includes only Future Effective Date records.
Includes Future Effective Date records along with other records.
(Optional) Queries active records. A record is considered active if it is not deleted. The
default value is TRUE.
•
NONE: Only displays in the drop-down list when the Record State is All. When the
value is set to NONE, data for active records and deleted records are retrieved.
•
TRUE: When the value is set to TRUE, only data for active records are retrieved, and
the query does not return any deleted records.
•
FALSE: When the value is set to FALSE, only data for deleted records are retrieved,
and the query does not return any active records.
Advanced
The Advanced tab has the following fields as shown in Table 14.
Table 14 Query Record Advanced Setting
Field
Query based on
Classification
Scheme
Global
Var?
No
Description
Check this checkbox to query records based on classification schemes.
Note: The checkbox displays only when the selected repository is defined with
classification scheme and Command Qualifier is set to NONE. When this checkbox is
checked, the Classification node appears in Transaction in the Input tab.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Query Record 35
|
Input
The input for the activity is listed and described in Table 15.
Table 15 Query Record Input
Input Item
Description
Context
(Optional) Specifies the context variables of the activity.
You can specify the value of Name and Value.
Transaction
Pagination
(Optional) Specifies the following detailed information:
•
MaxCount:
Limits the number of returned records if more than one records match
the query.
EffectiveDate
•
StartCount:
•
OrderByColumnList:
The count where the queried records start to display.
Sorts order for the query result by column list.
(Optional) The effective date of the record.
Note: The node appears only when the repository model is defined with the Effective
attribute, and the Future Dated Record is set to No FED in the Configuration tab.
Classification
(Optional) Specifies classification information of the record. You can specify the value
of ClassificationSchema, or ClassificationCodePath.
Note: The node appears only when the Query based on Classification Scheme
checkbox is checked in the Advanced tab.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
36
| Chapter 3
MDM Palette
Table 15 Query Record Input (Cont’d)
Input Item
Repository
Description
Attribute
Group
(Optional) Specifies group attributes of records. Each attribute is assigned to an
attribute group: Unassigned, System or New Group. The default attribute group
UNASSIGNED holds all attributes that do not belong to any specific group.
Note: Whether the field appears depends on the MDM metadate.The field appears
when the attribute in the MDM metadate sets Searchable to TRUE, and the field
disappears when Searchable is set to FALSE.
•
PRODUCTID:
Record ID. It is mandatory when Command Qualifier is set to
in the Configuration tab.
RelatedRecords
•
RecordVersio
n
RECORD_M
ODDATE
PRODUCTIDEXT: Record ID extension. It is mandatory when Command Qualifier is
set to RelatedRecords in the Configuration tab.
(Optional) Identifies the version of record being queried.
Note: The attribute will not appear when the Command Qualifier is NONE and the
Record State is not NONE in the Configuration tab. It is mandatory when Command
Qualifier is set to RelatedRecords in the Configuration tab.
(Optional) Identifies the modification date of the record being queried.
Note: The attribute will not appear when the Command Qualifier is RelatedRecord in
the Configuration tab.
Relationship
(Optional) Specifies the relationship of repositories. After selecting an available
relationship name, the related repository is displayed, and you can specify the
corresponding attributes in the target repository.
Return
(Optional) Specifies requirements for the records, related records and the relationship
to be returned after the filter.
•
All:
•
RelationshipNames:
•
ClassificationData: Returns classification details of records. The node appears
only when the Query based on Classification Scheme checkbox is checked in the
Advanced tab.
Returns all the child records. You can specify the depth of relationship.
Returns records related to the specified relationship name.
Note: The node appears only when the Command Qualifier is set to NONE, and the
selected repository is defined with relationship or classification.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name
and password. UserInfo takes effect only when SessionID is invalid or expired.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Query Record 37
|
Table 15 Query Record Input (Cont’d)
Input Item
Description
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is
second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
Output
The output for the activity is listed and described in Table 16.
Table 16 Query Record Output
Output Item
Description
Result
Returns the execution result to indicate whether the execution succeeds or not.
The node contains the following three elements:
Transaction
Response
TransactionR
esult
•
Severity: Can
•
Code:
•
Description:
be Error, Warning, or Info.
The error code.
A readable description of the error.
Returns the following information:
•
Repository: Contains
•
ResultList: Contains
the repository attributes and relationship information.
errors, warnings or informational messages. The element
has one or more entries.
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not mean the successful completion of the command. However, a failure
does mean that the command is aborted.
The element also captures details such as Result, SuccessCount, EventID,
and so on.
EventStatus, EventState, Action,
•
SuccessCount:
Indicates the number of records successfully processed.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
38
| Chapter 3
MDM Palette
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 17.
Table 17 Query Record Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Delete Record 39
|
Delete Record
Activity
The Delete Record activity is used to delete the following records when they exist and the
latest version of the records is not in any workflow:
•
Repository records
•
Records related to target records
•
Both repository records and related target records
•
Future effective dated record version
Configuration
The Configuration tab contains the fields shown in Table 18.
Table 18 Delete Record Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Delete Record.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Execution Mode
No
(Optional) Specifies the modes of execution: SYNCHR or ASYNCHR. The default option is
SYNCHR.
•
SYNCHR: The client
•
ASYNCHR: The client invokes a service, but does not wait for the completion of the
invokes a service, and waits for the completion of the
workflow execution.
workflow execution.
Repository
No
(Required) Specifies the name of repository where records are stored.
Click the Select button to open the Repository dialog. All available repositories are
listed in the drop-down list of the dialog. Select one to apply to your current activity.
Note: When the selected repository model is complex and involves many related
repositories, you need to increase the value of tibco.env.HEAP_SIZE in
designer.tra and bwengine.tra at design time and at runtime respectively.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
40
| Chapter 3
MDM Palette
Table 18 Delete Record Configuration (Cont’d)
Field
Command
Qualifier
Global
Var?
No
Description
(Optional) Specifies the qualifier of the command: Record, Record/NoProcess,
RelationshipTargets, RelationshipTargets/NoProcess, DeleteAll,
DeleteAll/NoProcess. The default option is DeleteAll.
•
Record: Deletes
•
Record/NoProcess: Deletes the specified records, and comfirms it immediately
without initiating the delete workflow.
•
RelationshipTargets: Only deletes the related records, and initiates the delete
workflow. Optionally, the relationship name can be specified.
•
RelationshipTargets/NoProcess:
•
DeleteAll: Deletes the specified records and related records, and initiates the
delete workflow. Optionally, the relationship name can be specified.
•
DeleteAll/NoProcess: Deletes the specified records and related records, and
confirms the records immediately. Optionally, the relationship name can be
specified, and users must have required privileges.
the specified records, and initiates the delete workflow.
Only deletes the related records, and
confirms it immediately without initiating the delete workflow. Optionally, the
relationship name can be specified, and users must have required privileges.
Advanced
The Advanced tab has the following fields as shown in Table 19.
Table 19 Delete Record Advanced Setting
Field
Delete Future
Effective Dated
Version
Global
Var?
No
Description
(Optional) Check this checkbox to delete a specified future effective dated version
if:
•
The version number is specified;
•
The specified version is future effective dated and active;
•
The version is not in another workflow.
Note: This checkbox appears only when the selected repository model is enabled
with the EffectiveDate attribute. When this checkbox is checked, RecordVersion
is added to the repository node in the Input tab.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Delete Record 41
|
Input
The input for the activity is listed and described in Table 20.
Table 20 Delete Record Input
Input Item
Description
Context
(Optional) Specifies the context variables of the activity.
You can specify the value of Name and Value.
Transaction
Repository
RecordVersio
n
(Optional) Identifies the version of record being deleted. If this value is set to Yes, old
record versions are deleted.
Note: The attribute is added to the repository node only when the Delete Future
Effective Dated Version checkbox is checked in the Advanced tab.
Attribute
Group
Relationship
(Optional) Specifies group attributes of records. Each attribute is assigned to an attribute
group: Unassigned, System or New Group. The default attribute group UNASSIGNED
holds all attributes that do not belong to any specific group.
•
PRODUCTID:
•
PRODUCTIDEXT:
Record ID. When PRODUCTID is not specified, an error is returned.
Record ID extension. Optionally used to identify a record.
(Optional) Specifies the relationship of records in repositories. After selecting an
available relationship name, the related repository is displayed, and you can specify the
corresponding attributes in the target repository.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name
and password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is
second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
42
| Chapter 3
MDM Palette
Output
The output for the activity is listed and described in Table 21.
Table 21 Delete Record Output
Output Item
Description
Result
Returns the execution result to indicate whether the execution succeeds or not.
The node contains the following three elements:
Transaction
Response
TransactionR
esult
•
Severity:
Can be Error, Warning, or Info.
•
Code:
•
Description:
The error code.
A readable description of the error.
Returns the following information:
•
Repository: Contains
•
ResultList: Contains
the repository attributes and relationship information.
errors, warnings or informational messages. The element
has one or more entries.
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not mean the successful completion of the command. However, a failure
does mean that the command is aborted.
The element also captures details such as Result, SuccessCount, EventID,
EventStatus, EventState, Action, and so on.
•
SuccessCount:
Indicates the number of records successfully processed.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 22.
Table 22 Delete Record Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Text Search 43
|
Text Search
Activity
The Text Search activity is used to search for human recognizable terms in one or more
TIBCO MDM repositories.
Index entity should not be configured and left blank or blank values.
Configuration
The Configuration tab contains the fields shown in Table 23.
Table 23 Text Search Configuration
Field
Globa
l Var?
Description
Name
No
(Required) The name of the activity in the process definition.
The default name is Text Search.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Index Configuration
File
No
(Required) You need to copy an indexerConfig.xml file from server to your local
disk. It is used to design time and parse the indexed entities.
Index Entity
No
(Required) The name of the index entity.
Click the Select button to open the IndexEntity Name dialog. All available index
entities are listed in the drop-down list of the dialog. Select one to apply to your
current activity.
Repository
No
(Required) The repository name of the index entity. When the IndexEntity is selected,
the corresponding repository name will be shown automatically.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
44
| Chapter 3
MDM Palette
Input
The input for the activity is listed and described in Table 24.
Table 24 Text Search Input
Input Item
Index Entity
Name
Description
SimilarityS
core
(Optional) Specifies the score of similarity of index entity in the text search. The value is
between 0 and 1.0.
Repository
(Required) Specifies the attributes, relationship, and other detailed information of the
selected repository. You can specify the expression and weight for each attribute.
ReturnCount
•
Expression:
An expression used to text search.
•
Weight: The weight of the attribute. The valid value
is a fraction between 0 and 1.0.
(Optional) Specifies the number of matching records that you want to display in the
search result. The default value is 20.
If you do not specify the return count, 20 matching records that meet the search criteria
are displayed.
•
Start Count: The sequential number of matching record that you want to display in
the response.
•
Total Count:
The total number of matching records that you want to display in the
response.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying
the header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration
file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is
second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Text Search 45
|
Output
The output for the activity is listed and described in Table 25..
Table 25 Text Search Output
Output Item
Description
Records
Repository
searchScore
Returns a list of records matching the search criteria.
Returns the default similarity (fuzzy) score which is needed to return a matching record.
The value must be between 0 and 1.0. The default value is 0.8.
Note: Lowering the default fuzzy score may affect performance and result in irrelevant
records.
searchScore
String
Returns the float score as string type.
Attribute
Group
(Optional) Returns the group attributes of records, whether they are Unassigned, System
or user-customized.
See the TIBCO MDM documentation for more information on the attribute group.
ReturnCount
Returns a number of matching records specified in a repository that you want to display in
the response.
•
Start Count: The sequential number of matching record that you want to display in
the response.
•
Total Count:
The total number of matching records that you want to display in the
response.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 26.
Table 26 Text Search Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
46
| Chapter 3
MDM Palette
Get Data Source
Activity
The Get Data Source activity is used to get a list of data source information with specified
Data Source name.
Configuration
The Configuration tab contains the fields shown in Table 27.
Table 27 Get Data Source Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Get Data Source.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Data Source
No
(Optional) The name of the data source.
Note: The DataSource node also appears in the Input tab, each of the two is optional,
yet one of them must be present. It will be overridden by the DataSource attributes in
the Input tab at runtime.
Input
The input for the activity is listed and described in Table 28.
Table 28 Get Data Source Input
Input Item
Description
DataSource
(Optional) The name of the data source.
Note: The DataSource field also appears in the Configuration tab, each of the two is
optional, yet one of them must be present. It will override the Data Source attributes in the
Configuration tab at runtime.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Get Data Source 47
|
Table 28 Get Data Source Input
Input Item
Description
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying
the header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration
file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
Output
The output for the activity is listed and described in Table 29.
Table 29 Get Data Source Output
Output Item
Description
DatasourceInfo
Returns a list of all data source information. For each data source, the data source ID, Name,
Description, FileName, Format, SourceTableName, DelimiterCode, DelimiterValue,
HeaderLineCount, UseTitlesFlag, FileLastUploadedDate, TableLastUploadedDate,
LoadedRowCount, BadRowCount, LogFile, BadFile, QueueName, Keyword, TextQualifier,
DecimalSymbol, ThousandSeparator, XslfFileName, DateFormat, ModMemberID, ModDate,
ModVersion, Active, TransportProtocol, TransportProtocolAddressID, Action,
OriginalFileName, InternalFileName are returned.
See the TIBCO MDM documentation for more information on those terms.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 30.
Table 30 Get Data Source Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
48
| Chapter 3
MDM Palette
Table 30 Get Data Source Error Output
MDMPluginException
Description
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Upload Data Source 49
|
Upload Data Source
Activity
The Upload Data Source activity is used to upload external record data to data sources. It
can upload delimited files, fixed length files, and data from databases to data sources.
Configuration
The Configuration tab contains the fields shown in Table 31.
Table 31 Upload Data Source Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Upload Data Source.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Execution Mode
No
(Optional) Specifies the modes of execution: SYNCHR, ASYNCHR. The default option is
ASYNCHR.
•
SYNCHR: The client
•
ASYNCHR: The client invokes a service, but does not wait for the completion of the
invokes a service, and waits for the completion of the
workflow execution.
workflow execution.
Data Source
No
(Required) The name of the data source.
File Name
Yes
(Optional) The name of the file to be uploaded.
Note: The FileName node also appears in the Input tab, the value in the Configuration
tab will be overridden by the value of FileName in the Input tab at runtime.
Input
The input for the activity is listed and described in Table 32.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
50
| Chapter 3
MDM Palette
Table 32 Upload Data Source Input
Input Item
FileName
Description
(Optional) The name of the file to be uploaded.
Note: The FileName field also appears in the Configuration tab, the value of File Name in the
Configuration tab will be overriden at runtime.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying the
header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration file
on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of timeout
when the execution takes long time.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Upload Data Source 51
|
Output
The output for the activity is listed and described in Table 33.
Table 33 Upload Data Source Output
Output Item
Description
Severity
The field can be Error, Warning, or Info.
EventResult
Returns the event result:
Description
•
EventID:
•
EventStatus:
•
EventState:
•
EventStatusDescription:
•
EventStateDescription:
The ID produced by the event.
Returns the status of the event.
Returns the process state of the event.
The description of event status.
The description of event process state.
Returns the description of the upload data source status.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 34.
Table 34 Upload Data Source Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
52
| Chapter 3
MDM Palette
Import Records
Activity
The Import Records activity is used to import records to repositories by using an input
map, which maps repositories and data sources.
Configuration
The Configuration tab contains the fields shown in Table 35.
Table 35 Import Records Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Import Records.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Execution Mode
No
(Optional) Specifies the modes of execution: SYNCHR, ASYNCHR. The default option is
ASYNCHR.
•
SYNCHR: The client
•
ASYNCHR: The client invokes a service, but does not wait for the completion of the
invokes a service, and waits for the completion of the
workflow execution.
workflow execution.
Repository
No
(Required) Specifies the name of repository where records are stored.
Click the Select button to open the Repository dialog. All available repositories are
listed in the drop-down list of the dialog. Select one to apply to your current activity.
Input Map
No
(Optional) Maps the repository and the data source. The name of Input Map is unique
for each repository.
Note: The InputMap node also appears in the Input tab, each of the two is optional, yet
one of them must be present. If both are present, the value of InputMap in the
Configuration tab will be overriden at runtime.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Import Records 53
|
Input
The input for the activity is listed and described in Table 36.
Table 36 Import Records Input
Input Item
Description
InputMap
(Optional) Maps the repository and the data source.
Note: The InputMap field also appears in the Configuration tab, each of the two is optional,
yet one of them must be present. If both are present, the value of InputMap in the
Configuration tab will be overriden at runtime.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying the
header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration file
on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
Output
The output for the activity is listed and described in Table 37.
Table 37 Import Records Output
Output Item
Description
Severity
The field can be Error, Warning, or Info.
EventResult
Returns the event result:
•
EventID:
•
EventStatus:
•
EventState:
•
EventStatusDescription:
•
EventStateDescription:
The ID produced by the event.
Returns the status of the event.
Returns the process state of the event.
The description of event status.
The description of event process state.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
54
| Chapter 3
MDM Palette
Table 37 Import Records Output
Output Item
Description
Description
Returns the description of the import records status.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 38.
Table 38 Import Records Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Upload And Import 55
|
Upload And Import
Activity
The Upload And Import activity is used to upload external record data to data sources, and
import records from data sources to repositories.
Configuration
The Configuration tab contains the fields shown in Table 39.
Table 39 Upload And Import Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Upload and Import.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to Load And Import the description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Execution Mode
No
(Optional) Specifies the modes of execution: SYNCHR, ASYNCHR. The default option is
ASYNCHR.
•
SYNCHR: The client
•
ASYNCHR: The client invokes a service, but does not wait for the completion of the
invokes a service, and waits for the completion of the
workflow execution.
workflow execution.
Repository
No
(Required) Specifies the name of repository where records are stored.
Click the Select button to open the Repository dialog. All available repositories are
listed in the drop-down list of the dialog. Select one to apply to your current activity.
Input Map
No
(Optional) Maps the repository and the data source. The name of Input Map is unique
for each repository.
Note: The InputMap node also appears in the Input tab, each of the two is optional, yet
one of them must be present. If both are present, the value of InputMap in the
Configuration tab will be overriden at runtime.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
56
| Chapter 3
MDM Palette
Table 39 Upload And Import Configuration (Cont’d)
Field
Global
Var?
File Name
Yes
Description
(Optional) The name of the file to be uploaded.
Note: The FileName node also appears in the Input tab, the value of File Name in the
Configuration tab will be overriden at runtime.
Input
The input for the activity is listed and described in Table 40.
Table 40 Upload And Import Input
Input Item
Description
FileName
(Optional) The name of the file to be uploaded.
Note: The FileName field also appears in the Configuration tab, the value of File Name in the
Configuration tab will be overriden at runtime.
InputMap
(Optional) Maps the repository and the data source.
Note: The InputMap field also appears in the Configuration tab, each of the two is optional, yet
one of them must be present. If both are present, the value of InputMap in the Configuration tab
will be overriden at runtime.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying the
header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration file
on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of timeout
when the execution takes long time.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Upload And Import 57
|
Output
The output for the activity is listed and described in Table 41.
Table 41 Upload And Import Output
Output Item
Description
Severity
The field can be Error, Warning, or Info.
EventResult
Returns the event result:
Description
•
EventID:
•
EventStatus:
•
EventState:
•
EventStatusDescription:
•
EventStateDescription:
The ID produced by the event.
Returns the status of the event.
Returns the process state of the event.
The description of event status.
The description of event process state.
Returns the description of the upload and import status.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 42.
Table 42 Upload And Import Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
58
| Chapter 3
MDM Palette
Query Work Item
Activity
The Query Work Item activity is used to query work items based on specified search
criteria.
Configuration
The Configuration tab contains the fields shown in Table 43.
Table 43 Query Work Item Configuration
Field
Global
Var?
Description
Name
Yes
(Required) The name of the activity in the process definition.
The default name for the activity is Query Work Item.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
State
Yes
(Optional) Specifies the state of the work items. Work items are filtered based on the
selected work item’s state.
Click the Select button to select one of the following work item states: ALL,
CANCELLED, CLOSED, OPEN, or TIMEDOUT.
Type
Yes
(Optional) Specifies the type of the work items. Work items are filtered based on the
selected work item’s type.
Click the Select button to select one of the following work item types: ALL, Action
Items, or Notifications.
Document Type
Yes
(Optional) Specifies the document type associated with the work item. Work items are
filtered based on the selected work item’s document type.
Click the Select button to open the Document Type dialog. All available document
types are listed in the drop-down list of the dialog. Select one to apply to your current
activity.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Query Work Item 59
|
Table 43 Query Work Item Configuration (Cont’d)
Field
Document
Subtype
Global
Var?
Yes
Description
(Optional) Specifies document subtype associated with the work item. Work items are
filtered based on the selected work item’s document subtype.
Click the Select button to open the Document Subtype dialog. All available document
subtypes are listed in the drop-down list of the dialog. Select one to apply to your
current activity.
Owner
Yes
(Optional) The username of the work item owner. If the owner is not the same as the
user who initiated the web service, the owner must have permissions to view the work
items of other users. Work items are filtered based on the selected work item’s owner.
Click the Select button to open the Owner dialog. All available users are listed in the
drop-down list of the dialog only when the user in the shared resource has the Full
control for work items assigned to other users permission. Select one to apply to
your current activity.
Repository
No
(Optional) The name of the repository associated with the work item. Work items are
filtered based on the selected repository.
Click the Select button to open the Repository dialog. All available repository names
are listed in the drop-down list of the dialog. Select one to apply to your current
activity.
Partner
Yes
(Optional) The name of the partner or backend system.
Show Actions
First
No
(Optional) Check this checkbox to show action work item first. Work item is sorted
based on whether its type is an action item or a notification.
Advanced
The Advanced tab has the following fields as shown in Table 44.
Table 44 Query Work Item Advanced Setting
Field
Filter based on
Record Attribute
Global
Var?
No
Description
(Optional) Check the checkbox to filter work items based on the value of record
attribute.
Note: When this checkbox is checked, the RecordAttribute node appears in
WorkItem in the Input tab.
Filter based on
Custom Attribute
No
(Optional) Check the checkbox to filter work items based on the custom attributes.
Note: When this checkbox is checked, the CustomAttribute node appears in
WorkItem in the Input tab.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
60
| Chapter 3
MDM Palette
Table 44 Query Work Item Advanced Setting (Cont’d)
Global
Var?
Field
Filter based on Key
Word
No
Filter based on
Native Condition
No
Description
(Optional) Check the checkbox to filter work items based on the key word.
Note: When this checkbox is checked, the KeyWord node appears in WorkItem in the
Input tab.
(Optional) Check the checkbox to filter work items based on specified search
conditions.
Note: When this checkbox is checked, the NativeCondition node appears in
WorkItem in the Input tab.
Filter based on Data
Pool
No
(Optional) Check the checkbox to filter work items by data pool.
Note: When this checkbox is checked, the Datapool node appears in WorkItem in
the Input tab.
Input
The input for the activity is listed and described in Table 45.
Table 45 Query Work Item Input
Input Item
WorkItem
Description
Pagination
Date
(Optional) Specifies the pagination of queried work items.
•
StartCount: Specified to achieve windowing/pagination of a large result set.
In combination with MaxCount, you can control the page of the result set
needs to be returned.
•
MaxCount:
Limits the maximum number of work items returned.
(Optional) Specifies the date range of the queried work items. Work items are
filtered based on the date range, and the work item queried are created between
FromDate and ToDate.
•
FromDate: The start datetime when work items are created. The default value
is null.
•
EventReference
ToDate: The end datetime when work items are created. The default value is
the current date.
(Optional) Specifies the event ID used to reference the event. Work items are
filtered based on the Event ID.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Query Work Item 61
|
Table 45 Query Work Item Input (Cont’d)
Input Item
Description
RecordAttribute
(Optional) Specifies the value of record attributes. Work items are filtered based
on the record attribute.
Note: This node appears only when the Filter based on Record Attribute
checkbox is checked in the Advanced tab.
CustomAttribute
(Optional) Specifies user-defined attributes of the queried work items. Work
items are filtered based on the custom attribute.
Note: This node appears only when the Filter based on Custom Attribute
checkbox is checked in the Advanced tab.
KeyWord
(Optional) Keywords are configurated when a work item is created in the
workflow. Work items are filtered based on the tagged keyword.
Note: This node appears only when the Filter based on KeyWord checkbox is
checked in the Advanced tab.
NativeCondition
(Optional) Specifies search condition. You can specify the key along with other
conditions. The condition is applied as AND with other conditions and it is
applied without any processing. If it is invalid, an SQL error is thrown. The
application does not display the error.
For example:
workitemdetail.name ='PRODUCTVERSION' and workitemdetail.value
=‘2'
Note: This node appears only when the Filter based on NativeCondition
checkbox is checked in the Advanced tab.
Datapool
(Optional) Specifies the data pool.
Note: This node appears only when the Filter based on Datapool checkbox is
checked in the Advanced tab.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user
name and password. UserInfo takes effect only when SessionID is invalid or
expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
62
| Chapter 3
MDM Palette
Table 45 Query Work Item Input (Cont’d)
Input Item
Description
_configData
(Optional) The configuration data. You can specify the value of timeout. The
unit is second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the
value of timeout when the execution takes long time.
Output
The output for the activity is listed and described in Table 46.
Table 46 Query Work Item Output
Output Item
Result
Description
Returns the execution result to indicate whether the execution succeeds or not.
The node contains the following three elements:
•
Severity: Can
•
Code:
•
Description:
be Error, Warning, or Info.
The error code.
A readable description of the error.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Query Work Item 63
|
Table 46 Query Work Item Output (Cont’d)
Output Item
Transaction
Description
Response
Returns the response of the transaction:
•
WorkItem: Returns a list of work item information. For each work item, the
WorkItemReference, EventReference, Organization, State,
StateDescription, CreationDate, WorkItemType, Description,
DocumentType, DocumentTypeDescription, DocumentSubtype,
DocumentSubtypeDescription, Owner, OwnerName, OwnerType, OriginalOwner,
OriginalOwnerName, OriginalWorkItemID, TaskType, ActivityName, Age, and
Records related information including MasterCatalogName, ProductID,
ProductIDExt, MODVersion are returned.
•
MasterCatalogName: The name of
•
MODVersion:
•
ResultList:
the repository containing records.
The modification version of the record.
Contains errors, warnings or informational messages. The element
has one or more entries. HighestSeverity returns the highest severity of the
process, it can be Error, Warning, or Info.
See Query Work Item Configuration for more information on other terms.
TransactionR
esult
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not mean the successful completion of the command. However, a failure
does mean that the command is aborted.
The element also captures details such as Result, and SuccessCount.
•
SuccessCount:
Indicates the number of work items that are successfully
processed.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 47.
Table 47 Query Work Item Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
64
| Chapter 3
MDM Palette
Reassign Work Item
Activity
The Reassign Work Item activity is used to reassign work items to other users. When you
own the work item or you have permission to the work item, you can reassign the work
item to another user. The work item is then closed, and a new work item is created for the
target user.
Configuration
The Configuration tab contains the fields shown in Table 48.
Table 48 Reassign Work Item Configuration
Field
Global
Var?
Description
Name
No
(Required) The name of the activity in the process definition.
The default name is Reassign Work Item.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
User
Yes
(Optional) Specifies the user to whom the work item is reassigned.
Click the Select button to open the User dialog. All available users are listed in the
drop-down list of the dialog. Select one to apply to your current activity.
Note: The User node also appears in the Input tab, each of the two is optional, yet one
of them must be present. If both are present, the value in the Configuration tab will be
overriden at runtime.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Reassign Work Item 65
|
Input
The input for the activity is listed and described in Table 49.
Table 49 Reassign Work Item Input
Input Item
Description
Context
(Optional) Specifies the context variables of the activity.
You can specify the value of Name and Value.
WorkItem
WorkItemR
eference
(Required) Specifies the workitem ID to be reassigned.
User
(Optional) Specifies the user to whom the work item is reassigned.
Note: The User field also appears in the Configuration tab, each of the two is optional,
yet one of them must be present. If both are present, the value in the Configuration tab
will be overriden at runtime.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name
and password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is
second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the value of
timeout when the execution takes long time.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
66
| Chapter 3
MDM Palette
Output
The output for the activity is listed and described in Table 50.
Table 50 Reassign Work Item Output
Output Item
Description
Result
Returns the execution result to indicate whether the execution succeeds or not.
The node contains the following three elements:
Transaction
Response
•
Severity: Can
•
Code:
•
Description:
be Error, Warning, or Info.
The error code.
A readable description of the error.
Returns the response of the transaction:
•
WorkItem: Returns a list of work item information. For each work item, the
WorkItemReference, EventReference, Organization, State,
StateDescription, CreationDate, WorkItemType, Description,
DocumentType, DocumentTypeDescription, DocumentSubtype,
DocumentSubtypeDescription, Owner, OwnerName, OwnerType, OriginalOwner,
OriginalOwnerName, OriginalWorkItemID, TaskType, ActivityName, Age, and
Records related information including MasterCatalogName, ProductID,
ProductIDExt, MODVersion are returned.
•
MasterCatalogName: The
•
MODVersion: The modification version
•
ResultList: Contains
name of the repository containing records.
of the record.
errors, warnings or informational messages. The element
has one or more entries. HighestSeverity returns the highest severity of the
process, it can be Error, Warning, or Info.
See Query Work Item Configuration for more information on other terms.
TransactionR
esult
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not mean the successful
completion of the command. However, a failure
does mean that the command is aborted.
The element also captures details such as Result, and SuccessCount.
•
SuccessCount:
Indicates the number of work items that are successfully
processed.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Reassign Work Item 67
|
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 51.
Table 51 Reassign Work Item Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
68
| Chapter 3
MDM Palette
Approve Work Item
Activity
The Approve Work Item activity is used to approve work items, and continue the paused
executions.
Configuration
The Configuration tab contains the fields shown in Table 52.
Table 52 Approve Work Item Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Approve Work Item.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Approve All
No
(Optional) Check this checkbox to approve all the work items.
Note: Maximum Count and Repository fields display only when the Approve All
checkbox is checked. And when this checkbox is not checked, the
WorkItemReference node is added in WorkItem in the Input tab.
Maximum Count
No
(Optional) The maximum number of work items that you want to approve. The default
value is 20.
Note: This field displays only when the Approve All checkbox is checked.
Repository
No
(Optional) Specifies the repositories related to the work items that you want to
approve. Click the Select button to open the Repository dialog. All available
repositories are listed in the drop-down list of the dialog. Select one to apply to your
current activity. The default value All means selecting all the available repositories.
Note: This field displays only when the Approve All checkbox is checked.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Approve Work Item 69
|
Advanced
The Advanced tab has the following fields as shown in Table 53.
Table 53 Approve Work Item Advanced Setting
Field
Specify Custom
Attributes
Global
Var?
No
Description
(Optional) Check this checkbox to specify custom attributes for work items, that is,
user-defined attributes.
Note: When this checkbox is checked, the CustomAttributes node appears in
WorkItem in the Input tab.
Input
The input for the activity is listed and described in Table 54.
Table 54 Approve Work Item Input
Input Item
Description
Context
(Optional) Specifies the context variables of the activity.
You can specify the value of Name and Value.
WorkItem
WorkItemRefe
rence
(Optional) Specifies the workitem ID that you want to approve.
Note: The WorkItemReference node appears only when the Approve All
checkbox is not checked in the Configuration tab.
ReasonCode
(Optional) Provides a reason code for the work item approval operation.
Comment
(Optional) Provides a comment for work item approval operation.
CustomAttribu
tes
(Optional) Specifies custom attributes for work items, that is, user-defined
attributes. You can specify the value of the Name and Value.
Note: The CustomAttributes node appears only when the Specify Custom
Attributes checkbox is checked in the Advanced tab.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user
name and password. UserInfo takes effect only when SessionID is invalid or
expired.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
70
| Chapter 3
MDM Palette
Table 54 Approve Work Item Input
Input Item
Description
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit
is second.
Note: The default timeout value of HTTP on Axis2 is 30 seconds. Increase the
value of timeout when the execution takes long time.
Output
The output for the activity is listed and described in Table 55.
Table 55 Approve Work Item Output
Output Item
Description
Result
Describes what error occurred. It is aimed, primarily, at the user who has to interpret
why the message failed.
The node contains the following three elements:
Transaction
Response
•
Severity:
•
Code:
•
Description:
The error code.
A readable description of the error.
Returns the response of the transaction:
•
TransactionR
esult
Can be Error, Warning, or Info.
ResultList: Contains
errors, warnings or informational messages. The element
has one or more entries. HighestSeverity returns the highest severity of the
returned work items, it can be Error, Warning, or Info.
Returns the result of a transaction to indicate if the command succeeds or fails.
does not mean the successful completion of the command. However, a failure
does mean that the command is aborted.
Success
The element also captures details such as Result and SuccessCount.
•
SuccessCount:
Indicates the number of work items that are successfully processed.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Approve Work Item 71
|
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed inTable 56.
Table 56 Approve Work Item Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
72
| Chapter 3
MDM Palette
Reject Work Item
Activity
The Reject Work Item activity is used to reject work items, and cancel all the operations
related to the work items.
Configuration
The Configuration tab contains the fields shown in Table 57.
Table 57 Reject Work Item Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Reject Work Item.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Reject All
No
(Optional) Check this checkbox to reject all the work items.
Note: Maximum Count and Repository fields display only when the Reject All
checkbox is checked. And when this checkbox is not checked, the
WorkItemReference node is added in WorkItem in the Input tab.
Maximum Count
No
(Optional) The maximum number of work items rejected. The default value is 20.
Note: This field displays only when the Reject All checkbox is checked.
Repository
No
(Optional) Specifies the repositories related to the work items that you want to reject.
Click the Select button to open the Repository dialog. All available repositories are
listed in the drop-down list of the dialog. Select one to apply to your current activity.
The default value All means selecting all the available repositories.
Note: This field displays only when the Reject All checkbox is checked.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Reject Work Item 73
|
Advanced
The Advanced tab has the following fields as shown in Table 58.
Table 58 Reject Work Item Advanced Setting
Field
Specify Custom
Attributes
Global
Var?
No
Description
(Optional) Check this checkbox to specify custom attributes for work items, that is,
user-defined attributes.
Note: When this checkbox is checked, the CustomAttributes node appears in
WorkItem in the Input tab.
Input
The input for the activity is listed and described in Table 59.
Table 59 Reject Work Item Input
Input Item
Description
Context
(Optional) Specifies the context variables of the activity.
You can specify the value of Name and Value.
WorkItem
WorkItemRef
erence
(Optional) Specifies the workitem ID that you want to reject.
Note: The WorkItemReference node appears only when the Reject All
checkbox is not checked in the Configuration tab.
ReasonCode
(Optional) Provides a reason code for the work item rejection operation.
Comment
(Optional) Specifies the comment for work item rejection operation.
CustomAttrib
utes
(Optional) Specifies custom attributes for work items, that is, user-defined attributes.
You can specify the value of Name and Value.
Note: The CustomAttributes node appears only when the Specify Custom
Attributes checkbox is checked in the Advanced tab.
SendForCorre
ctions
(Optional) Sends the record for corrections if you have rejected any work item.
The value 0 means it will not send for corrects, and the value 1 means it will send for
corrections.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user
name and password. UserInfo takes effect only when SessionID is invalid or
expired.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
74
| Chapter 3
MDM Palette
Table 59 Reject Work Item Input (Cont’d)
Input Item
Description
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is
second.
Output
The output for the activity is listed and described in Table 60.
Table 60 Reject Work Item Output
Output Item
Description
Result
Describes what error occurred. It is aimed, primarily, at the user who has to interpret
why the message failed.
The node contains the following three elements:
•
Severity: Can be Error, Warning, or Info.
•
Code:
•
Description:
The error code.
A readable description of the error.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Reject Work Item 75
|
Table 60 Reject Work Item Output (Cont’d)
Output Item
Transaction
Description
Response
TransactionR
esult
Returns the response of the transaction:
•
WorkItem: Returns
a list of work item information. For each work item, the
WorkItemReference, EventReference, Organization, State, StateDescription,
CreationDate, WorkItemType, Description, DocumentType,
DocumentTypeDescription, DocumentSubtype, DocumentSubtypeDescription,
Owner, OwnerName, OwnerType, OriginalOwner, OriginalOwnerName,
OriginalWorkItemID, TaskType, ActivityName, Age, and Records related
information including MasterCatalogName, ProductID, ProductIDExt,
MODVersion are returned.
•
MasterCatalogName:
•
MODVersion: The modification
•
ResultList: Contains errors, warnings or informational messages. The element
has one or more entries. HighestSeverity returns the highest severity of the
returned work items, it can be Error, Warning, or Info.
The name of the repository containing records.
version of the record.
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not mean the successful completion of the command. However, a failure
does mean that the command is aborted.
•
SuccessCount:
Indicates the number of work items that are successfully
processed.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 61.
Table 61 Reject Work Item Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
76
| Chapter 3
MDM Palette
Close Work Item
Activity
The Close Work Item activity is used to close notification work items.
Configuration
The Configuration tab contains the fields shown in Table 62.
Table 62 Close Work Item Configuration
Field
Global
Var?
Description
Name
No
(Required) The name of the activity in the process definition.
The default name is Close Work Item.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Close All
No
(Optional) Check this checkbox to close all the work items.
Note: Maximum Count and Repository fields display only when the Close All
checkbox is checked. And when this checkbox is not checked, the
WorkItemReference node is added in WorkItem in the Input tab.
Maximum Count
No
(Optional) The maximum number of work items closed. The default value is 20.
Note: This field displays only when the Close All checkbox is checked.
Repository
No
(Optional) Specifies the repositories related to the work items that you want to close.
Click the Select button to open the Repository dialog. All available repositories are
listed in the drop-down list of the dialog. Select one to apply to your current activity.
The default value All means selecting all the available repositories.
Note: This field displays only when the Close All checkbox is checked.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Close Work Item 77
|
Advanced
The Advanced tab has the following fields as shown in Table 63.
Table 63 Close Work Item Advanced Setting
Field
Specify Custom
Attributes
Global
Var?
No
Description
(Optional) Check this checkbox to specify custom attributes for work items, that is,
user-defined attributes.
Note: When this checkbox is checked, the CustomAttributes node appears in
WorkItem in the Input tab.
Input
The input for the activity is listed and described in Table 64.
Table 64 Close Work Item Input
Input Item
WorkItem
Description
WorkItemRefe
rence
(Optional) Specifies the workitem ID that you want to close.
Note: The WorkItemReference node appears only when the Close All
checkbox is not checked in the Configuration tab.
ReasonCode
(Optional) Provides a reason code for the work item close operation.
Comment
(Optional) Specifies the comment for work item close operation.
CustomAttribu
tes
(Optional) Specifies custom attributes for work items, that is, user-defined
attributes. You can specify the value of the Name and Value.
Note: The CustomAttributes node appears only when the Specify Custom
Attributes checkbox is checked in the Advanced tab.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user
name and password. UserInfo takes effect only when SessionID is invalid or
expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When
specifying the header, you need to set the value of the Webservice SOAP Header
Extractor com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the
configuration file on the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
78
| Chapter 3
MDM Palette
Table 64 Close Work Item Input
Input Item
Description
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit
is second.
Output
The output for the activity is listed and described in Table 65.
Table 65 Close Work Item Output
Output Item
Description
Result
Describes what error occurred. It is aimed, primarily, at the user who has to interpret
why the message failed.
The node contains the following three elements:
Transaction
Response
•
Severity:
•
Code:
•
Description:
The error code.
A readable description of the error.
Returns the response of the transaction:
•
TransactionR
esult
Can be Error, Warning, or Info.
ResultList:
Contains errors, warnings or informational messages. The element
has one or more entries. HighestSeverity returns the highest severity of the
returned work items, it can be Error, Warning, or Info.
Returns the result of a transaction to indicate if the command succeeds or fails.
Success does not
mean the successful completion of the command. However, a failure
does mean that the command is aborted.
The element also captures details such as Result, and SuccessCount.
•
SuccessCount:
Indicates the number of work items that are successfully
processed.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 66.
Table 66 Close Work Item Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Close Work Item 79
|
Table 66 Close Work Item Error Output
MDMPluginException
Description
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
80
| Chapter 3
MDM Palette
Get Event Detail
Activity
The Get Event Detail activity is used to get event information for a specified event ID. The
event details displayed in the Event Log are retrieved.
Configuration
The Configuration tab contains the fields shown in Table 67.
Table 67 Get Event Detail Configuration
Field
Global
Var?
Description
Name
Yes
(Required) The name of the activity in the process definition.
The default name is Get Event Detail.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Input
The input for the activity is listed and described in Table 68.
Table 68 Get Event Detail Input
Input Item
Description
EventId
(Required) ID of the event whose details are to be retrieved.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Get Event Detail 81
|
Table 68 Get Event Detail Input (Cont’d)
Input Item
Description
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying the
header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration file
on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is second.
Output
The output for the activity is listed and described in Table 69.
Table 69 Get Event Detail Output
Output Item
Description
Event
Returns information on event Id, EventName, Status, State, StartOn, RepositoryName,
BackendSystem, Process, and Error.
•
Process: The response message contains the event Id, Description, WfName, FileLocation,
AdditionalInfo, and ProcessLog.
•
Error: Returns error message, including ErrorCode, and ErrorMessage.
See the TIBCO MDM documentation for more information on those items.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 70.
Table 70 Get Event Detail Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
82
| Chapter 3
MDM Palette
Get Import Event Detail
Activity
The Get Import Event Detail activity is used to get import event information for a
specified event ID. The event details displayed in the Event Log are retrieved.
Configuration
The Configuration tab contains the fields shown in Table 71.
Table 71 Get Import Event Detail Configuration
Field
Global
Var?
Description
Name
Yes
(Required) The name of the activity in the process definition.
The default name is Get Import Event Detail.
Description
No
(Optional) Brief description of the activity.
Click the
MDM Connection
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
Input
The input for the activity is listed and described in Table 72.
Table 72 Get Import Event Detail Input
Input Item
Description
EventId
(Required) ID of the event whose details are to be retrieved.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Get Import Event Detail 83
|
Table 72 Get Import Event Detail Input (Cont’d)
Input Item
Description
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying the
header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration file
on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is second.
Output
The output for the activity is listed and described in Table 73.
Table 73 Get Import Event Detail Output
Output Item
Event
Description
Returns information on event Id, EventName, Status, State, StartOn, RepositoryName,
Process, and Error.
•
Process: The response message contains the event Id, Description, WfName, FileLocation,
AdditionalInfo, and ProcessLog.
•
Error: Returns error message, including ErrorCode, and ErrorMessage.
See the TIBCO MDM documentation for more information on those items.
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 74.
Table 74 Get Import Event Detail Error Output
MDMPluginException
Description
msg
The error message description returned by the plug-in.
msgCode
The error code returned by the plug-in.
serverMsg
The error message description returned by the MDM server.
serverMsgCode
The error code returned by the MDM server.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
84
| Chapter 3
MDM Palette
Wait For Event Completion
Activity
The Wait For Event Completion activity is used to wait for an event to complete until it
reaches the SUCCESS status or the specified timeout value.
Configuration
The Configuration tab contains the fields shown in Table 75.
Table 75 Wait For Event Completion Configuration
Field
Global
Var?
Name
No
Description
(Required) The name of the activity in the process definition.
The default name is Wait For Event Completion.
Description
No
(Optional) Brief description of the activity.
Click the
MDM
Connection
Yes
Timeout
Yes
button to add description in the Description dialog.
(Required) Specifies the connection information used to connect to an MDM server.
Click the
button to open the Select A Resource dialog. All available resources are
listed in the dialog. Select one to apply to your current activity.
(Optional) Specifies a timeout value in seconds during the waiting. The default value is
3600.
Note: It will be overridden by the value of Timeout in the Input tab at runtime.
Interval
Yes
(Optional) Specifies the time interval in seconds to execute operations. The default value is
5.
Note: It will be overridden by the value of Interval in the Input tab at runtime.
Input
The input for the activity is listed and described in Table 76.
Table 76 Wait For Event Completion Input
Input Item
Description
EventId
(Required) The event IDs waiting for completion.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Wait For Event Completion 85
|
Table 76 Wait For Event Completion Input
Input Item
Description
Timeout
(Optional) Specifies a timeout value in seconds during the waiting process.
Note: It will override the value of Timeout in the Configuration tab at runtime.
Interval
(Optional) Specifies the time interval to execute operations in seconds.
Note: It will override the value of Interval in the Configuration tab at runtime.
SessionID
(Optional) Specifies the session ID. SessionID takes precedence over UserInfo.
UserInfo
(Optional) Specifies the information of the user, including company name, user name and
password. UserInfo takes effect only when SessionID is invalid or expired.
MessageHeaders
(Optional) The header of a message. Only HTTP headers are supported. When specifying the
header, you need to set the value of the Webservice SOAP Header Extractor
com.tibco.cim.authentication.webservice.headerExtractor to
com.tibco.cim.authentication.DefaultHttpHeaderExtractor in the configuration file
on the MDM server.
_configData
(Optional) The configuration data. You can specify the value of timeout. The unit is second.
Output
The output for the activity is listed and described in Table 77.
Table 77 Wait For Event Completion Output
Output Item
Description
Event
The response message contains the event Id, Type, Status, State, StartOn, BackendSystem, and
Event Summary. The Event Summary is different for each event type, mainly include Type, Name,
Description, and Value attributes.
The event details returned depend on the type of the event. For example, the event summary
information is returned only for the events that have a summary. If there is a file attribute in the
summary information path, the document ID for the attribute is returned. The user uses this
document ID to download the document by using the contentService. If the event ID is not found,
Event does not exist or is executed in memory, and no other details available message is returned.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
86
| Chapter 3
MDM Palette
Error Output
The Error Output tab lists the exceptions that can be thrown by this activity, the detailed
information is listed in Table 78.
Table 78 Wait For Event Completion Error Output
ActivityErrors
Description
MDMPluginException
Error Outputs:
ActivityTimedOutException
•
msg: The error message description returned by the plug-in.
•
msgCode: The error code returned by the plug-in.
•
serverMsg: The error message description returned by the MDM server.
•
serverMsgCode: The error code returned by the MDM server.
Error Outputs:
•
msg: Activity timeout error message description.
•
msgCode: The error code of TIBCO ActiveMatrix BusinessWorks.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
| 87
Chapter 4
Using Sample Project
This chapter describes the sample project packaged with TIBCO ActiveMatrix
BusinessWorks Plug-in for MDM. Working through the sample project helps you
understand how TIBCO ActiveMatrix BusinessWorks Plug-in for MDM works.
Topics
•
Overview of Sample Project, page 88
•
MDMPluginSamples Project, page 89
•
Upload-Import-Approve-Query Process, page 89
•
Search Address Process, page 91
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
88
| Chapter 4
Using Sample Project
Overview of Sample Project
The MDMPluginSamples project associated with TIBCO ActiveMatrix BusinessWorks
Plug-in for MDM installation demonstrates the use of the plug-in. It is located in the
TIB_bwpluginmdm_HOME\sample directory.
The project includes one shared resource and the following two processes:
•
Upload-Import-Approve-Query Process
•
Search Address Process
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
MDMPluginSamples Project 89
|
MDMPluginSamples Project
The MDMPluginSamples project shows how to use TIBCO ActiveMatrix BusinessWorks
Plug-in for MDM to configure shared resources, how to operate on records, data sources,
work items, and events. This project contains two processes:
Upload-Import-Approve-Query, and Search Address.
Precondition
Before running the two processes, import SampleAddress.xml, and PersonAccount.xml to
the MDM server respectively. The two files are put in the ModelMetadata.zip file in the
sample folder.
Upload-Import-Approve-Query Process
This process demonstrates how to upload external record data to the MDM server and
query the uploaded records.
Figure 3 illustrates the Upload-Import-Approve-Query process definition.
Figure 3 The Upload-Import-Approve-Query Process
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
90
| Chapter 4
Using Sample Project
The activities in the process are described in Table 79.
Table 79 Upload-Import-Approve-Query Process Activities
Activity
Description
Start
Starts the process.
Upload Data Source
Uploads record data to the specified data source.
Import Records
Imports records to the selected S_ADDRESS repository by using the input map.
Sleep
Waits 20 seconds until the Import Records event reaches the In Process status.
Get Import Event Detail-1
Checks whether the Import Records event reaches the In Process status.
Approve Work Item
Approves the generated work items.
Get Import Event Detail-2
Checks whether the Import Records event reaches the Success status.
Query Records
Queries records based on the filter criteria.
End
Ends the process.
Setting Up the Sample Project in TIBCO Designer
To set up this sample project, complete the following tasks:
1. Start TIBCO Designer.
2. Click the Open Existing Project button from the Project menu.
3. Click the
button in the Open Project dialog to locate the sample project, then click
the OK button.
4. The MDMPluginSamples project is displayed in the Project panel.
Running the Upload-Import-Approve-Query Process
After setting up the project, complete the following steps to run the process:
1. Create a new rule for Import Approval on the MDM server, set the The repository
field to S_ADDRESS, set the Set the participant user to field to the current username,
and set the Set the next work item state to field to Final Step/Done.
2. Configure the Project_Home global variable in the designer. Project_Home is the
absolute path of the root directory of the project.
3. Click the Tester tab on the left of the Project panel to open the Test panel.
4. Click the
button. The Selected Processes To Load dialog appears.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
MDMPluginSamples Project 91
|
5. Select the Upload-Import-Approve-Query process and click the Load Selected button.
The process starts.
6. Click the
button to stop the testing and return to Design mode.
See TIBCO BusinessWorks Process Design Guide for detailed information on using test
mode and setting breakpoints.
Expected Result
If the process performs successfully, all the transition lines change to green. The record
data in the file is uploaded and imported into the S_ADDRESS repository, and you can query
the records in it.
Search Address Process
This process demonstrates how to conduct similarity searches.
Figure 4 illustrates the Search
Address
process definition.
Figure 4 The Search Address Process
The activities in the process are described in Table 80.
Table 80 Search Address Process Activities
Activity
Description
Start
Starts the process.
Search Address
Finds and retrieves records close to an existing indexed term based on the indexed
repository specified in the search.
End
Ends the process.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
92
| Chapter 4
Using Sample Project
Setting Up the Sample Project in TIBCO Designer
To set up this sample project, complete the following tasks:
1. Start TIBCO Designer.
2. Click the Open Existing Project button from the Project menu.
3. Click the
button in the Open Project dialog to locate the sample project, then click
the OK button.
4. The MDMPluginSamples project is displayed in the Project panel.
Running the Search Address Process
After setting up the project, complete the following steps to run the process:
1. Enable Text Search feature on the MDM server first.
2. Click the Tester tab on the left of the Project panel to open the Test panel.
3. Click the
button. The Selected Processes To Load dialog appears.
4. Select the Search
starts.
5. Click the
Address
process and click the Load Selected button. The process
button to stop the testing and return to Design mode.
See TIBCO BusinessWorks Process Design Guide for detailed information on using test
mode and setting breakpoints.
Expected Result
If the process performs successfully, all the transition lines change to green. A number of
matching records are retrieved.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
| 93
Appendix A
Managing MDM Logs
This appendix describes how to manage MDM logs.
Topics
•
Managing Logs, page 94
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
94
| Appendix A
Managing MDM Logs
Managing Logs
Logs are used to trace and troubleshoot the plug-in exceptions at design time and runtime.
You can specify the log level, the log filename, and the output destination for trace
messages. To check debug information, see log properties listed in Table 81.
See the TIBCO ActiveMatrix BusinessWorks documentation for detailed information
about logs.
Table 81 Log Property
Property
Description
com.tibco.plugin.mdm.debug
The debug role properties of the plug-in. The default value is False.
Only when bwengine property Trace.Debug.*=true and
com.tibco.plugin.mdm.debug=true, it will display debug info.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Trace Messages 95
|
Appendix B
Trace Messages
This appendix lists the error messages used by TIBCO ActiveMatrix BusinessWorks
Plug-in for MDM.
Topics
•
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM Error Messages, page 96
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
96
| Appendix B
Trace Messages
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM Error
Messages
BW-MDM-200000: [%1]
Role: infoRole
Category: BW-Plugin
Description: Describes the general Info information.
Resolution: No action.
BW-MDM-200001: [%1] is done ([%2]ms)
Role: infoRole
Category: BW-Plugin
Description: Indicates the activity is successfully done in [%2] milliseconds.
Resolution: No action.
BW-MDM-300000: [%1]
Role: warnRole
Category: BW-Plugin
Description: Describes the general Warn information.
Resolution: No action.
BW-MDM-400000: [%1]
Role: errorRole
Category: BW-Plugin
Description: Describes the general Error information.
Resolution: No action.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
TIBCO ActiveMatrix BusinessWorks Plug-in for MDM Error Messages 97
|
BW-MDM-400001: Runtime error: [%1]
Role: errorRole
Category: BW-Plugin
Description: Occurs at runtime.
Resolution: No action.
BW-MDM-400002: Resolve shared resource error: [%1]
Role: errorRole
Category: BW-Plugin
Description: The shared resource is not specified or connected to non-registered users.
Resolution: Specifies the shared resource or restart the designer.
BW-MDM-400003: Repository is missing, please specify repository.
Role: errorRole
Category: BW-Plugin
Description: Occurs when the Repository is not specified.
Resolution: Specifies the Repository in the Configuration tab.
BW-MDM-400004: Metadata is not found, please reconfigure activity.
Role: errorRole
Category: BW-Plugin
Description: Occurs when the specified Metadata is not found.
Resolution: Reconfigures the activity and selects a repository model.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
98
| Appendix B
Trace Messages
BW-MDM-400005: Text Search expression is not specified.
Role: errorRole
Category: BW-Plugin
Description: Occurs when the text search expression is not specified.
Resolution: Specifies the text search expression in the Input tab.
BW-MDM-400006: Invalid SimilarityScore [%1], the value must be between 0 and 1.0.
Role: errorRole
Category: BW-Plugin
Description: Occurs when the specified SimilarityScore is invalid.
Resolution: Specifies the value of SimilarityScore between 0 and 1.0 in the Input tab.
BW-MDM-400007: Invalid weight value [%1], the value must be between 0 and 1.0.
Role: errorRole
Category: BW-Plugin
Description: Occurs when the specified weight of the attribute is invalid.
Resolution: Specifies the value of attribute weight between 0 and 1.0.
BW-MDM-400008: Parse data error: [%1]
Role: errorRole
Category: BW-Plugin
Description: Occurs when parsing data at runtime.
Resolution: Check and make sure the input data is correct.
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
| 99
Index
A
E
activities 16
add record
classify records manually 22
command qualifier 21
file type attributes 21
record state 20
approve work item 68
approve all 68
comment 69
custom attributes 69
maximum count 68
reason code 69
specify custom attributes 69
effectivedate 35
error messages 96
event group 4
execution mode 21, 25, 39, 49, 52, 55
G
get data source 46
data source 46
data source info 47
datasource 46
get event detail 80
eventId 80
get import event detail 82
eventId 82
C
close work item 76
close all 76
comment 77
custom attributes 77
maximum count 76
reason code 77
specify custom attributes 77
configdata 23, 29, 37, 41, 44, 47, 50, 53, 56, 62, 65, 70, 74,
78, 81, 83, 85
customer support xvii
I
import records 52
input map 52
inputmap 53
J
JSSE 19
D
data source group 4
delete record 39
command qualifier 40
delete future effective dated version 40
L
log properties 94
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
100
| Index
logs 94
M
managing MDM logs 93
MDM connection 18, 20, 25, 39, 43, 46, 49, 52, 55, 58, 64,
68, 72, 76, 80, 82, 84
company name 18
encrypt password 18
MDM server url 18
password 18
user name 18
MDM connection shared resource 4
MDM palette 16
MDMPlugin samples project 89
search address process 91
upload-import-approve-query process 89
messageheaders 23, 29, 37, 41, 44, 47, 50, 53, 56, 61, 65,
70, 74, 77, 81, 83, 85
modify record 25
classify records manually 27
command qualifier 26
file type attributes 26
modify future effective dated version 27
modify in work item context 27
msg 24, 31, 38, 42, 45, 47, 51, 54, 57, 63, 67, 71, 75, 78,
81, 83, 86, 86
msgcode 24, 31, 38, 42, 45, 48, 51, 54, 57, 63, 67, 71, 75,
79, 81, 83, 86, 86
P
Q
query record 32
active 34
classification 35
command qualifier 33
file type attributes 33
future dated record 34
output map 33
pagination 35
perspective 32
query based on classification scheme 34
record state 33
record_moddate 36
return 36
query work item 58
custom attribute 61
data pool 61
document subtype 59
document type 58
event reference 60
filter based on custom attribute 59
filter based on data pool 60
filter based on key word 60
filter based on native condition 60
filter based on record attribute 59
key word 61
native condition 61
owner 59
pagination 60
partner 59
record attribute 61
show actions first 59
state 58
type 58
plug-in 4
R
reassign work item 64
user 64, 65
record group 4
record version 28, 36, 41
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Index 101
|
U
reject work item 72
comment 73
custom attributes 73
maximum count 72
reason code 73
reject all 72
send for corrections 73
specify custom attributes 73
repository 20, 25, 32, 39, 43, 52, 55, 59, 68, 72, 76
upload and import 55
file name 56
filename 56
input map 55
inputmap 56
upload data source 49
data source 49
file name 49
filename 50
userinfo 23, 29, 36, 41, 44, 47, 50, 53, 56, 61, 65, 69, 73,
77, 80, 82, 85
S
servermsg 24, 31, 38, 42, 45, 48, 51, 54, 57, 63, 67, 71, 75,
79, 81, 83, 86
servermsgcode 24, 31, 38, 42, 45, 48, 51, 54, 57, 63, 67, 71,
75, 79, 81, 83, 86
sessionID 23, 29, 36, 41, 44, 47, 50, 53, 56, 61, 65, 69, 73,
77, 80, 82, 85
shared resource 16
SSL connection 19
T
W
wait for event completion 84
activitytimedoutexception 86
eventId 84
interval 84, 85
MDMPluginexception 86
timeout 84, 85
work item group 4
workitemreference 73, 77
text search 43
expression 44
index configuration file 43
index entity 43
return count 44, 45
start count 44, 45
total count 44, 45
search score 45
search score string 45
similarityscore 44
weight 44
TIB_bwpluginmdm_HOME xv
TIBCO MDM 2
TIBCO_HOME xv
TIBCO_JRE_HOME xv
trace messages 95
TIBCO ActiveMatrix BusinessWorks™ Plug-in for MDM User’s Guide
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement