TIBCO ActiveMatrix® BPM Business Data Services

Software Release 1.2 September 2011

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. TIB, TIBCO, TIBCO Adapter, Predictive Business, Information Bus, The Power of Now, TIBCO ActiveMatrix, TIBCO ActiveMatrix Administrator, TIBCO Business Studio, TIBCO Enterprise Message Service, TIBCO Spotfire, and TIBCO Silver are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. Copyright © 2005-2011 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Changes from the Previous Release of this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . x Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Business Data Services Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv How to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv

Chapter 1 Introduction to BDS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Business Data Services (BDS) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Chapter 2 Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Object Orientation (OO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 BOM Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7 Business Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Business Object Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Business Object Creation by Factory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Retrieving and Setting Business Object Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Invoking Operations on Business Object Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 BOM Relationships and Process Local Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Composition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Specialization and Generalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Assignment by Value and by Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 BOM Native Type or Primitive Type Object to Business Object Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Assigning a Business Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Assigning a Basic Type Object to a Process Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 The Significance of the Script Boundary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

Chapter 3 Business Data Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19
UML Relationships Supported by Process Local Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 BOM Native Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Business Data Services Guide

iv

|

Contents

Value Spaces for BOM Native Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Creating a Business Object Model (BOM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating User-defined BOMs in the Business Objects Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing XSDs and WSDLs into Business Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing WSDLs into the Service Descriptors Folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing a WSDL when Defining a Web Service Task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Generating a WSDL for a Web Service You Are Creating . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BOM Design-time Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Primitive Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Regular Expression Patterns for Text Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Multiplicity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Size Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BOM Labels and Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Label to Name Algorithm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BOM Class Label and Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BOM Attribute Label and Name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BOM Package Label and Name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reserved Words . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Name Clashes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 25 25 26 28 28 29 29 29 32 32 33 34 35 36 37 37 38 39

Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM . . . . . . . . . . . . . . . . . . . 40
BDS Plug-in Generation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 BDS Design-time Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Validations in BOM Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Process Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 BDS Runtime Validations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 BOM Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Process Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Compatible Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Using BDS in Tasks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 50 50 50 51

Business Data Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Supplying xsi:type Information in XML Sent to TIBCO BPM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Chapter 5 Business Data Scripting by Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56 Factories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Business Data Services Guide

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 Working with Strings or Text Fields . . . . . . . . . . . . . . . . . . 117 Working with Fixed Length Integers (BigInteger) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Working with Enumerated Types (ENUMs) . . . . . . . . . . . . . . . . . . . . . . 112 Parse Functions . . . . 84 Removing an Item from a List or a Containment Relationship . . . . . . . . . . . . . . . . . . . . . . . 78 Looping Through Lists and Copying Elements in Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Create a Copy of a Business Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Working with Basic Decimal Numbers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Using Date and Time Types with Durations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Working with Basic Integer Numbers. . . . . . . . . . 99 Durations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Passing Arrays to Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122 Business Data Services Guide . . . . . . . . . . . . . . . . . . . . 118 Working with Fixed Decimals (BigDecimal) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59 Create an Instance of a Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .Contents v | Creating a New Business Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Loops Within Scripts . . . . . . . . . 80 Scripting Containment Relationships . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Return Values from Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Working with Single Instance Attributes of Business Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Using the Special Value Null . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91 Working with Booleans . . . . . . . . . . . . . . . . . . . . . . . 97 Working with Dates and Times . . . 115 Chapter 6 Advanced Scripting Examples . . . . . . . . . . . . . . . . . . . . . . . 70 In a Process Data Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Working with Primitive Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85 Scripting on Business Objects That Use Inheritance. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Using the List set() Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 Multiple Instances of a BOM Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70 In a BOM Class Attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 parseInt() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Checking for Null Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Scripting with Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74 Working with Temporary Variables and Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Dates and Times . . . . . . 65 Using Content Assist . . . . . . . . . . . . . . . . . . 115 parseFloat() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Comparing Dates and Times . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Assigning a Null Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . Use the Process Debugger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .vi | Contents Creating and Initializing Fixed Decimal Values . . . . . . . . . . . Examine the Server Logs . . . . . Check for Nulls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150 Troubleshooting BDS Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . encodeURI() and decodeURI() . . . . Simple Operations . . . Catch Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Keep the Scripts Small. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 146 146 146 146 146 Chapter 8 Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 Choose Appropriate Data Types . . . . . 122 122 123 126 Object BOM Native Type. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139 Process Data Field Granularity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BDS Classes Do Not Appear or Changes Do Not Appear. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132 Additional Javascript Global Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Write Variable Values and Progress Updates from the Script to the BPM Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Rounding . . . . . . . . . . . . . encodeURIComponent() and decodeURIComponent() . . . . . . . . . . . . . . . . . . Use Constant First when Comparing a Constant with a Variable . . . . . 140 BOM Class. . . . . . . . . . . . 141 Reference a Common Business Object Model . . . . . . . . . . . . . . . . 138 Use Sub-Packages to Aggregate Related Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129 Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Comparing Fixed Decimals and BigDecimals . . . . . . . . escape() and unescape() . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Attribute and Variable Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144 Do Not Modify Generated BOMs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Use Comments in Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 Viewing BDS-generated BDS Plug-in Hidden Projects. 151 151 151 151 152 153 153 154 Business Data Services Guide . . . . . . . . . . . 134 134 134 135 Chapter 7 Business Data Modeling Best Practice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 BDS Plug-in Generation Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131 Object BOM Native Type and ScriptUtil. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142 Do Not Split a Namespace Across Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .setObject() . . . . . . . . . . . . . . . . . . . . . . . . 145 Business Data Scripting Best Practice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . eval() . . . Ensure Business Objects Are Valid Before Scripts Complete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Break Script into Smaller Scripts . . . . . . . . . . . . . . . . . . . . . . 129 Using the Object BOM Native Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Fixed Attribute Overwrite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .155 Data Type Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 try/catch Statement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Nested xsd:any in Sequences . . . . . . . . . . . . . . . . 165 xsd:any "##local" . . . . . . . . . . . 170 Converting Values Between Different BOM Attribute Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 JavaScript Features not Supported in TIBCO BPM Scripting . . . . . . . . . . 160 Process Primitive Data Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 JavaScript Arrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 BOM Native Type to BDS Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179 Reserved Words in Scripts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Fixed Point Decimal (BigDecimal) Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181 Static Factory Methods . Datetime and Datetimetz (XMLGregorianCalendar) Methods . . . . . . 178 Using If. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 JavaScript Functions . . . . . . . . 166 Restrictions between Complex Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167 Recurring Elements in Sequence . . . . . . . 170 Mapping to or from Process Basic Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 BDS and Forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 DateTimeUtil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . and While Expressions . . . . . . . . . . . . . . . . . . . . . . 178 JavaScript RegExp Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157 JDBC Database Type to BOM Data Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 The "block" Function . . . . . . . . . 197 Duration Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . For. . . . .Contents vii | Appendix A Supplemental Information . . . . . . . . . . . . . . . . 164 Multiplicity at the Sequence or Choice Level . . . . . . . . . . . . . . . . . . . and String Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156 XSD Type to BDS Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177 New Operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182 ScriptUtil . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Fixed Length Integer (BigInteger) Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178 "==="operator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 165 Group Multiplicity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164 Simple Type Default Values . . . . 180 Appendix B Business Data Scripting . . . . . . . . 162 Unsupported XSD Constructs . . . . . . . . . . . . . . . . . . . . . . . 186 BOM Native Type Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202 Business Data Services Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . 168 Data Mapping . . . . Date and Time. . . . . . . . . 177 Switch Statement . . . . . . . . . . . . . . . . . 192 Date. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185 IpeScriptUtil (and ScriptUtil) Conversion. . . . . . . . . . . . . . . . . . . . . . . . . 163 BDS Limitations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii | Contents Text (String) Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203 Other Supported Methods. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 List Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210 Appendix D Work Item Scripting . . . . 209 Process Instance Attributes and Methods. . . . . . . . . . . . . . . . . . . . . 205 Other JavaScript Functions . . . . . . . . . . . . . . . . 215 OrgModel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204 ListIterator Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 Appendix C Process Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 Math Methods . . . . . . . 214 WorkItem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213 WorkManagerFactory . . . . . . . . . . . . . . . . . . . . . 223 Business Data Services Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Work Item Scripting – an extension that allows access to the attributes of and control over a work item (see Appendix D.| ix Preface This guide describes how to use Business Data Services (BDS). The focus of this guide is on the Business Data aspects of server-side scripting. page xiv Business Data Services Guide . The following areas are covered only briefly: • Process Scripting – an extension that allows access to the attributes of and control over a process instance (see Appendix C. refer to Related Documentation. page xii Connecting with TIBCO Resources. OrgModel Scripting – an extension that allows access to the Organization Model (see Appendix D.5. a component of TIBCO ActiveMatrix® BPM. page xi Typographical Conventions. Topics • • • • Changes from the Previous Release of this Guide. This guide does not cover the following: • • Forms Scripting – a different scripting variant used when running forms (client-side scripting). This guide describes the use of TIBCO ActiveMatrix BPM and TIBCO Business Studio 3. page x Related Documentation. Work Item Scripting for a summary). • • For more information on these types of scripting.2. Resource Query Language – a different scripting language used for selecting which resources are assigned to a User Task. Work Item Scripting for a summary). Process Scripting for a summary).

Work Item Attributes Additional customizable work item attributes have been added. See Assigning a Null Value on page 65.x | Preface Changes from the Previous Release of this Guide This section itemizes the major changes from the previous release of this guide. Assigning the Value Null Additional information has been added about assigning the special value null to attributes. Business Data Services Guide . See WorkItem on page 215. Additional Support Addition of more construct and xsd type support.

Related Documentation xi | Related Documentation This section lists documentation resources you may find useful. TIBCO Business Studio™ BPM Implementation Read this manual to learn how to implement business processes (including using scripts). Read the release notes for the various products for lists of new and changed features. Business Data Services Documentation The following documents are related to BDS: • • • TIBCO Business Studio™ Business Object Modeler Read this manual to learn how to model data. Business Data Services Guide . These documents also contain lists of known issues and closed issues for the release.

xii | Preface Typographical Conventions The following typographical conventions are used in this manual. pathnames. For example: A portal page may contain several portlets. Key names separated by a comma and space indicate keys pressed one after the other. and output displayed in a command window. In large code samples. for example. In command syntax. For example: Ctrl+C. on Windows systems. For example. For example: Type admin. code examples. code font bold code font Bold code font is used in the following ways: • • • In procedures. filenames. Portlets are mini-applications that run in a portal. For example: See TIBCO ActiveMatrix BusinessWorks Concepts. Table 1 General Typographical Conventions Convention TIBCO_HOME Use Many TIBCO products must be installed within the same home directory. an additional action required only in certain circumstances. Ctrl+Q. For example: Use MyCommand to start the foo process. The note icon indicates information that is of special interest or importance. For example: Esc. the default value is C:\Program Files\tibco\. to indicate the default parameter for a command. The value of TIBCO_HOME depends on the operating system. Business Data Services Guide . For example. This directory is referenced in documentation as TIBCO_HOME. if no parameter is specified. For example: MyCommand PathName Key combinations Key names separated by a plus sign indicate keys pressed simultaneously. To indicate a variable in a command or code syntax that you must replace. to indicate what a user types. Code font identifies commands. to indicate the parts of the sample that are of particular interest. To introduce new terms. MyCommand is enabled: MyCommand [enable | disable] italic font Italic font is used in the following ways: • • • To indicate a document title.

for example. Business Data Services Guide . The warning icon indicates the potential for a damaging situation. data loss or corruption if certain steps are taken or not taken. for example. a way to apply the information provided in the current section to achieve a specific result.Typographical Conventions xiii | Table 1 General Typographical Conventions (Cont’d) Convention Use The tip icon indicates an idea that could be useful.

visit this site: http://www. you can access the documentation for all supported product versions here: http://docs. blogs. a place to share and access the collective experience of the TIBCO community. and resident experts. and access to a variety of resources.com/TibcoDoc How to Contact TIBCO Support For comments or problems with this manual or the software it addresses. partners.com/services/support • If you already have a valid maintenance or support contract. Business Data Services Guide . contact TIBCO Support as follows: • For an overview of TIBCO Support. How to Access All TIBCO Documentation After you join TIBCOmmunity.com.xiv | Preface Connecting with TIBCO Resources How to Join TIBCOmmunity TIBCOmmunity is an online destination for TIBCO customers.tibcommunity. To register.tibco. If you do not have a username.tibco. visit this site: https://support. and information about getting started with TIBCO Support. go to http://www. TIBCOmmunity offers forums.com Entry to this site requires a username and password. you can request one.tibco.

page 2 Business Data Services (BDS). page 3 Business Data Services Guide . Topics • • Overview.|1 Chapter 1 Introduction to BDS This chapter provides an introduction to the Business Data Services component and how it is used.

The resulting Business Object Model (BOM) contains the different types of objects that the business uses.2 | Chapter 1 Introduction to BDS Overview TIBCO ActiveMatrix BPM provides a configurable set of tools that can be used to develop. that allows you to build up a description of the types of objects the processes will manipulate. Business Object Modeler. their attributes. Business Data Services Guide . and manage business process management applications. and their relationships to each other. execute. deploy. see TIBCO Business Studio Business Object Modeler. A fundamental part of developing a business process is to understand the data that the process manipulates and depends upon. TIBCO Business Studio provides a tool for this purpose. For more information on using Business Object Modeler.

The BDS Plug-ins are based on the Eclipse Modelling Framework (EMF). For example.org/modeling/emf/ You can interact with Business Data (any BOM-based data) from any activity in a Process (for example. the data of which might be modeled as follows: The following business process shows the tasks that handle a claim: Business Data Services Guide . a user task. database task. consider a claims handling system. BDS converts the design-time BOM definitions into BDS Plug-ins that act as the runtime model for Business Data.eclipse. Use TIBCO Business Studio Business Object Modeler to define a BOM. For more information about EMF. see: http://www. script task. This automatically results in an indirect interaction with BDS Component. and so on).Business Data Services (BDS) 3 | Business Data Services (BDS) Business Data Services (BDS) is the component responsible for handling Business Data in TIBCO ActiveMatrix BPM.

the script constructs the Business Objects. In the Update Claims Management System with Claim Details service task. a claims handler validates whether the details are correct. details of the claim are persisted to a database. In the Validate Claim Details user task.4 | Chapter 1 Introduction to BDS In this example. the user interacts with BDS in each of the activities: • • • In the Create Claim script task. Business Data Services Guide .

page 8 BOM Relationships and Process Local Data. page 7 Business Objects. page 14 Business Data Services Guide . Topics • • • • • Object Orientation (OO). page 10 Assignment by Value and by Reference.Concepts 5 | Chapter 2 Concepts This chapter outlines the main concepts that underlie the BDS component and its use. page 6 BOM Class.

refer to the examples in later sections. It is important to understand the concepts described in this section to achieve the desired behavior from your scripts. Business Data Services Guide . One of the best ways to understand these concepts is to learn by example.6 | Chapter 2 Concepts Object Orientation (OO) The BPM runtime is an Object Oriented (OO) system. and then return to this section. This section describes the implications of this OO design. If you have difficulty understanding this section. as is the scripting environment that supports it.

you can define a Customer BOM class and an Order BOM class. before we can have objects we must create a template. and defines what the different objects will be like.BOM Class 7 | BOM Class As the name implies. for each type of object we want to process. For example. Creating BOM classes for your application is a design-time activity. Objects are created to represent real world things such as a customer or an order. or pattern. which would model real world customers and orders. However. This template is called a BOM class. the whole focus of OO is on objects. Business Data Services Guide .

This is called Process Local Scope. The diagram below shows a simple Customer class and three Business Objects. the Customer BOM class can have two Business Objects to represent two actual customers.8 | Chapter 2 Concepts Business Objects At runtime. John Smith and Fred Blogs. which are instances of the class: cl ass: Cu sto me r N am e N um be r i nstan ce : Cu stom er N am e: Fre d B log s N um be r: 10 00 01 in stan ce : Cu stom er N am e: Joh n S mith N um be r: 10 00 02 in stan ce: Cu stom er Na m e: Alb er t B ro wn Nu m be r: 1 00 0 12 Business Object Scope The life span of a Business Object is typically bounded by the Process Instance in which it is created. For example. Each of these BOM classes and Business Objects have attributes. It is possible in a service task to write information out to. or the data in one of the normal BOM classes may have to be mapped into a Business Object that matches the database table structure depending on the implementation. Although Customer attributes differ from Order attributes. a database. generally all Customers have the same set of attributes. For example. or read from. The structure of the database table may match one of the normal BOM classes. These instances are referred to as Business Objects. a Customer may have attributes that include a name and number. Business Data Services Guide . and an Order may have attributes that include Customer and DateCreated. instances of these BOM classes are created to represent particular instances of the generic BOM class.

for example. In this example. You can set the value of a Business Object attribute as follows: customerInstance. but has to be done explicitly when an object is created in a script. the String class is used to represent a Text attribute’s value.Business Objects 9 | Business Object Creation by Factory Business Objects are created by factories. The factory methods have to be used when a Business Object is created. This happens implicitly when objects are created within User Tasks.name was "Fred Blogs".toLowerCase(). then the first assignment would set the lowercaseName variable to the value fred blogs. Business Data Services Guide . such as the example cited above. and the second assignment would set the uppercaseName variable to the value FRED BLOGS. createOrder. In some cases. There is a factory method for each class (for example. In other cases. Invoking Operations on Business Object Attributes As well as attributes. and sub-package within the BOM. Retrieving and Setting Business Object Attributes Using Business Data Scripting capabilities. methods can return values. uppercaseName = customer.toUpperCase(). such as the name of a customer. BOM. is as simple as running the following script: var custName = customerInstance.name.name. if the Text attribute customer. some classes have methods which perform operations on the object. Two of it’s methods are toUpperCase() and toLowerCase(). retrieving Business Object attributes. It is important to know how the methods behave when you are using them.name = "Clint Hill". and so on). For example.the attributes of a customer instance. lowercaseName = customer. See Business Data Scripting by Example on page 55 for more information about factories. createCustomer. methods can alter some of the attributes of the instance.name.

10 | Chapter 2 Concepts BOM Relationships and Process Local Data This section describes how BOM relationships are honored by process local data. Business Data Services Guide . which is labelled "parts". there is a "parts" attribute in the Car class. It is important to understand that in this kind of relationship. At runtime. Also. Similarly. it would no longer exist in the original car. there is a line drawn between the Car and Widgets. The Composition relationship is also known as the Containment relationship. In the second example. if a Car object is composed of a number of Widget objects. It does not matter which is used. This can be drawn in either of the following ways in the Business Object Modeler: • • In the first example. if the steering wheel from one car was installed into another car. it will no longer exist in Business Object A. For example. these two approaches are treated identically. It cannot be in two cars at the same time. a Car is made up of a number of Widgets. those Widgets cannot be components with other Car objects. if a Business Object contained in Business Object A is added to Business Object B. Composition The Composition relationship is used to model the concept that “X is composed of Y”. This makes sense if you consider the example of a steering wheel.

there might be a Customer and an Employee class. Cat. both classes representing a person. A Mammal is-an Animal. and they specify that they want a Mammal. (Also. Business Data Services Guide . A Fish is-an Animal. name. When modeling this. Mammal. or they can even be given a Hamster. this means that a Mammal is a specialization of an Animal. providing a Goldfish does not satisfy the "is-a" Mammal requirement. and a Cat is a specialization of a Mammal. email. and telephone). Goldfish. In the Business Object Modeler. (Also. you can create a Person class that holds the common attributes of Customer and Employee (for example. a Goldfish is-an Animal). While building up the model of what objects a business deals with. A Cat is-a Mammal. consider the following terms: Animal. these relationships would be represented like this: In OO terms. However.BOM Relationships and Process Local Data 11 | Specialization and Generalization Another useful aspect of OO technology that can be used in BOM and scripting is Specialization and Generalization. you may discover that some classes have some things in common. If someone wants a pet. a Cat is-an Animal and a Dog is-an Animal). For example. Looking at these terms you can see that we can link some of them with the phrase "is-a" (or "is-an") as follows: • • • • • A Goldfish is-a Fish. Fish. as a hamster "is-a" Mammal. A Dog is-a Mammal. and so on. and Dog. a supplier can give them a Cat or a Dog because they both satisfy the "is-a" Mammal requirement. For example.

manager and so on). customerNumber). Using the previous diagram as an example. we can say that the Customer and Employee classes are specializations of the Person class. you can assign the Customer business object to a business object attribute of type Person (because you can say that the Customer "is-a" Person). Business Data Services Guide . We can say that the Person class is a generalization of the Customer and Employee classes. Generalization is the reverse of specialization (looking at the same relationship from the opposite direction). Similarly. by adding any attributes that only the Employee had (for example. as its BOM class is a subtype of the Person class. Having done this. the Employee class can specialize the Person class. if you had a Customer business object. adding the extra attributes that only a customer has (for example. The relationship between these classes can be represented in the BOM as shown below: Assigning a Subtype to a Super Type It is always acceptable to assign a subtype to a super type. Alternatively.12 | Chapter 2 Concepts The Customer class can then specialize the Person class. it is possible in a process to create a list of all the Customers and Employees that have been involved in a particular Order by creating a list of Person instances (each instance of which could either be a Customer or an Employee). department.

if you have a Business Object Attribute of the Customer subtype that you want to assign from another attribute of the Person type. If the Person attribute is referring to a Business Object of the generic Person. For example. it passes the "is-a" test. or the Employee BOM classes then it will not work. Business Data Services Guide . as they do not satisfy the "is-a Customer" requirement. In other words.BOM Relationships and Process Local Data 13 | Assigning a Super Type to a Subtype The converse (a super type to a subtype) is acceptable when the super type actually refers to an instance of the subtype (or one of its subtypes). it will only work if the Person attribute is actually referring to an instance of the Customer BOM class.

In other words. Business Object attribute or composition . subsequent changes to the entity by either the new or existing reference is reflected in both places (there is only one entity. but always behaves like by value. it will be removed from that containment automatically because it is impossible for an object to be contained by two containers at the same time.. By value. objects are only copied where they are mutable (where their internal value can be changed). by reference behavior is sometimes used. This results in two independent objects.. See Assigning a Business Object. BOM Native or Primitive Type . By reference. and that is what is applied to the entity receiving the assignment. See BOM Native Type or Primitive Type Object to Business Object Attribute. a copy of the assigned entity is made. changes in one place do not affect the other. Important note: If the BOM Object being assigned is already contained by another BOM object’s containment.. For an assignment by reference. However. BOM Class Business Data Services Guide ... For efficiency’s sake. In other words. If this is not the desired behavior. See Assigning a Basic Type Object to a Process Data Field. make a copy of the object first. Therefore.14 | Chapter 2 Concepts Assignment by Value and by Reference Assignments can be made either by reference or by value.of type.behaves as follows: Effectively by value. Table 2: Assignment Conventions Assignment to.. it isn’t copied). the entity to which the assignment is made refers to the entity being assigned... Process Data Field BOM Class Basic Type By reference. See Assigning a Business Object. for a by value assignment.

age person1.Assignment by Value and by Reference 15 | BOM Native Type or Primitive Type Object to Business Object Attribute Assigning a BOM Native Type or Primitive Type object to a Business Object attribute is by value: car.dob.age + 1.age = person2. bus.setYear(1970). person2.make = bus. person1.dob // is still 1968-01-04 Business Data Services Guide .dob = person1. person2.make person1.// Will not increment person1.age = person2. person2.make = "Ford" // will not affect car.dob.make.dob = DateTimeUtil.createDate("1968-01-04"). // Value now 1970-01-04.age.

it is automatically removed from that containment.name var owner = com_example_refval_Factory. make a copy of the object first using the ScriptUtil.age var tempPerson = personDataField. If a Business Object is assigned. owner.owner. It is impossible for an object to be contained by two containers at the same time.// Also affects personDataField.16 | Chapter 2 Concepts Assigning a Business Object Assigning a Business Object is by reference: personDataField = car. car.// Business Object assigned to // local variable by reference tempPerson. see Create a Copy of a Business Object on page 61.name = "Ludwig".createPerson(). // Also affects car.name.owner.name = "Bob".owner = owner. // Also affects car.owner.age = 25. If this is not the desired behavior. Business Data Services Guide . but is already contained in another Business Object’s containment. // Business Object assigned to data // field by reference personDataField.copy(…) utility.

customer. account. greetingDataField = greeting.address = address.address).address = customer. customer.createAddress().copy(…). // Creates an independent Address Assigning a Basic Type Object to a Process Data Field Assigning a Basic Type object to a process Data Field is by value: var greeting="Hello".copy(customer. // Will not affect local variable // greeting Business Data Services Guide .Assignment by Value and by Reference 17 | In the next example. account.address = address.createAddress(). account and customer end up with independent copies of the address: var address = com_example_refval_Factory. leaving Customer with no Address: var address = com_example_refval_Factory. // Removes address from // customer If this script is modified to use ScriptUtil. the final line of the script removes the Address from Customer. although all assignments are by reference (there is only ever one Address). greetingDataField = "Goodbye".address = ScriptUtil.address.

personDataField2 = personDataField1. modifying a value in one place never affects the other.age (still 35) Business Data Services Guide .age = 40. // Both data fields now // refer to same object personDataField1. which can be assumed to run one after the other. all process Data Fields are independently converted to a form that can be stored in a database. Therefore. regardless of whether a by reference assignment occurred in an earlier script. in a later script. // will not affect // personDataField2. This is illustrated by the following two scripts.age = 20. // This affects both data fields Script 2: // Each data field now refers to an independent Person object personDataField1.age = 35.18 | Chapter 2 Concepts The Significance of the Script Boundary When a script completes. operating on the same process Data Fields: Script 1: personDataField1.

Topics • • • • UML Relationships Supported by Process Local Data. page 20 BOM Native Types. page 21 Creating a Business Object Model (BOM).Business Data Definition 19 | Chapter 3 Business Data Definition This chapter describes how you define business data in TIBCO Business Studio Object Model Editor. page 25 BOM Design-time Model. and the types of data it supports. page 29 Business Data Services Guide .

Business Data Services Guide . BDS and Process Local Data support Generalization and Specialization relationships and Uni-directional Composition relationships. Although in TIBCO Business Studio BOM Editor also supports Association and Aggregation relationships.20 | Chapter 3 Business Data Definition UML Relationships Supported by Process Local Data The Business Object Modeler uses terms and notation similar to UML (Unified Modeling Language). so an understanding of UML can be useful. these relationships cannot be used in processes.

. xsd:anySimpleType and xsd:anyAttribute). xsd:anyType. Business Data Services Guide . Therefore. a range or a regular expression that it must match. The Attachment type is not currently supported by the BPM runtime. for example. 4 sub-types of Object (xsd:any. these BOM Native Types can be used to generate Primitive Types that have some application-specific restrictions. there are 18 different types.BOM Native Types 21 | BOM Native Types The following BOM Native Types are supported by BOM Editor: • • • • • • • • • • • • • Attachment Boolean Date Datetime Datetimetz Decimal Duration ID Integer Object Text Time URI There are also: • • • two Decimal sub-types (Fixed Point and Floating Point) two Integer sub-types (Fixed Length and Signed Integer). in total. if you include the sub-types as types. Using Business Object Modeler.

31] (dependent on month & year) For example: "2011-12-31" Datetime Date fields according to Date type above Time fields according to Time type below Optional timezone offset in range [-14:00 . For example: 1234567890. Table 3: Value Spaces for BOM Native Types BOM Native Type Attachment Boolean Date Value Space N/A true.22 | Chapter 3 Business Data Definition Value Spaces for BOM Native Types The value space of the different BOM Native Types is shown in the following table.999 – 999.999.1234567890 Decimal – Floating Point • • • Negative numbers between -1. false Year in range [-999.999] Month in range [1 – 12] Day in range [1 .+14:00 or Z for Zero offset] For example: "2011-12-31T23:59:59" or "2011-12-31T23:59:59-05:00" Datetimetz Date and Time fields according to Datetime type above.79769E+308 and -2. For example: 1.225E-307 0 Positive values between 2. but timezone is mandatory For example: "2011-12-31T23:59:59Z" or "2011-12-31T23:59:59+05:00" Decimal – Fixed Point An arbitrarily long integer number with the which has its decimal point moved to the left or right by up to 231 places.225E-307 and 1.99.23 Business Data Services Guide .79769E+308.

xsd:anyAttribute Object . A block of XML satisfying xsd:anyAttribute schema definition.147. For example: P3DT2H for 3 days and 2 hours ID Non-colonized name. A block of XML satisfying xsd:anySimpleType schema definition See http://www. or they can be null if not set. minute. This can also be given the value of a Business Object or the value of a BOM Primitive. day.79769E+308] although.483. See http://www.org/TR/2004/REC-xmlschema-1-20041028/. ". See http://www. numbers. For example: ID1234 Integer – Fixed Length Arbitrarily large length integer For example: 12345678901234567890 Integer – Signed Integers in the range -2. See http://www.BOM Native Types 23 | Table 3: Value Spaces for BOM Native Types BOM Native Type Duration Value Space A duration consists of year.org/TR/2004/REC-xmlschema-1-20041028/.w3.147.".647 For example: 123456789 Object – xsd:any A block of XML satisfying xsd:anySimpleType schema definition. or combinations of characters and extenders.1. The seconds field is a non-negative decimal (or null) in the range [0 . hour. This can also be given the value of a Business Object. it is fetched from the object as an integer and the sign can be "+" or "-". Arbitrary length of long text string of Unicode characters For example: Fred Blogs Object .org/TR/1999/REC-xml-names-19990114/#NT-NC Name for more details. This can also be given the value of a BOM Primitive A block of XML satisfying xsd:anyType schema definition See http://www.w3.647].w3. That is.w3.xsd:anySimpleType Object . "_". and may be followed by more letters.483.xsd:anyType Text Business Data Services Guide . The first 5 fields are non-negative integers.483. second and sign attributes. Starts with a letter or "_".648 to 2.147.org/TR/2004/REC-xmlschema-1-20041028/. "-". month.org/TR/2004/REC-xmlschema-1-20041028/.w3. they can have values in the range [0 2.

24 | Chapter 3 Business Data Definition Table 3: Value Spaces for BOM Native Types BOM Native Type Time Value Space Hour in range [0 – 24] (for value 24 minutes and seconds must be 0) Minute in range [0 – 59] Second in range [0 – 60] (NB 60 only allowed for a leap second) For example: 12:34:56 URI Refers to xsd:anyURI. XML Linking Language (XLink) available at: http://www.org/TR/2001/REC-xlink-20010627/ For example: http://www.com Business Data Services Guide .w3. See World Wide Web Consortium.tibco.

If you intend to call the interfaces. There can be multiple BOMs with cross-references between them. Importing XSDs and WSDLs into Business Objects If your processes need to manipulate structured data whose structure is defined in XSD files or WSDL files. although there cannot be circular references (dependencies) between BOMs. This is only done on WSDL files if you are not going to call the interfaces in the web service defined in the WSDL file. as shown in the following figure: User-defined BOMs can be found in the Business Objects folder of the TIBCO Business Studio project. • • Manually in the Business Object Modeler. Once the import has completed. By importing existing XSD or WSDL files that contain data definitions used by existing applications. Business Data Services Guide . you can explore the data structures that have been imported in the Business Objects folder. BOMs are created from the context menu in the Business Objects folder in the Project Explorer.Creating a Business Object Model (BOM) 25 | Creating a Business Object Model (BOM) There are two ways to create a BOM. by one who knows the structure of the data that the business uses. Structured data can also be manipulated in scripts in the same way as user-defined BOMs. Creating User-defined BOMs in the Business Objects Folder You can create a new BOM during or after creating a project. import the WSDL as described in Importing WSDLs into the Service Descriptors Folder on page 26. the structure of the data can be imported into the Business Objects folder.

26 | Chapter 3 Business Data Definition If you modify these imported BOMs. This allows you to import a WSDL file from a number of sources. the structure of it’s tables can be exported into an XSD file. and selecting Import. then imported and extended to cope with known and future requirements. then Service Import Wizard. Importing WSDLs into the Service Descriptors Folder If you have a web service that you want to invoke. Once the data structure in the XSD (or WSDL) file has been imported into a BOM. Business Data Services Guide . web services can be defined and WSDLs generated for other applications to invoke the new web services that use the structured data from the imported files. which can then be imported into TIBCO Business Studio. The information about the table structure can be used in tasks that interact with the database. The following is an example of how this might be used: If you have an existing database. including a file or a URL. causing TIBCO Business Studio to display the following warning: Despite the warning. this mismatch is normal if you have data types that are defined in an external system. the WSDL defining that service can be imported into the Service Descriptors folder. the copy of the definitions in TIBCO Business Studio will differ from the source that they came from. This is done by right-clicking the Service Descriptors folder of a TIBCO Business Studio project.

This generated BOM will be created in the Generated Business Objects folder and can be viewed in the same way as the user-defined BOMs above. a service task must be added to a BPM process and the Task Type must be set to Web Service. a warning is generated: TIBCO recommends that you do not change a generated file. a BOM is generated that contains all the structured data definitions used by the web service. Script tasks and user tasks can process business objects created from the structured data imported from the WSDL file in the same way as the structured data defined in the user-defined BOMs. In order to call a web service. if you attempt to change one of the generated BOMs. However. Then the operation must be selected from the operations that were imported from the WSDL file by clicking the Select button in the Service Task General Properties tab. These Business Objects can then be mapped onto the input and output parameters of the Web Service task that is being called. Business Data Services Guide . as you risk losing changes if the file is regenerated.Creating a Business Object Model (BOM) 27 | Once imported. you can view the services defined by the WSDL file. for example: As part of the importing of the WSDL file.

Once the WSDL file has been imported it can be viewed in the Service Descriptors folder of the TIBCO Business Studio project to explore the different services provided by the web service. Generating a WSDL for a Web Service You Are Creating If you do not have a WSDL file for a web service (for example. it can be created here For a more detailed overview of defining Web Services. the data types used by the web service are defined in a BOM created in the Generated Business Objects folder. you can use the Generate WSDL button in the Web Service General Properties tab to generate a WSDL file that you can use to define the contract that the Web Service provides.28 | Chapter 3 Business Data Definition Importing a WSDL when Defining a Web Service Task When a web service task is created in a process. If the WSDL does not exist yet. The Properties tab for a web service task has buttons for: • • • Selecting an existing WSDL service Importing a WSDL if the WSDL has not already been imported Generating a WSDL. there is an Import WSDL option in the Properties tab to import the definition of the web service from a WSDL file (if the WSDL file has not already been imported into the project as described previously). Business Data Services Guide . see Scripting with Web Services on page 109. As previously explained. because it has not yet been produced).

The sub-type and restrictions are defined on the Advanced Property tab for Primitive Types: Regular Expression Patterns for Text Fields When defining a Primitive Type. based on the Integer(Signed) type with the values restricted to numbers between 0 and 23. the value space of a user-defined Primitive Type is restricted in some way. Usually. for example. which are specializations of BOM Native Types. For example. it is possible to define your own Primitive Types. a type called Hour can be defined. if you want an OrderId type to be formatted as ORD-NNNNNN. then you can specify this by using a Pattern in the Advanced Property Sheet for the Primitive Type: Business Data Services Guide . text fields can be constrained to match certain patterns.BOM Design-time Model 29 | BOM Design-time Model Primitive Types In a BOM. where "N" represents a digit.

". The "\D".3}" means between 1 and 3 repetitions of the previous element. Additional example patterns that can be used are listed below. because ".30 | Chapter 3 Business Data Definition In the pattern shown in the above example.\d{8} Correct: 1." normally matches any character. In this case. Description The content in the square brackets may include any number or lowercase letter of the alphabet.234 The "^" at the start of a range refers to characters outside the allowable range. the square brackets may contain any hex digit. so "[^. Table 4: Regular Expression Example Patterns Pattern ID-[0123456789abcd ef]* Examples Correct: ID-deadbeef IDID-1234 ID-0fff1234 Incorrect: ID ID-0A ID-[a-f0-9]+ Correct: ID-0000dead Incorrect: IDID-0000DEAD [^. The "+" means one or more. the "a-f" means any letter in the range "a" to "f" and the "0-9" means any digit.".". and must be followed by a ". Incorrect: Hello. However. \d{1.12345678 123. Business Data Services Guide . any number of lowercase hex digits may be used.]" matches any character apart from ". "\d" means any digit. "{1. in this case it must be escaped.]+. a digit). "\W". Correct: Hello. The "+" after it means one or more. Similar to the "\d" sequence. The asterisk means zero or more of the previous element.Bye.3}\. and "\S" sequences inverse character sets. In other words. As in the previous example.12345678 Incorrect: 1. you can use "\w" for any word character and "\s" for any white space character." matches a ". "\. the "\d" represents any digit and the "{6}" means there must be 6 of the preceding element (in this case.

The "?" indicates that the previous element is optional. "[a-z-[aeiou]] a-z"matches any lowercase letter.BOM Design-time Model 31 | Table 4: Regular Expression Example Patterns Pattern \i\c* Examples Correct: xml:schema :schema Incorrect: 0xml:schema -schema [\i-[:]][\c-[:]]* Correct: xmlschema _schema Incorrect: xml:schema :schema [-+]?\d+(\. Similarly.com/regularExpression. You can read more about regular expressions at: • • • http://www. Description "\i" matches the initial character of any valid XML name. then decimal digits must follow in this example.w3. The example on the left removes ":" from the "\i" and "\c" lists of characters so the pattern now matches non-colonized names. as it has a special meaning if not the first character.regular-expressions. The whole group is optional because of the "?" at the end. then it should be the first character.org/TR/xmlschema-2/#regexs http://www.xmlschemareference. If you want to include a "-" in a range.html http://www.1 -2. adding "–[aeiou]" at the end removes the vowels from the set of letters that are matched.34 +3 Incorrect: 4.\d+)? Correct: 0.info/xml. If a decimal point appears.html Business Data Services Guide . and "\c" matches any character that can appear after the initial character. The parenthesis mark form a group. the "\I" and "\C" are the negations.

Business Data Services Guide . for the Fixed Length Decimal sub-type. the List methods must be used. Additionally.32 | Chapter 3 Business Data Definition Multiplicity When BOM class attributes and compositions are defined.3 4 4. that multiplicity can have other values.. they have a maximum size defined. When defining the multiplicity for an attribute. the number of decimals for the attribute is set. content assist is available by typing Ctrl-SPACE. You can then select one of the following options: It should be noted.. This can be changed in the attribute’s Advanced Property tab. however. such as the following: Multiplicity 2. Size Restrictions When Text attributes are defined. Therefore. When Fixed Length sub-types of Integer and Decimal attributes are defined. then the attribute being defined will be a List.* Meaning There must be 2 or 3 There must be 4 There must be 4 or more If there can be more than one element. when referenced in scripts. the length for the attribute is specified in the Advanced Property sheet. the developer can define how many values the attribute can or must have.

the attribute has that value. upper and lower bounds can be set on the value that the attribute can take. Again. For example. the quantity attribute will be 1. this is done through the attribute’s Advanced Property tab. Business Data Services Guide . For example: Default Values Default values can be used when defining attributes for BOM classes. then as soon as an instance of the class that it is an attribute of is created. if a class has an integer type attribute called quantity. This is done through the Advanced tab in the Properties. it might be given a default value of 1 in the Advanced Property tab as shown below: When an instance of this class is created.BOM Design-time Model 33 | For all Integer and Decimal sub-types. If an attribute has a default value.

for example. and BOM attributes have a Label as well as a Name. the following warning is generated: BOM Labels and Names BOM packages. one with a potential multiplicity of zero.34 | Chapter 3 Business Data Definition If you attempt to set a default on an optional attribute. A Label is a free format field that is designed to be a user-friendly description of the attribute or class. the following warning is generated: If you attempt to set a default on an attribute with a multiplicity greater than 1. The label text is displayed by the BOM editor as shown below: Business Data Services Guide . BOM classes.

a-z. Only characters used in ASCII A-Z (excluding accented characters). You can see that the spaces. and currency symbol have all been ignored when the names were generated. a name is defined for each class and attribute. The characters that are valid for subsequent characters in the name are the same as the initial character. brackets.listPrice + delivery + tax. the attribute name is used. For example. In scripting. and the underscore character "_" are valid characters for use as a name's first-character. Therefore. The default name is generated by using the characters from the label that are allowed in names.BOM Design-time Model 35 | And by the default Forms: However. Label to Name Algorithm All characters in the label that are not valid characters in the name are removed when the label is converted to the default name.engineCapacitycc. the Label cannot be used with the entire product. The screenshot of the form above shows the names as well as the labels for the different fields. Space and most punctuation is removed. the names that can be used to refer to attributes are considerably constrained. as in scripting. Business Data Services Guide . var carPrice = car. For example: var engineSize = car. with the addition of digit characters (ASCII digits 0-9 only).

The following example shows a Label and Name pair where only lowercase letters are used Compared that to the following: The Name field is generated from the Label field whenever the label is changed unless the Name field has been manually set. any illegal name characters are ignored. as in the example above. in which case the name must then be manually changed. In the following example. For example: Business Data Services Guide . you can see the quotation marks and spaces in the Label are removed in the Name: The Label is used in BOM diagrams and the Name is used in scripts. .36 | Chapter 3 Business Data Definition Spaces and punctuation characters are not allowed in names. including the following: Character . Because the Name is used in scripts. Character Description Dot Comma Hyphen BOM Class Label and Name Any characters are valid in a label. As the label is converted to the class name. it is easier to read if initial capital letters are used for each separate word.

there is a requirement that the first two characters of the name must use the same case. and if possible. and numbers. as shown in the following examples: When creating attributes for BOM classes. a single letter word as the first word. it is recommend that you use uppercase letters for the initial letter of each word in the label.BOM Design-time Model 37 | BOM Attribute Label and Name For the names of class attributes. The names will follow the camelcase convention. Each BOM must have a unique name across all other projects in the TIBCO Business Studio workspace. do not use. ("Camelcase" names have lots of "humps"!) BOM Package Label and Name The BOM top-level package or model name must be made up of dot-separated segments. the software automatically uses lowercase letters for the first two characters if they are of different cases. underscores. To meet this requirement. Business Data Services Guide . each beginning with a letter or underscore and containing only letters. and must avoid reserved words in a similar manner as BOM class names.

The Label is displayed in the BOM editor. Business Data Services Guide . Words that are keywords in Java or JavaScript cannot be used as Class or Attribute names. A full list of reserved words can be found in Reserved Words in Scripts on page 180. but there are no such restrictions for Labels. which is also a dot-separated name in the same format. meaning it can be any text that you want to display. and by default is the same as the name of the BOM.38 | Chapter 3 Business Data Definition The BOM package name must differ from the TIBCO Business Studio project lifecycle ID. as they would cause problems when running the Java script that referenced the class or attribute. as shown in the following example: Reserved Words There are certain reserved words that cannot be used as Names. The project lifecycle ID can be viewed by right-clicking on the Project and selecting Properties > Lifecycle: The BOM Label is free format text.

as shown below: This is a generic BOM problem and has to be fixed manually. For example. Because of the internal workings of BDS. an error is generated against the BOM: Errors can be found in the Problems tab or by using the red-cross marker. attribute and class names must be unique and ignore case and underscores. if another attribute is added with the name "thmonth". then BDS generates the following errors indicating a name clash: This problem marker has a quick fix which can automatically rename an attribute to resolve any clashes. Therefore. as shown below: Business Data Services Guide . there are further restrictions on names that can cause other clashes.BOM Design-time Model 39 | Name Clashes If two classes or attributes end up with the same name after the Label to Name mapping has been done.

ScriptTask and Web-ServiceTask use JavaScript as the script grammar for interacting with Business Objects. page 46 Process Migration. BDS Plug-ins are based on Eclipse Modeling Framework (EMF). page 50 Business Data Scripting. Using TIBCO BPM. page 45 BOM Versions. page 41 BDS Design-time Validations.40 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Business Data Services generate BDS Plug-ins from BOM Definitions. page 53 Business Data Services Guide . you can create Business Objects from a variety of tasks in a BPM Process. ScriptTask. page 47 Using BDS in Tasks. and so on. page 42 BDS Runtime Validations. UserTask. For example. BDS Plug-ins contain POJO (Plain Old Java Object) classes that are capable of being serializedand deserialized to or from XML very easily. Topics • • • • • • • BDS Plug-in Generation. WebServiceTask.

Business Data Services Guide . BDS Plug-ins are generated in a project named . if the BOM root package com.BDS Plug-in Generation 41 | BDS Plug-in Generation When a Business Object Model is saved. For example. The BDS Plug-ins will be generated in a hidden project whose name corresponds to a BOM root package.bds.example. the BDS Generator generates BDS Plug-ins that correspond to the BOM.com.businessobjectmodel.example.businessobjectmodel.

underscores and numbers. as well as processes that use BOMs. it can help you solve the problem through Quick Fixes. Name must not be a reserved word. underscores and numbers. • • Concerning Sub-Packages • • Name must begin with a letter or underscore and contain only letters. Concerning the Model (Top-Level Package) • Name must be dot-separated segments. and Primitive Types • • • • Name must begin with a letter or underscore and contain only letters. Unless otherwise noted.42 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM BDS Design-time Validations During BOM creation. underscores and numbers. Names are considered to clash even when the case differs. ’modelname’ cannot be the same name as the project life cycle id. the messages listed in this section are errors. Another type has the same name. shown with a yellow marker. Each problem is classified as either an error or a warning. This section lists the validation messages that may be seen. it checks to make sure that the BOM you have created is valid and alerts you to any problems that have been found. Name must not match the first segment of the fully-qualified package name. Duplicate model name ’modelname’. For example. For many of the issues. avoiding reserved words. TIBCO Business Studio’s Problems view may show various errors and warnings from BDS. are merely advisory. Business Data Services Guide . or reserved names for Classes or Attributes. it will resolve the problem names by adding a numerical suffix. whereas warnings. Errors are shown with a red marker and will prevent application deployment until they are resolved. if you have duplicate Names. avoiding reserved words. Enumerations. each beginning with a letter or underscore and containing only letters. Validations in BOM Editor While BOM Editor is being used to produce a BOM. Concerning Classes. Name must not contain reserved words.

The Attachment type is not supported. Default values are ignored for attributes with a multiplicity greater than one [warning]. If it starts with two letters. Attribute name must not be a reserved word. Names are considered to clash even when the case differs. underscores and numbers.BDS Design-time Validations 43 | • • • • • • Generated Java interface name ’name’ will conflict with the implementation class for 'nameofsomethingelse'. Generated Java interface name 'name’ will conflict with the EMF package implementation class for package 'packagename'. Business Data Services Guide . Concerning Enumerations • Enumeration must contain at least one literal. as it will always apply [warning]. It makes no sense having a default value for an optional attribute. Generated Java interface name 'name’ will conflict with the EMF package interface for package 'packagename’. Attribute name must begin with a letter or underscore and contain only letters. they must be of the same case. Generated Java interface name 'name’ will conflict with the EMF factory interface for package 'packagename'. • • Concerning Primitive Types • The Attachment type is not supported. Generated Java interface name 'name’ will conflict with an EMF utility class for package 'packagename>'. Concerning Attributes • • • • Another attribute has the same name. Generated Java interface name 'name’ will conflict with the EMF factory implementation class for package 'packagename'. Concerning Enumeration Literals • Enumeration Literal name must begin with an upper-case letter and contain only upper-case letters and numbers.

Business Data Services Guide . Document literal type bindings must have formal parameters of type external reference.44 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Process Validations BDS performs a number of validations on Processes that make use of BOMs: • • • • Primitive Types cannot be used for Data Fields or Parameters Enumeration Types cannot be used for Data Fields or Parameters. please create a Class to contain the array. Instead. Activities responsible for generating WSDL operations cannot have array parameters associated.

Similarly. then an exception is generated if the field has more than 6 values or less than 3 values as specified by the multiplicity rule. the BDS ensures that all BDS data is in a valid state. If there are any problems.BDS Runtime Validations 45 | BDS Runtime Validations When a task completes. For example. and regular expressions for Text fields are all checked when each task completes. Business Data Services Guide . ranges of numeric fields. lengths of Text and Fixed Length Numeric fields.6. It does this by verifying that all constraints that exist on the fields are satisfied. an exception is raised. if a field has a multiplicity of 3..

any change can be made to the BOM between deployments without affecting existing projects that make use of the BOM. there are restrictions if you want to migrate Process Instances between different versions of a Process Template. or redeployed. As each deployed project has its own copy of the BOM artifacts. it will be deployed with a copy of the BDS plug-ins from each BOM that the project references.46 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM BOM Versions Once you have created a BOM and have started using it from deployed TIBCO Business Studio projects. However. it is possible to change or create new versions of the BOM if you find later that other processes need the BOM to be changed or extended. See the next section for details. Each time a TIBCO Business Studio project is deployed. Business Data Services Guide . they are independent of each other. therefore.

A compatible change adds a new entity to the BOM. Business Data Services Guide .Process Migration 47 | Process Migration If you want to be able to migrate a process instance from one version of a process template to a later one. the addition of a new class. Addition of a sub-package. or increasing the length of a text attribute from 50 to 60 characters. you can only make compatible changes to the BOM. primitive type or enumeration. if you want to be able to migrate process instances from the old process template to the new version of the process template. and so on. This means that the BOM used by the process template that you are migrating from must be a subset of the BOM used by the process template that you are migrating to. Changes Within the BOM’s Top-Level or Sub-Package • • Changes to a Class • Addition of new attributes and composition attributes. they must have multiplicity with a lower bound of zero. making an optional attribute mandatory. or makes an existing entity less restrictive. Diagrams can be rearranged. as long as they are optional (for example. Therefore.. you will need to make sure that the data in the first process template is compatible with the second process template version. Compatible Changes General Changes Any BOM entity’s label can be changed (as long as the name remains the same). you have to ensure that the BOM used by the two versions of the TIBCO Business Studio project is compatible. Addition of a new class. Examples of ‘incompatible changes’ include removal of a class. annotated. As much of the structure of the data comes from the BOM. there is a possibility that process instances will not be able to be migrated to the new version of the process templates. or adding a maximum value to an integer attribute that was previously unrestricted. If incompatible changes are made to the BOM. for example.1 or "*"). such as 0.

. its restrictions may be altered.5 1 0.increase in multiplicity Yes – made optional No (cannot change from single to many) No (cannot change from single to many) No (might have zero) No (might have zero) No (might have less than 4) The attribute type cannot be changed.* Valid? Yes . Table 6: Attribute Type Change Restrictions Restriction Default value Lower limit Upper limit Lower limit inclusive Upper limit inclusive Maximum text length Number length Decimal places Business Data Services Guide Permitted Change May be changed May be decreased or removed if a former lower limit was set May be increased or removed if a former upper limit was set May be changed from false to true May be changed from false to true May be increased May be increased May be increased (if length increased by the same amount or more) .1 * To 1.. Table 5: Examples of Compatible Change Rules From 1.8 0.. Examples are given in the following table.1 * 1. as long as it makes it less restrictive (for example. as long as they are less restrictive than the old restrictions...* 1 4.1 1 * 0. If an attribute’s type remains the same. it either increases the upper bound and decreases the lower bound) and it does not change between being a maximum multiplicity of 1 and greater than 1..48 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Changes to Class Attributes and Composition Relationships The multiplicity of an attribute or composition relationship may be changed.* 1...

Permitted Change Can be removed Change to a Primitive Type When the type has a BOM Native Type as its superclass. page 48. it may be altered subject to the compatible change rules described in Changes to Class Attributes and Composition Relationships. Business Data Services Guide .Process Migration 49 | Table 6: Attribute Type Change Restrictions Restriction Pattern Changes to an Enumeration • Addition of new enumeration literals.

User Task BOM fields can be displayed and updated in User Task steps. all the BOM fields that are In / Out or Out fields will be initialized Script Task Any BOM fields that have not been initialized by a previous task have a null value. the new field will not be available in the Task until it is added to the Interface. and therefore need to be initialized using the factory method before any of the attributes can be referenced. There is also a Mandatory flag that can be specified. By default.50 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Using BDS in Tasks General All Tasks have an Interface tab that can be used to restrict which fields the task has access to. no fields are listed. and a new field is added to the process. If the Interface tab is used. which means there are no restrictions and the Task has access to all the fields in the process. which controls whether the field has to have a value. After a User Task has been completed. and using Scripts in general. Each field that is specified in the Interface tab is specified to be one of the following: • • • In Out In / Out These specifications define whether the value is input or output to the script. Business Data Services Guide . See Creating a New Business Object on page 59 and the following sections for more details on using BOM fields in Script Tasks.

To define a webservice task. as it supports more WSDL features and is capable of mediation with other systems. Set the Service Type to Web Service. you need to map the input and output data from the web service call. then it can be mapped on the Output From Service property sheet. it can be mapped straight across on the Input To Service properties sheet. Similarly.Using BDS in Tasks 51 | Web Services There are some restrictions as to what types of webservices the Web Service Task can invoke. 3. If not. do the following: 1. The following example shows input fields being mapped: Business Data Services Guide . click Select to select the service to be called. click Import WSDL to import it. Task in the Lable fiel. If the process that is calling the webservice has a field of the same structure that the webservice takes as an input parameter. then the Mediation feature should be used. type Service 2. In the General tab of the Properties view. If the WSDL has not been imported. if the process has a variable with the same structure as the response message. the fields can be mapped individually. If the WSDL has already been imported. If you need to call a web service that uses WSDL features not supported by TIBCO BPM. Having defined the webservice to call.

52 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM The following example shows output fields being mapped. and a Business Object and all its attributes: Business Data Services Guide .

A useful introduction to JavaScript can be found at the W3Schools web site http://www. It does not include a full description of the syntax of the JavaScript language.org/TR/xmlschema-1/#xsi_type An example of this is shown below: This example shows that if you wish to pass an XML into an interface that is expecting a Person from a Customer. This is described in the specification: http://www. This means that. you must provide an xsi:type when using extended types.com</email> <phone>01234 567890</phone> <custNumber>44556677</custNumber> </tns1:PersonElement > TIBCO BPM adds an xsi:type value to XML data passed to external systems in a verbose manner. The following section gives an example of how to use Business Data Scripting in practice in TIBCO BPM. wherever possible. Those not familiar. are encouraged to first learn the basics of JavaScript before progressing onto TIBCO BPM Scripting.w3schools. Business Data Services Guide . For clarity. this data is fully compliant with the use of xsi:type as described in the specifications.Business Data Scripting 53 | Business Data Scripting Scripting in BDS uses a script language that is based on JavaScript with extensions to support the different aspects of BDS. or who are struggling with the syntax. You can learn more about JavaScript from many sources. the xsi:type is present.com/.org/math/types/" xsi:type="tns1:Customer"> <name>Fred</name> <email>fred@myemail.w3. Supplying xsi:type Information in XML Sent to TIBCO BPM When using external clients to pass XML representing BOM information to TIBCO BPM. it must contain an xsi:type as illustrated below: <tns1:PersonElement xmlns:tns1="http://example.

54 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Business Data Services Guide .

page 80 Scripting Containment Relationships. page 57 Creating a New Business Object. page 70 Working with Temporary Variables and Types. page 56 Factories. page 97 Working with Dates and Times. page 91 Working with Booleans. page 78 Looping Through Lists and Copying Elements in Lists. page 63 Using Content Assist. page 76 Loops Within Scripts. page 87 Working with Strings or Text Fields.Business Data Scripting by Example 55 | Chapter 5 Business Data Scripting by Example This chapter illustrates how to write BDS server-side scripts by using examples. page 104 Working with Primitive Types. page 93 Working with Basic Integer Numbers. Topics • • • • • • • • • • • • • • • • • • • • • • Overview. page 115 Business Data Services Guide . page 94 Working with Basic Decimal Numbers. page 82 Scripting on Business Objects That Use Inheritance. page 69 Multiple Instances of a BOM Class. page 59 Using the Special Value Null. page 109 Parse Functions. page 106 Return Values from Scripts. page 67 Working with Single Instance Attributes of Business Objects. page 108 Scripting with Web Services. page 99 Working with Enumerated Types (ENUMs).

56 | Chapter 5 Business Data Scripting by Example Overview The data objects that are passed around the system. all of which are described later in this guide. The BPM Script scripting covered in this guide can be used in a lot of places within BPM processes by selecting JavaScript as the script grammar. timeout. the scripting capabilities can be used. through a number of examples. but has some unique restrictions and extensions. submit and close) Timer Scripts . open. However. both within and between processes. for example: • • • • • Script tasks within processes Action Scripts that are run on particular events related to tasks (for example. complete. or attributes of one object can be mapped onto attributes of another object in graphical ways using the mappers. In these cases. initiate. This chapter illustrates how to write BDS server-side scripts. The scripting described in this section is provided by the Business Data Services (BDS) component that allows process definers to manipulate the data objects defined within the BOM. can sometimes be mapped as whole objects from one process to another. cancel. there are some places where the processes require custom processing of the data beyond the direct mapping of attributes. Business Data Services Guide .used to calculate a deadline or duration of a task within a process Condition Scripts – used to determine which direction flow should take within a process Loop Scripts – control how many times loops are executed within processes The BPM Script is based on the JavaScript language.

the following two ScriptUtil factory methods are used: • • ScriptUtil. for a BOM with a package name com.createOrder() com_example_ordermodel_Factory.createCustomer() Business Data Services Guide .createBigDecimal() Boolean fields can be assigned with the keywords true and false. when a new object needs to be created to represent a particular Business Object (instance of a BOM class) or other variable. a Factory method needs to be used to create the object instead of using the new keyword that is usually used in JavaScript. if you want to convert a text value true or false to a Boolean. and Customer. for example.createDuration() To create fixed integer and fixed decimal object instances. then the ScriptUtil. The factory methods for BOM classes can be found in Factory classes whose names matches the package name of the BOM.createBoolean() can be used. Only values for attributes of the following types do not need to be created with Factories: • • • • Boolean Text Integer (Signed integer sub-type) Decimal (Floating point decimal sub-type) The primitive field types that represent measurements of time are created by DateTimeUtil factory methods: • • • • • DateTimeUtil.createDatetime() DateTimeUtil.ordermodel the factory class would be called com_example_ordermodel_Factory.createDate() DateTimeUtil. or the result of an expression (such as (2 == value)).createOrderLine() com_example_ordermodel_Factory.createBigInteger() ScriptUtil. For example if the BOM contained Classes called Order. OrderLine.createTime() DateTimeUtil.createDatetimetz() DateTimeUtil.Factories 57 | Factories At runtime. there would be the following factory methods: • • • com_example_ordermodel_Factory. and there would be methods in the factory called createClassname for each class in the BOM.example. However.

Creating objects for classes in the sub-package would be done in a similar way to creating objects in the top-level package. Business Data Services Guide . the name of the factory contains the package and sub-package hierarchy in its name.createOrder(). for example: order = com_example_scriptingguide_ordersystem_Factory. separated by "_".58 | Chapter 5 Business Data Scripting by Example If the scriptingguide BOM contains a sub-package called ordersystem. there would be a factory created for the classes in that sub-package.

or use a copy of an existing object. Create an Instance of a Class Taking the example of the Person/Customer/Employee BOM: Business Data Services Guide .Creating a New Business Object 59 | Creating a New Business Object You can either create a new Business Object directly.

and setting the Type to be an External Reference to a type in the BOM. we first need a data field to hold the instance. Here we have created a field called cust that will be able to hold instances of the Customer class instances: Then a Script Task can be dragged onto the process diagram from the Tasks palette: Business Data Services Guide .60 | Chapter 5 Business Data Scripting by Example In order to create an customer instance. This is done by creating a new Data Field in a process.

Type the script. select JavaScript: The Describe Task Script dialog is displayed. by clicking Maximize. as shown below. the cust process data field will not contain or refer to an instance of the Customer class. The instances of the Customer class are created by the "Customer Factory Method". cust = com_example_scriptingguide_Factory. it just has the ability to. Factory methods have to be used to create objects. the name of the factory that creates Customer instances is based on the name of the BOM package that contains the Customer class as described in the previous section. as shown below: It is very important to understand that when a process starts. cust3 = cust1. The ScriptUtil utility method.createCustomer(). Business Data Services Guide . Create a Copy of a Business Object Another way of creating a new Business Object is to create a copy of an existing object. is provided for doing this: cust1 = com_example_scriptingguide_Factory.Creating a New Business Object 61 | View the Script Task properties and from Script Defined As needs.createCustomer().copy(cust1). So the first thing to do before attempting to access the attributes of the process data field is create an instance of the Customer object and assign it to the cust process data field. One of the differences between BPM Script and standard JavaScript is the new operator is not supported. cust2 = ScriptUtil. Maximise the Describe Task Script dialog.

which means that it copies all the objects contained by the Business Object being copied. Business Data Services Guide . The ScriptUtil. not for just copying BOM Primitive values. It is only for copying whole Business Objects. and cust3 to refer to the same Business Object that the cust1 process data field refers to.62 | Chapter 5 Business Data Scripting by Example The script in the example above.copy() method performs a "deep" copy. as well as the Business Object itself. sets the cust2 process data field to refer to a copy of the Business Object that the cust1 process data field refers to.

null = cust is never valid. The default value of the cust variable when the process starts is a special value written as null. Between the "()" (parenthesis mark). since cust = null is valid in some places. curly braces are mandatory. However. Business Data Services Guide • . so the syntax checker would help you in this case. There can be multiple statements between the curly braces. Here. as shown below: if (null == cust) { cust = com_example_scriptingguide_Factory. These are referred to as a block of statements. If the value results in false the statements between the second curly braces in the ELSE-BLOCK are processed. In BPM Script. } else { // cust was assigned in an earlier script } There are several things to note here: • is used for testing and conditionally executing statements. there should be a condition that results in a true or false result. and there was a possibility that an earlier script might have set the cust variable to refer to a Customer. if (CONDITION) {IF-BLOCK} else {ELSE-BLOCK} • The "==" operator is used to test for equality. The rest of the line following "//" is ignored by the script processing engine. In JavaScript.createCustomer(). they are only required if there is more than one statement to be processed. Writing null == cust instead of cust == null can help if you forget to use " ==" and use" =" instead. then the IF-BLOCK statements between the first "{}" (curly braces) are processed. If the value results in true.Using the Special Value Null 63 | Using the Special Value Null The special value written as null can be used in the following ways: Checking for Null Attributes This section is intended chiefly for those readers not familiar with JavaScript. then this can be checked in the script before calling the factory method. If our script was running later on in the process. The "//" in the else-block is used to introduce a comment. but it could still be null. it is being used to test if the cust variable has the value null.

dateOfBirth) { year = cust. } The example above shows how to use a multi-line comment. then after the UserTask is complete the BOM field will always refer to an object.getYear(). } /* Set the cust. We can check to see if attributes have been previously assigned by comparing them against null. as shown below: /* * Set the cust. although this will only work for attributes that do not have a default value. } Otherwise you will get a runtime exception. even for Optional parameters). • Once we know that the cust field has a value. so it will not be necessary to initialize the BOM field from the Factory method in any scripts that follow the UserTask that outputs the field. For example: if (null == cust) { cust = com_example_scriptingguide_Factory.name) { cust.name = customerName. Business Data Services Guide . Similarly.dateOfBirth. This is also true for any other task that has a mandatory Out or In / Out parameter (the difference between UserTasks and Forms is that it always creates objects.64 | Chapter 5 Business Data Scripting by Example • If a UserTask is processed that has a BOM field as an Out or In / Out parameter in its Interface (the default for all fields is In / Out).name if not already set */ if (null == cust. we can then set the name. you should check that an attribute is not null before using any methods on an object. The comment is opened with a "/*".createCustomer().name if not already set */ if (null != cust. then all text until a matching "*/" is ignored by the script engine.

// Clear myCar Data Field (Business Object) myCar = null. Business Data Services Guide . null. If a default value is specified for a Business Object attribute.yearBuilt = null. or clear for the removal of all values. remove for the removal of a single specific value. // Clear myInteger Data Field (Integer basic type) myInteger = null. In the above example. // Restore car’s yearBuilt to its default: 1995 (attribute) myCar.model = null. Specifically. This is discussed further in Removing an Item from a List or a Containment Relationship on page 85. values can be removed using the appropriate List methods.roof = null.Using the Special Value Null 65 | Assigning a Null Value The value of single value Data Fields and Business Objects’ attributes and compositions can be cleared by assigning them the special value. For Data Fields or Business Object attributes and compositions that have a multiplicity greater than one. The following diagram and script illustrate this: // Clear car’s model value (attribute) myCar. this applies to Car’s wheels composition and the myDates data field. // Remove car’s roof value (composition) myCar. Instead. the assignment of null is not possible. then assigning null will return the attribute to its default value.

For example.add(null). // Adding null to the list of a car’s wheels does nothing myCar. the following script is equivalent to a no-op.wheels. Business Data Services Guide . operations that add a null to the list will result in nothing being added. with no changes made to the list.66 | Chapter 5 Business Data Scripting by Example When dealing with attributes with a multiplicity greater than one. resulting in an unchanged attribute.

associated with cust is displayed. as shown below: cust = com_example_scriptingguide_Factory Business Data Services Guide . you can: • • • • Select cust and press ENTER. Going back to our example.Using Content Assist 67 | Using Content Assist TIBCO Business Studio can provide some helpful assistance when entering scripts. in our example. Press ENTER to insert the Factory name into the script. A list of words. variables. as shown below: To insert cust in the script. You are prompted with a list of words. Type u. A list containing options appears. type =co and press Ctrl+SPACE. Only items begining with "cu" are displayed. Only the content assist that matches "co" in our example is displayed. methods and so on. Press ENTER. that are appropriate for where you are in the script. methods and so on. So. Next. if you cannot remember whether you had called the field cust or customer you can type the first few letters and press Ctrl+SPACE. Double-click cust. variables. we can type c then press Ctrl+Space.

as shown below: Since the Business Object we want is already selected. type ". cust = com_example_scriptingguide_Factory." to give a list of the factory methods. Press ENTER to complete the line. press ENTER to cause the text createCustomer() to be added to the script.68 | Chapter 5 Business Data Scripting by Example Next. Business Data Services Guide .createCustomer(). This allows you to choose the type of Business Object to create.

cust. write the following script: if (null != cust) { cust.phone = phoneNumber.postcode = postCode.address. = emailAddress. = postalAddress.address } = phoneNumber. Otherwise. if (null == cust. Ensure that no variables used to assign attributes are null. the address attribute needs to be set to refer to an instance of the Address class before the attributes of the customer.address) { cust.phone cust.city = cityAddress.email cust.address.district = districtAddress. cust.address. the script will cause a runtime exception that can cause the process to fail when the script is run.street = streetAddress. If the address attribute of the Customer class is an attribute of an Address type rather than a Text type. } Business Data Services Guide .createAddress().email = emailAddress.Working with Single Instance Attributes of Business Objects 69 | Working with Single Instance Attributes of Business Objects To add contact details to a Customer instance. cust.address can be set. } cust. the following can be done: if (null != cust) { cust. cust.country = countryAddress.address. For example. cust.address.address = com_example_scriptingguide_Factory.

the process data field will refer to multiple instances of the Business Object. cust. If you want to associate a particular Customer with the custList variable. This is done through a List object. cust. you can assign the cust field with a single instance field. This is shown below. it is possible for it to refer to multiple instances. then instead of referring to a single Business Object. Let us consider a process data field that holds a List of Customer objects called custList. which can contain multiple Business Objects. cust = com_example_scriptingguide_Factory. The List objects do not need to be created. Business Data Services Guide . the process data field cust has only referred to a single instance of the Customer class (a single Customer Business Object). In a Process Data Field If a process data field is flagged as being an Array Field when the process data field is created (or its properties are changed later). The properties sheet for custList has Array selected and is of type Customer: Array fields with a multiplicity greater than 1 are implemented using the List object. They are created by default as empty Lists. However.70 | Chapter 5 Business Data Scripting by Example Multiple Instances of a BOM Class In the examples we have looked at so far.name = "Fred Blogs".createCustomer().custNumber = "C123456".

Business Data Services Guide . cust2.name = "John Smith". you then used the following script to add a third customer to the list. We can add multiple customers to a list as well. custList. as shown below: // Using cust variable created above (Fred Blogs / C123456) is // added to the List custList: custList. cust2. This can be pictured as follows: WARNING: If.custNumber = "C123457".add(cust).custNumber = "C123458".createCustomer().add(cust2). cust2. custList.Multiple Instances of a BOM Class 71 | Another way is to add the new customer to the custList. this would go wrong on two accounts.add(cust2).name = "Clint Hill". cust2. // Now add a second customer to the list (John Smith): cust2 = com_example_scriptingguide_Factory. after you used the script above.

So the list ends up containing the Fred Blogs and Clint Hill Customer instances but not John Smith: Instead.72 | Chapter 5 Business Data Scripting by Example First. it will attempt to add a second reference to the same Customer instance. Then when the add() method is called for the third time.add(c1). If references to the individual customer cust are not required outside of the script then local script. so the first two lines above modify the John Smith Customer instance to refer to Clint Hill. custList. Business Data Services Guide . c2. variables can be used in place of the process variable cust.createCustomer().createCustomer(). However.custNumber = "C567890". custList. c1.name = "Fred Blogs". this add will fail because the List type used does not allow the same object to be included more than once. c1. c2. // Create second customer instance var c2 = com_example_scriptingguide_Factory. a Customer instance must be created using the factory method for each Customer to be added to the list.name = "John Smith".add(c2). a new Customer instance has not been created for Clint Hill. The example below shows two script local variables c1 and c2 being used to correctly add two Customers to a custList: // Create first customer instance var c1 = com_example_scriptingguide_Factory.custNumber = "C123456".

c. c2.isRetail = true.add(cust). cust. We do not need to keep a reference to it any longer: // Create first customer instance var cust = com_example_scriptingguide_Factory.name = "John Smith". c.custNumber = "C123456".custNumber = "C567890". variable c could have been used throughout the script in place of c1 and c2. c. cust.name = "Fred Blogs". cust. c2.add(c1). cust. c1. for example: // Create first customer instance var c1 = com_example_scriptingguide_Factory.add(c).custNumber = "C123456".createDate().createCustomer().custNumber = "C567890".isRetail = true. cust.add(c).name = "Fred Blogs".copy(c1).add(c2). We can use the same var to store the new customer once the first customer has been added to the list.custNumber = "C567890".createCustomer().add(cust). This can be useful if there are a lot of attributes with the same value. custList.dateAdded = DateTimeUtil.name = "Fred Blogs". custList. c = com_example_scriptingguide_Factory.custNumber = "C123456". custList. Another way of creating the second and subsequent instances would be to make copies of the first. Business Data Services Guide . // Create second customer instance by copying the first var c2 = ScriptUtil.copy(cust). c1.createDate().name = "John Smith". c1. cust. custList.Multiple Instances of a BOM Class 73 | It is not necessary to use different variable names for the two Customer instances. c. but then the word var would have to be removed from the line that contains the second call to the createCustomer(): var c = com_example_scriptingguide_Factory.createCustomer().name = "John Smith". custList. custList. c1. // Create second customer instance by copying the first cust = ScriptUtil.createCustomer().dateAdded = DateTimeUtil.

"*". if the multiplicity is 1 (for example. as shown here: The above screenshot shows some example values that can be used to specify the multiplicity. orderline. in the same way Process Fields are managed when the Array checkbox is set in the Field Properties.1").6") then a List is used to manage the field. 3. When the multiplicity of an attribute is greater than one. an Order may contain multiple OrderLine objects. we can also specify that an attribute of a BOM Class can have and must have multiple instances.74 | Chapter 5 Business Data Scripting by Example In a BOM Class Attribute Just as we defined Process Fields that contained Multiple Instances of Customer Business Objects in the previous section.createOrderLine().add(orderline). orderline.. var orderline = com_example_scriptingguide_Factory. the following script can be written.. however.orderlines.partNumber = 10023.add(orderline). then a straightforward assignment can be used.orderlines. this is configured by setting the multiplicity of the attribute. other values can also be used. Otherwise.. Business Data Services Guide . multiplicity is "1" or "0. orderline. If the multiplicity is greater than one (e.g. a List is used to manage the data at runtime.createOrderLine(). for example..quantity = 1. "1.partNumber = 10056. In BOM Editor. orderline = com_example_scriptingguide_Factory. To manage the multiple orderlines associated with an Order. and values must be added to the field using List methods. order. for example. orderline.6 would mean between 3 and 6 instances must be added to the field.*" or "3.quantity = 3. order.

Some further examples of working with multi-instance fields and attributes are provided in the following sections: • • • • Looping Through Lists and Copying Elements in Lists on page 80.add(orderline). orderline. order.partNumber = 10056. orderline. accessing particular entries in the list.quantity = 1. To learn more about what you can do with the List object.quantity = 3.orderlines.partNumber = 10023. The List object provides methods for finding out how many items there are in the list.copy() method: var orderline = com_example_scriptingguide_Factory.add(orderline). Business Data Services Guide . see Using the List set() Method on page 84. order.orderlines. Scripting Containment Relationships on page 82. Removing an Item from a List or a Containment Relationship on page 85. orderline.copy(orderline). orderline = ScriptUtil. Using the List set() Method on page 84.Multiple Instances of a BOM Class 75 | or using the ScriptUtil.createOrderLine(). and enumerating the list. orderline.

c2. For example. custList. the need for temporary variables often arises. to declare (that is. Adding them to the list of Data Fields would just end up complicating the process. it is always best to initialize variables when they are declared so that TIBCO Business Studio’s Script Validation and Content Assist code knows what type the variables are. operation may not be supported and content assist will not be available The content assist will not work. c1.76 | Chapter 5 Business Data Scripting by Example Working with Temporary Variables and Types When writing scripts. This saves having to add all variables as Process Data Fields. var carName = "Herbie".custNumber = "C123456". So. a temporary variable is declared using the var keyword.name = "Fred Blogs".createCustomer(). custList. c2. When writing BPM scripts.createCustomer(). The variables can also be initialized (given initial values) when they are declared like this: var x = 5. Business Data Services Guide . using the example from the previous section.add(c1). If you do not initialize a variable. which is especially useful if the variables are only used within a single script. c1.custNumber = "C123457". it would not be a good idea to write: var c1.name = "John Smith". In JavaScript. var carName. to tell the script engine about) two temporary variables called x and carName you can write: var x. you will get the following warnings: Unable to determine type.add(c2). c2 = com_example_scriptingguide_Factory. var c2. c1 = com_example_scriptingguide_Factory.

c1.createCustomer().custNumber = "C123456". custList. c2.add(c2). c2. var c2 = com_example_scriptingguide_Factory. the variables should be initialized when they are declared: var c1 = com_example_scriptingguide_Factory. custList.createCustomer(). c1.name = "Fred Blogs".Working with Temporary Variables and Types 77 | Instead.add(c1). Business Data Services Guide .custNumber = "C123457".name = "John Smith".

ix++. The curly braces are required for loops in TIBCO Business Studio JavaScripts just as they are for if/else statements.1. or --ix. can be written result abbreviations allowed in JavaScript. using can be written ix--.1. } Things to note: • • • • result = result + " + ix. for (INITIALISER. JavaScript. while (ix >= 0) { result = result + " " + ix. using abbreviations allowed in = ix + 1. ix = ix . can be used similarly instead of ix . var ix = 10. ix = ix . CONDITION. INCREMENT) { BLOCK } One that is not supported is: for (FIELD in ARRAYFIELD) { BLOCK } Here is a simple while loop that loops until the ix variable becomes less than 0: var result = "".78 | Chapter 5 Business Data Scripting by Example Loops Within Scripts This section is intended chiefly for those readers not familiar with JavaScript. or ++ix. and one that cannot be used. There are three different JavaScript loop syntaxes that can be used in BPM Script. The ones that are supported are: while (CONDITION) { BLOCK } do { BLOCK } while (CONDITION). Business Data Services Guide . += " " + ix.

Loops Within Scripts 79 | The do-while loop is very similar. but has two extra expressions in it. } Business Data Services Guide . Here is the equivalent for loop to the above while loop: var result = "". but the condition is evaluated at the end of the loop. ix--. var ix = 10. so the loop is always executed at least once: var result = "". } while (ix >= 0). for (var ix = 10. It results in a more compact script. The for loop is similar to the while loop. One is executed before the loop starts and the other is executed at the end of each loop. { result += " " + ix. ix >= 0. ix--). do { result += " " + ix.

they are all initialized so that TIBCO Business Studio knows what type they are. This helps with Script Validation and Content Assist.creditLimit. for (var iterator=custlist.creditLimit. } Note that when the three temporary variables: totalCreditLimit. and you want to copy these to another Order Business Object called order.80 | Chapter 5 Business Data Scripting by Example Looping Through Lists and Copying Elements in Lists In order to iterate through a List.next().listIterator(). iterator and customer are declared. which contains multiple Orderline Business Objects in an attribute called orderliness. // add customer’s credit limit to total credit limit totalCreditLimit += customer. a ListIterator is used. // above statement is equivalent to: //totalCreditLimit = totalCreditLimit + // customer. Two methods on the ListIterator are used to enumerate the items in the List: the hasNext() method returns true if there are more items in the list.hasNext(). and the next() method returns the next item in the list (or the first item in the list the first time it is called): // Iterate through the list of customers to calculate the total // credit limit: var totalCreditLimit = 0. If one of the inputs to a script is a field called oldOrder. then the orderlines List in the new Order object cannot just be assigned: Business Data Services Guide . ) { // Get the first/next item in the list var customer = iterator. First you need to obtain the ListIterator from the List using the listIterator() method. iterator.

order. the instances in the List need to be copied over. } However.copy(orderline)). ) { var orderline = iterator.listIterator().hasNext().description = orderline. iterator. } This can be simplified by using the ScriptUtil.addAll(ScriptUtil.Looping Through Lists and Copying Elements in Lists 81 | Instead.createOrderline(). newOrderline.listIterator().productCode.orderlines.orderlines)).hasNext().orderlines This method will copy all elements from the oldOrder. order. as shown below: for (var iterator=oldOrder. You might think of doing it like this: for (var iterator=oldOrder. newOrderline. iterator.add(ScriptUtil.orderlines. order. and therefore should not be done (it will remove the object from the oldOrder Business Object). ) { var orderline = iterator.listIterator().orderlines. as Business Objects can only be contained in one Business Object. as shown below: order.description.next(). order. the content of the List needs to be copied over.hasNext().add(newOrderline).orderlines.amount = orderline.next(). this should not be done. } It can be simplified even more by using the ScriptUtil.amount.copyAll() method.orderlines.copyAll(oldOrder. Business Data Services Guide .next(). Instead. var newOrderline = com_example_scriptingguide_order1_Factory.copy() method to: for (var iterator= oldOrder. { var orderline = iterator.productCode = orderline.orderlines. iterator. Attempting to add a Business Object to a second Business Object in a containment relationship could have unexpected consequences.add(orderline). newOrderline.orderlines.orderlines List to the List.

The diagram below shows that Widget objects can be contained by a Car or a Bike. So when the Container (Car in our example) is destroyed.82 | Chapter 5 Business Data Scripting by Example Scripting Containment Relationships The BOM editor allows you to say that one class is contained within another. not both at once. as when its parent object is destroyed. all the contained (Widget in our example) objects will be destroyed too. For example. First. like this: Business Data Services Guide . it can only belong to a Car or a Bike instance. However. For the contained relationship. the child object is destroyed also. There are two ways to model this in the BOM editor. if there were classes for Car and Widget. the contained objects are affected by the container’s lifecycle events. the Widget class can be said to be contained by the Car class. a Composition link can be drawn between the two classes. for an individual Widget object instance.

Business Data Services Guide . as part of the process of inserting the object into container B. it is implicitly removed from container A. widget. This would be processed in a similar way to the List processing examples already covered.add(widget). car. the Car and Bike class can be given an attribute called widgets of type Widget. as shown below: Both of these two Car/Widget relationships appear the same when scripting. widget = com_example_scriptingguide_containment_Factory.widgets. var widget = com_example_scriptingguide_containment_Factory.createCar(). There is an attribute of the Car object called widgets.add(widget). car. we can write: var car = com_example_scriptingguide_containment_Factory. which will be a List type. that can contain Widget objects. so an object cannot be added to the same container more than once. and it is then added to container B. widget.description = "M8 Bolt".Scripting Containment Relationships 83 | Alternatively.createWidget(). We have already mentioned that the contained objects can only be contained by one container.widgets. car.createWidget ().model = "Saloon". Another aspect of the way that this relationship is enforced is that if an object is contained within container A.description = "M8 Nut". For example. to create a Car and add two Widgets.

if you have a car object that contains a number of Widgets.set(1. Instead.84 | Chapter 5 Business Data Scripting by Example For example.addAll(ScriptUtil. This interferes with the iterator which is attempting to iterate over a changing list. for example.listIterator(). } As mentioned above. and leaves the original copies contained in the Car object. it should not be changed unless by means of the ListIterator methods. so set() may not even be needed: var widget = bike.add(iter. ) { bike.next()).widgets. you cannot add two elements like this: bike.widgets.add(ScriptUtil. Instead. ) { bike.copy(iter.// This is wrong! bike. When a list is being iterated over.widgets)). it will fail as described below: for (var iter = car. } The above script takes copies of the objects. Business Data Services Guide . iter. the add() method must be used for adding new entries into a list. Existing entries can be directly updated.next())). the following should be done: for (var iter = car.set(0. iter.get(0).widgets. widgetB). widget. and you attempt to copy them into another Car or Bike object using the following script.listIterator(). Using the List set() Method It is important to note that the List set() method cannot be used for adding new items to a list.hasNext(). adding the Car’s Widgets to the Bike removes them from the Car.widgets.widgets. The above will fail because the list is empty.copyAll(car. You can also use the copyAll() method discussed in the previous section: bike.widgets.description = “Widget A”.widgets. // This is wrong! The reason this is wrong is that the set() method is for updating existing entries.hasNext().widgets. widgetA). if you have an empty list.

you should use the Iterator’s remove method.hasNext().creditLimit >= 1000000) { iterator. This method checks to see if it is the same object that was adde. If you don’t know which item you want to remove. } } Business Data Services Guide . // check if credit limit above 1. iterator.000. It does not compare the contents of the objects. the remove() method should be used. It can be used with the object to be removed.orderlines. or the index of the object to be removed: //Remove an object from a collection order.next().remove(0). and not a copy of it. ) { var customer = iterator. This is done using the list iterator as we have done before: // Iterate through the list of customers removing customers with large credit // limit for (var iterator=custlist.listIterator().remove(orderline1). The Business Object. or: order. To remove an item from a list means iterating through the list to find the item and then deleting it.000 if (customer.Scripting Containment Relationships 85 | Removing an Item from a List or a Containment Relationship In order to remove an item from a containment relationship or a list. must be the same Business Object instance that is in the list.orderlines. or other value passed. Be careful using the first example above.remove().

000. ix++) { var customer = custlist.000 if (customer. custList.86 | Chapter 5 Business Data Scripting by Example Alternatively this can be done just using the methods on the List object: // Iterate through the list of customers removing customers with large credit // limit for (var ix=0.creditLimit >= 1000000) { custlist. for example: bike. you have to be careful not to skip past elements after an element that is remove by only incrementing the index if the item is not removed! So using the iterator is easier. // decrement index so next iteration check the new nth item } } If the list index is managed in the script.remove(ix). Business Data Services Guide .clear(). // check if credit limit above 1.clear(). There is also a clear() method on Lists that can be used to remove all entries in the list. ix--. as in the second example.get(ix).widgets.size(). ix < custlist.

can be assigned Business Objects of type Product. which additionally have an isbn attribute Electrical.product = prod. If we had a Process Data Field called orderline of type Orderline. orderline.product = book.Scripting on Business Objects That Use Inheritance 87 | Scripting on Business Objects That Use Inheritance Using BOM Editor. orderline. which additionally have a serialNumber attribute. and then there are two different types of Products: • • Books.createBook(). then the containment of type Product.createProduct(). An example of this is shown in the screenshot below: In this example. Book. // Set the product attribute to a Book // Business Object var elec = com_example_spec3_Factory.createElectrical(). orderline. there is a general Product type. // Set the product attribute to an // Electrical Business Object var prod = com_example_spec3_Factory.product = elec. or Electrical: var book = com_example_spec3_Factory. // Set the product attribute to a // Product Business Object Business Data Services Guide . Another way of expressing this is to say that you can create BOM classes that specialize other classes. you can define BOM classes that inherit attributes from other classes.

some Electrical Business Objects.88 | Chapter 5 Business Data Scripting by Example Similarly. you can add all three types to the products list. or the base type Product. productCatalog. in scripts.products. Electrical.createElectrical(). and some may just be Product Business Objects. if we have Process Data Field called productCatalog of type ProductCatalog. var elec = com_example_spec3_Factory. Similarly. some of these which can Book Business Objects. For example. Business Data Services Guide . the products containment can contain many Product Business Objects.add(book). as shown below: The above code sample shows an attempt to create a List of Text that contains the ISBN number of the Product instances that are Book subtype Book instances.createBook().add(elec).products. however.products.add(prod). productCatalog. You will get an error if you attempt to access the isbn attribute of a Product Business Object. You will not be able to access the attributes of the Book or Electrical classes. productCatalog.createProduct(). var prod = com_example_spec3_Factory. as shown here: var book = com_example_spec3_Factory. the Script Editor just gives you the content assist for the Product object. it will just show the Product details. it does allow you to add new instances of Book. If a Process Data Field productCatalog of type ProductCatalog type appears on a Form in a UserTask. if you iterate through the products List.

products. book = product.add(book. If the Product field or attribute actually refers to a Product or Electrical Business Object.createISBNList().next(). we know from the test that we conducted previously. iter.type) { var book = com_example_spec3_Factory.BOOK == product. In our example. then it does not satisfy the "is-a" Book condition.createBook(). for (var iter = productCatalog. from a variable or attribute of a Product type. It is always OK to assign a sub-type (specialized type) object to a supertype (generalized) attribute or variable because you can say that the sub-type object satisfies the "is-a" relationship. Then we assign the Product Business Object to the book variable. will only work at runtime if the Product actually refers to an instance of the Book class (or a sub-type). ) { var product = iter. The assignment will fail when the value is saved at the end of the task. then the above code can fail at runtime when attempting to access the isbn attribute if the product (and hence the book) was referring to a Product or an Electrical Business Object as these do not have the isbn attribute. However. bookList. Business Data Services Guide .Scripting on Business Objects That Use Inheritance 89 | To get around this problem. it is not always OK to do things the other way around. we can create a variable called book. if (ProductType. which we initialize to an object of type Book. Howerver.isbn).listIterator().isbns. Assigning an attribute or process data field that is a Book type. after which TIBCO Business Studio allows access to the attributes of the Book class. } } The TIBCO Business Studio Script Editor gives a warning about the assignment of a field that it thinks contains a Product to a field that it treats as holding a Book. a warning is given that the assignment may not work at runtime: bookList = com_example_spec3_Factory. that in this case it is safe: If we do not have the above check. Book "is-a" Product.hasNext(). However.

BOOK == product. if (ProductType.books.BOOK == product.next(). if (ProductType.hasNext(). } } Otherwise. Business Data Services Guide .hasNext().listIterator(). ) { var product = iter. if the bookList is a Book type Process Data field.copy(product)).90 | Chapter 5 Business Data Scripting by Example If. and add that to the booklist/books containment relationship. for (var iter = order. ) { var product = iter.BOOK == product. instead of building up a list of ISBN Text values.createBookList().listIterator().add(ScriptUtil. for (var iter = order.type) { bookList.type) { bookList.hasNext(). if the booklist refers to a BookList type Business Object with an attribute or composition relationship called Books. } } However. ) { var product = iter.books. Remember that a contained Business Object can only be in one container at a time.add(product). for (var iter = order.// THIS IS WRONG } } We should write: bookList = com_example_spec3_Factory. we wanted to create a List of Products that were also Books and.createBookList(). To stop this from happening.listIterator(). we are moving the Book Product out of the containment relationship with the order and products into the relationship with booklist/books. iter.next(). iter.products.products.type) { bookList. if (ProductType. iter. then we can write: bookList = com_example_spec3_Factory. then instead of writing: bookList = com_example_spec3_Factory.add(product). you must make a copy of the object.next().createBookList().products.

substr(6) Business Data Services Guide . for example: if (firstString == nextString) { // do something } else { // do something else } There are a number of methods on the String class that can be used to manipulate the value of the String object.5) Result 12 Hello TIBCO! Comment Returns length of string Return substring starting at offset 0. var thirdString = "Fred's World". for example. // // // quoted using double quote character quoted using single quote character includes single quote so used double quote includes double quote so used single quote string includes both so need \ character to escape use of quote in string String values can be compared with the "==" operator. Table 7: String Operations Expression str.Working with Strings or Text Fields 91 | Working with Strings or Text Fields String values can easily be assigned using either single or double quotation marks. considering the following String variable: var str = "Hello TIBCO!".substr(0. However.length str. they must be of the same type. // // var fifthString = "Fred's \"Old\" House". The following operations can be done on the String. for example: var firstString = "Hello World!". // // // // var fourthString = ' "The Old House" '. 5 characters long Return substring starting at 6th position in string str. var nextString = 'Hello Fred!'.

The original String is not changed. see Text (String) Methods on page 203.92 | Chapter 5 Business Data Scripting by Example Table 7: String Operations Expression str.slice(6. so when one of the above functions returns a String value. str.9) Result TIB tibco! Hello TIBCO! Comment Returns substring starting at offset 6 and finishing before offset 9 Returns substring starting 6 characters from end of String and changes all letters to lowercase Returns first word in string.slice(0. or whole string if one word str.slice(-6). str.slice(str. consider using the User-defined Types described in Working with Primitive Types on page 106. it is a reference to a new String.lastInd exOf(" ")+1) For more information about String class methods. If you want to restrict what Strings can be put into certain Text fields. or whole string if one word Returns last word in String. The String objects are immutable.toLower Case().indexOf(" "))) str. Business Data Services Guide .

can be used to convert from a text (true/false) or numeric (1/0) Boolean representation to the Boolean type. then the Boolean result is true.discountApplied !( cust.createBoolean() method should be used. Table 8: Operators that can be used with Boolean Values Operator && || ! Description And – both are true Or – either is true Not – reverses result Example cust. then the ScriptUtil.discountApplied cust. for example: if (cust1. The exclamation mark "!" is the "not" operator. For example: Customer.isTrade = ScriptUtil.initialised customer. memberOfStaff. or expressions. If the text field is not exactly true or false. Using the createBoolean() method if the value of the Text field is TRUE (in any case). When attempting to convert a text field value to a Boolean (for example.isWholesale && order. Similarly.isWholesale == cust2.isWholesale = = = = true. false.isWholesale || order. otherwise it is false. Boolean values can be compared with the "==" and "!=" operators. Values greater than or equal to 1 get converted to true. other Boolean fields.Working with Booleans 93 | Working with Booleans Boolean fields can be simply assigned from constants.createBoolean() method should be used.isWholesale && order. changing the sense of a true value to false.createBoolean(isTradeParameter).discountApplied) Business Data Services Guide .staffDiscount customer.isOnCreditHold customer. and values less than or equal to 0 get converted to false. and a false value to true. ! isRetailCustomer. attempting to assign a text field to a Boolean will generate an exception. the ScriptUtil. for example: customer. from true to true). if you want to convert a numeric value (0 or 1) to a Boolean.isWholesale) { … Boolean values can also be combined with the following logical operators.

select the attribute in the BOM class. If you are dealing with smaller numbers. 1.000. but the Signed Integer sub-type is easier to use from a scripting point of view. or 231-1).g. Signed Integers For smaller numbers. astronomical numbers.000 (actually. 457.147. In order to select the sub-type.000. however.94 | Chapter 5 Business Data Scripting by Example Working with Basic Integer Numbers There are two types of integers (for example. When working with integer numbers. whole numbers. 2. for example. you need to be aware of what the largest value is that you could be dealing with.647. then the fixed form of integers needs to be used. a number of people. numbers up to 2. so it is probably the sub-type of choice. then the signed integer type can cope with numbers up to 2.) that are supported: Signed Integers and Fixed Length Integers. and so on. and look at the Advanced Properties sheet: Business Data Services Guide . for example. e. if you are dealing with larger.483. either form of integers can be used. The larger Fixed Integers are dealt with in the Advanced Scripting section.

weightKgs.members.averageWeight = totalKgs / teamSize. var teamSize = 0. The operators for comparing signed integers are: Table 9: Operators for Comparing Signed Integers Operator == Description Equals Example 1 == 2 12 == 12 != Not Equals 1 == 2 12 == 12 < Less than 1<2 12 < 12 21 < 20 Result false true true false true false false Business Data Services Guide . you can do the following: var totalKgs = 0.next(). totalKgs = totalKgs + member.Working with Basic Integer Numbers 95 | In scripting. using the arithmetic abbreviations that can be used in scripting.hasNext(). to work out the average weight of a team member.listIterator(). teamSize = teamSize + 1. } if (teamSize > 0) { team.weightKgs. } else { team. When dividing.averageWeight = 0. teamSize++. The code above checks for this special case. for (var iterator = team. iterator. } Note that the two lines in the loop that update the running totals can be shortened to: totalKgs += member. do not divide by 0. ) { var member = iterator.

96 | Chapter 5 Business Data Scripting by Example Table 9: Operators for Comparing Signed Integers Operator <= Description Less than or equals Example 1 <= 2 12 <= 12 21 <= 20 >= Greater than or equals 1 >= 2 12 >= 12 21 >= 20 > Greater than 1>2 12 > 12 21 > 20 Result true true false false true true false false true See Working with Fixed Length Integers (BigInteger) on page 118 for more information. Business Data Services Guide .

). For Floating Point decimals. especially if large amounts are involved.weightKgs.next(). have to be manipulated using their methods (add().79769E+308 and -2. the downside is that the Fixed Point attributes are implemented as BigDecimal objects. teamSize++. and can perform arithmetic using many different types of rounding as required. The Fixed Point variant can store numbers to an arbitrarily large size. "*". just as the Integer attributes in the previous section. var teamSize = 0. multiple(). totalKgs = totalKgs + member. "-". The Floating Point variant can store: • • • Negative numbers between -1.0.79769E+308. The Floating Point variant stores numbers with 16 significant digits of accuracy. like the BigInteger objects in the previous section. for (var iterator = team.weightKgs.Working with Basic Decimal Numbers 97 | Working with Basic Decimal Numbers Just as Integers have two variants. see Advanced Scripting Examples on page 117. which.) instead of the normal arithmetic operators ("+". assuming that averageWeight is now a Floating Point decimal attribute of the team Data Field.225E-307 and 1. ) { var member = iterator. the two additional lines can be abbreviated as: totalKgs += member.listIterator(). For more information about the Fixed Point decimal attributes. money amounts. However. The sub-type to use is selected in the Advanced Property sheet for the attribute. there are two variants of Decimal attributes in BOM classes: Floating Point and Fixed Point. teamSize = teamSize + 1. for example. Rounding errors may occur. subtract.225E-307 0 Positive values between 2. } team. we can write: var totalKgs = 0.hasNext(). and so on. divide(). As in the integer example. it should not be used for storing values that have to be exact. iterator. However. Here are some examples that demonstrate how decimals can be used in scripts. and so on.averageWeight = totalKgs / teamSize. "/".members. Business Data Services Guide .

The ScriptUtil. to round to the nearest 100. then the Math." ==". "!=". log & trig functions and random() and floor() functions. for example.round(value. "<=".round(value.round() method: roundedValue = Math. See also Working with Fixed Decimals (BigDecimal) on page 122. for example. for example.568 using HALF_UP rounding.round() method can also be used to round to a power of 10.4) To get around this problem. If you wanted to round down.floor(value*1000)/1000. Rounding of Floating Point Decimals can be done using the ScriptUtil. use the standard "<". the result of the following expression is false due to rounding errors: (((1/10) * 14) == 1.98 | Chapter 5 Business Data Scripting by Example To compare Floating Point decimal values. 3).floor() method can be used instead of the ScriptUtil. the values should be rounded before comparison.round() method. This converts 1234. For more information about how these operators can be used. The Math class provides other methods. This rounds 1234. the power of 10 is 2. see Operators for Comparing Signed Integers on page 95.56789 to 1234. so use: roundedValue = ScriptUtil. Business Data Services Guide . ">=" and.56789 to 1200.) As an example of how Floating Point numbers may not be exactly as they seem. -2). See Math Methods on page 206 for details. ">" operators. (These operators are the same as for the Signed Integers. It is possible that two numbers that appear to be the same may not be equal using the "==" operator due to rounding errors in the way that the numbers are represented. to convert a number to 3 decimal places you can write: roundedValue = ScriptUtil.

M. 1st January 2011. Table 10: DateTimeUtil Factory Methods Factory Method createDate() createTime() createDatetime() createDatetimetz() BOM Type Date Time Datetime Datetimetz Comment This type is used to hold a Date.createDatetime("2010-12-25T15:00:00"). 12. 25). with an optional timezone offset.createDate("2010-12-25"). The date/time attributes and fields can be initialized in scripts using methods on the DateTimeUtil factory. datetime = DateTimeUtil.createDatetimetz("2010-12-25T15:00:00+05:00"). Business Data Services Guide . time = DateTimeUtil. as shown below. date = DateTimeUtil. Specifically. This provides methods to manipulate the date/time type variables and attributes. datetime = DateTimeUtil. Time.createDatetime("2010-12-25T15:00:00+05:00"). or alternatively. with a mandatory timezone offset.createTime("17:30:00").30.// equivelant to “2010-12-25” datetime = DateTimeUtil. With no parameters these methods create an object representing the current date or time. datetimetz = DateTimeUtil. datetimetz = DateTimeUtil. The following are some examples of date/time types.createTime(17.0. for example.0). for example 4:25 P. and Datetimetz types are represented using a XMLGregorianCalendar object within the Script Engine.createDate(2010. This type is used to hold a date and time. This type is used to hold a time. Datetime. they can be given a string or other parameter types to construct the appropriate object with the required value. One thing to be aware of if using String values to create date/time objects is that all the relevant fields need to be specified or an exception will be thrown. time = DateTimeUtil. the seconds need to be specified for all types except the Date type.Working with Dates and Times 99 | Working with Dates and Times Dates and Times The Date.createDatetime("2010-12-25T15:00:00Z"). This type is used to hold a date and time.// equivelant to “17:30:00” date = DateTimeUtil.createDatetimetz("2010-12-25T15:00:00Z").

nM. the timezone is required. See the reference section for more choices of parameter values.456 seconds DateTimeUtil. but when initializing the datetimetz. 0. or Zero.createDuration(true.456S"). followed by nH.0.// 1 day and 2 hours When constructing a period of time from a string. 0. 0. 0.createDuration(false. 2. always begin with a P for Then add nY. for timezones that are ahead of UTC time. for example. 0. 1.// 1 year DateTimeUtil. nM.// 2 hours 23. 0. where n is a number of years.// 1 day and 2 hours Business Data Services Guide . 0. or nS for specifying hours. 0. -HH:MM for timezones that are behind UTC time. Berlin timezone is +HH:MM +01:00. the timezone is optional. for separated parameters for year. If there is any time component to the Duration. DateTimeUtil.100 | Chapter 5 Business Data Scripting by Example When initializing the datetime. Any fields that are zero can be omitted.// 1 year 0).456). minus 10 days. A duration object can be created in a similar way: duration duration duration duration duration = = = = = DateTimeUtil. DateTimeUtil. The Duration type can also be created by specifying each of the components as integers with a flag to say whether the duration is positive: duration duration duration duration duration = = = = = DateTimeUtil. 0. or 2 hours. 0.createDuration("P1DT2H"). e.// minus 10 days DateTimeUtil. 0.createDuration(true.// 2 hours DateTimeUtil. 0).// 23. This can be used with the add() method to subtract a time period.createDuration("P10D"). 2. A leading minus sign can be used to create a negative duration. month.g. 1. 0. minutes. 0. 0. 0. months.createDuration(true. 0.10. DateTimeUtil. 0. The timezone can be designated using one of the following formats: • • • Z for Zulu. e. USA Pacific Time has a timezone of -08:00. which is used to hold periods of time.createDuration(true. 0. Durations Another important attribute/variable type when dealing with dates and times is the Duration type.// 23.456 seconds 0).// minus 10 days 0). DateTimeUtil.createDuration("PT23. or days. timezone offset (GMT or UTC time). and day when create date types. a T must follow the date parts. or seconds. such as 1 year. 0.createDuration("PT2H"). period.createDuration("P1Y").g. or nD.

var datetime = DateTimeUtil.0)). write: datetime. since the add() method does not return a value.0.createDate().add(DateTimeUtil. Duration objects are Immutable.createDuration(“PT2H”)).add(DateTimeUtil. like BigDecimal and BigInteger objects. rather than return a new value. var date = DateTimeUtil. The following example calculates a datetime corresponding to 36 hours ago. This is the same as in normal arithmetic where there are two ways of taking 2 from 10.createDatetime().2 is the same as 10 + -2.0. you can add a negative duration.createDuration(false.Working with Dates and Times 101 | Using Date and Time Types with Durations One important point to be aware of is that the date/time (XMLGregorainCalendar) objects are not immutable. The following example calculates 1 year ago. The result of 10 . Business Data Services Guide . we must use the format of adding a negative amount.0.add(DateTimeUtil.createDuration("-P1Y")).createDuration(“PT2H”)).0. The second code results in datetime being set to null. datetime. date. If you want to subtract a time period from a date or time type.36. To add 2 hours onto a Datetime.add(DateTimeUtil. In order to subtract durations. Not: datetime = datetime. so the add() and setXXX() methods update the object that the method is on.

To check for greater than or equals.compare(startdate) == DatatypeConstants. An example of using the compare()method to compare two date fields is shown below: // Verify that end date is greater than start date if (enddate.LESSER) { // End date is greater than or equal to start date – OR INDETERMINATE!! } Business Data Services Guide . The compare() method should be used to compare items that either do or do not have a timezone.GREATER enddate. The equals() method is just a wrapper around the compare() method. either the compare() or equals() method should be used.102 | Chapter 5 Business Data Scripting by Example Comparing Dates and Times In order to compare two date/time types. but if they are less than 14 hours apart.GREATER) { // End date is greater than start date } Do not use the XMLGregorianCalendar compare() method in the same way you would use the compareTo() method to compare BigInteger and BigDecimal objects due to the possibility of it returning INDETERMINATE.compare(startdate) == DatatypeConstants.compare(startdate) == DatatypeConstants.compare(startdate) != DatatypeConstants.EQUAL) { // End date is greater than or equal to start date } || Using the following will also include the INDETERMINATE result: // Verify end date is greater than or equal to start date if (enddate. use the following: // Verify end date is greater than or equal to start date if (enddate. the result is deemed to be indeterminate. The method still works if the date/times are more than 14 hours apart.

To find out how many days have elapsed since the start of the year.createDate(). startOfYear).setDay(1). Business Data Services Guide . // Extract the days from the duration type and add 1 dayOfYear = duration.getDays() + 1. // get today’s date var today = DateTimeUtil.setMonth(1). Business Data Scripting.subtract(today. startOfYear.Working with Dates and Times 103 | The XMLGregorianCalendar class does not provide a method for finding the difference between two XMLGregorianCalendar objects. You can read about the different methods that are available on the date/time attributes in Appendix B. so one is provided in ScriptUtil. startOfYear.createDate(). write: // Calculate date of first day of the year by getting current date // and setting day and month to 1 var startOfYear = DateTimeUtil. // Subtract the start of year from today to work out how many days have elapsed var duration = ScriptUtil. on page 181.

104 | Chapter 5 Business Data Scripting by Example Working with Enumerated Types (ENUMs) If you want to categorise objects as different types. it can be named. An ENUM is created in the BOM editor by selecting the Enumeration type from the Elements section of the Palette. a class attribute can be set to that type: Business Data Services Guide . with PLANET. ASTEROID. The names of the values can be made meaningful. and STAR values: Having defined the Enumeration type. Having selected the Enumeration Element. MOON. instead of using a number or a free format string. and values can be added to it. use an Enumerated Type (ENUM). in that they can only take a fixed limited number of values. Enumerated Types provide a better solution because they are restricted. The following is an example of an Enumerated type called SpaceType.

such as: aggregation.objectList. dPlanetCount ++.0.weightKgs. For example. or other attributes of that type. iterator. if (SpaceType.hasNext().averagePlanetWeight = dTotalKgs / dPlanetCount.listIterator(). which can be used to calculate the average weight of the planets in a list of astronomical bodies.type) { dTotalKgs = dTotalKgs + planet. var dTotalKgs = 0.Working with Enumerated Types (ENUMs) 105 | The following is an example of a loop. An attribute of an enumeration type cannot be assigned from any other type. Either constants of that type.type = "PLANET".type. // This is wrong! Business Data Services Guide .next(). } } solarSystem. var dPlanetCount = 0.type = SpaceType.type = body. ) { var body = iterator.PLANET == body. the following is not valid: body. A Business Object attribute that is configured to be of a particular Enumeration type can only be assigned with values of that enumeration type. for (var iterator = solarSystem. such as: body.PLANET.

Business Data Services Guide .followed by 6 digits (\d is the code for a digit and {6} means six of the previous entity). For our example. To do this. For example. such as PN-123456.and are followed by six digits. If all Part Numbers have a fixed format like this. if you need to store a Part Number in a field. set up a User-defined Type to hold the Part Number. you can define restrictions that are imposed on the field. you can use a Primitive Type. call it PartNumber. The patterns are specified using regular expressions. you can name it. use: PN-\d{6} Which means PN. and restrict the type so that it only holds strings that start with PN. you can only assign values to the partNum attribute that matched the pattern PN-\d{6}. this field will probably have a restricted format. such as numeric ranges for numeric fields and patterns for text fields. select the Primitive Type from the Elements section of the Palette.106 | Chapter 5 Business Data Scripting by Example Working with Primitive Types If you want to have field that can contain a restricted set of values. In scripts and forms. but the set of values is too big for an enumerated type. Set a class attribute to contain a PartNumbertype attribute as shown above. For our example. Having created one of these. In the Advanced Properties sheet.

orderline. this will cause a runtime validation exception when the Task that contains the script completes.Working with Primitive Types 107 | Attributes of Primitive Types can be assigned in the same way as the BOM Native Type on which they are based. so. If a script is written with an invalid format value. Instead.partNum = "PN-123456". as shown in the example below: order. the partNum field can be assigned using: order. using the above example.orderline. Business Data Services Guide . the script editor will not detect this as an error.partNum = "ROB-123456". since it does not check that Strings have the correct content.

0).setDay(1). // adjust in case on 31-Jan datetime.setTime(0. if we want a script to calculate a timeout to be the end of the month.add(DateTimeUtil. month datetime.createDatetimetz(). // return value of script Business Data Services Guide . // back to end of prev.createDuration("P7D")). // clear hours.108 | Chapter 5 Business Data Scripting by Example Return Values from Scripts The following expressions use these return values from scripts to perform certain functions: • • • Conditional flows – Boolean expressions that control whether a path is followed or not.createDuration("-P1D")). // get current datetime datetime. Loop Conditions – Boolean expressions that determine whether a loop should continue or not. we can use the following: var datetime = DateTimeUtil. For example. which is 7 days in the future. // change to 7 days time datetime.add(DateTimeUtil. // move on to next month datetime. These expressions can be multi-line expressions. minutes & seconds datetime. Task TimerEvent – Datetime expressions that determine when a task should timeout.createDuration("P1M")).0. The value of the script is the value of the last line in the script.add(DateTimeUtil.

we can see the WSDL file under the Service Descriptors heading. and select the webservice you want to invoke from the WSDL: Looking in the Package Explorer. then click Import WSDL. we perform the following tasks. First. add a Service Task onto the process diagram by dragging it from the tasks palette: Then. Locate your WSDL using one of the mechanisms provided (file location. in the General Properties sheet. set the Service Type to Web Service. You can open the WSDL by double-clicking the WSDL entry (or right-clicking on the WSDL entry and selecting OpenWith/WSDL Editor). URL. we can see what types the Web Service takes as parameters: Business Data Services Guide .Scripting with Web Services 109 | Scripting with Web Services To invoke a web service and use scripts to prepare data for the web service. and so on). Viewing the WSDL in the WSDL Editor.

from the Input To Service property sheet. map the requestInfo field to the RequestInfoType input of the Web Service by dragging the field name onto the parameter name. as shown in the diagram below: Business Data Services Guide .110 | Chapter 5 Business Data Scripting by Example We can now create two Data Fields in the process of the appropriate types: Then.

change the name of the task to something appropriate. on the General property sheet. Call "Request" Web Service. we have completed the Web Service task: Now we need to prepare the data to go into the webservice and process the data that comes out of the web service. for example.Scripting with Web Services 111 | The mapping will then be shown like this: Then. This can be done in scripts. drag two script tasks onto the Process Diagram before and after the Web Service call and name them appropriately: Business Data Services Guide . repeat for the output of the Web Service: Then. To do this. Then.

For example. and enter the script. First. msisdn = flexpaySubscriberId. it will have to wrap it in a BOM class. then you cannot just have a Text parameter flagged as an Array: Business Data Services Guide . Therefore. because this will have already been done by the Web Service task. Something similar can be done in the script after the Web Service task.requestName = "Search". The BOM class must contain a multi-instance attribute. It is not necessary to make the flexpaySubscriberId field point to an object. if a process needs a field that contains multiple instances of a Business Object that it wants to pass in or out of a web service.correlationId = 123456. requestInfo. The multi-instance attribute must contain the multiple instances rather than an Array field. requestInfo. requestInfo.ban. See Using Content Assist on page 67 for more information). } Passing Arrays to Web Services Web Services cannot be passed (in or out) of an array field. set the Script Defined As property to JavaScript. for example: // Process response from Web Service Call if (null != flexpaySubscriberId) { ban = flexpaySubscriberId. requestInfo. we need to make the RequestInfo variable refer to an actual RequestInfo object by initializing it using the factory method (don’t forget to use the content assist to help. The followng script is one example: // Prepare Web Serice Call Request requestInfo = com_amsbqa_linda01_xsd_define_types_types_Factory.createRequestInfoType(). In the General property sheet of the first script.112 | Chapter 5 Business Data Scripting by Example The error markers in the figure above indicate that the scripts have not been written yet. All that remains to do is process the values.userName = "Fred Blogs".msisdn. if you want to pass an array of Strings to a webservice.password = "Password!".

0 : Activities responsible for generating WSDL operations cannot have array parameters associated. (ProcessPackageProcess:StartEvent) Business Data Services Guide .Scripting with Web Services 113 | Instead. create a BOM class to wrap the multiple Text values like this (Note that multiplicity of 0.. the following error message appears: BDS Process 1.* indicates that the attribute can contain zero or more values which is like the Array setting on a Process Field): And then reference this type as a parameter: If you define a webservice with an Array parameter. instead please create a business object class to contain the array.

Only the WebService task does not support Array fields.copyAll() method. but that cannot be used for Basic fields like the Text array in this example.114 | Chapter 5 Business Data Scripting by Example When calling the webservice. Business Data Services Guide . for example. as described in Looping Through Lists and Copying Elements in Lists on page 80. as shown below: If an array of Business Objects was being passed using the ScriptUtil. An Array object can be passed to other Task types. User Tasks or ScriptTasks. copy the text array into the parameter structure with a loop like this in the ServiceTask’s Init Script. could be used to copy the array of Business Objects in a single statement.

If the string begins with any other value. If the string begins with 0. for example. If the radix parameter is omitted. Business Data Services Guide . This function determines if the first character in the specified string is a number. and returns the number as a number. the radix is 16 (hexadecimal). the radix is 8 (octal). This feature is deprecated.Parse Functions 115 | Parse Functions This section contains notes on: • • parseInt() parseFloat() parseInt() The parseInt(string integer. it parses the string until it reaches the end of the number. a radix of 16 (hexadecimal) indicates that the number in the string should be parsed from a hexadecimal number to a decimal number. not as a string. parseFloat() The parseFloat() function parses a string and returns a floating point decimal number. radix]) function parses a string and returns an The radix parameter specifies which numeral system is to be used. the radix is 10 (decimal). [. JavaScript assumes the following: • • • If the string begins with 0x. If it is.

116 | Chapter 5 Business Data Scripting by Example Business Data Services Guide .

page 122 Object BOM Native Type. page 129 Object BOM Native Type and ScriptUtil. page 132 escape() and unescape().Advanced Scripting Examples 117 | Chapter 6 Advanced Scripting Examples This chapter gives some examples of scripting using some classes and methods that require special attention. page 134 encodeURI() and decodeURI(). page 118 Working with Fixed Decimals (BigDecimal).setObject(). page 135 Business Data Services Guide . Topics • • • • • • • Working with Fixed Length Integers (BigInteger). page 134 encodeURIComponent() and decodeURIComponent().

add(planet.divide(planetCount). ScriptUtil. = planets. ScriptUtil. ) var planet = iterator. and so on. } Business Data Services Guide .createBigInteger("0").averageWeight = totalKgs. In the BOM editor. planetCount = planetCount. then we would want to use the Fixed Length integers which are implemented using Java BigIntegers. operators cannot be used. and want to work out the weight of the average planet. "<". "/".createBigInteger(0).createBigInteger(1).planetList. ">". the methods of the BigInteger class have to be used when doing arithmetic and comparisons.listIterator().weightKgs). } if (planetCount. } else { planets.compareTo(one) >= 0) { planets. Instead. "-".createBigInteger(0). iterator. totalKgs = totalKgs.add(one). "==". The "+".next(). the attribute sub-type should be set to Fixed Length: The script should be written as shown below: var var var for { totalKgs = planetCount = one = (var iterator ScriptUtil. "*".averageWeight = ScriptUtil.hasNext().118 | Chapter 6 Advanced Scripting Examples Working with Fixed Length Integers (BigInteger) If we are working with large integer numbers.

add(planet. !=. for (var iterator = planets.weightKgs). >=. ) { var planet = iterator. since the number of planets will not have a very large value.planetList. <. the expression x.createBigInteger(0). <=. Given two BigInteger variables x and y. Business Data Services Guide . and then convert it into BigInteger for the divide operation at the end of the script: var totalKgs = ScriptUtil.createBigIntger(2). For example.averageWeight = ScriptUtil. planetCount ++. The equals() method returns true or false depending on whether the values are equal or not. you have to use the compareTo() or equals() methods.next(). totalKgs = totalKgs. >}).averageWeight = totalKgs. } else { planets.divide(ScriptUtil.createBigIntger(1). var planetCount = 0.listIterator(). } In order to compare Fixed Integers.createBigInteger(planetCount)).compareTo(y) <op> 0 returns the same results as the following when using the Signed Integer sub-type if x and y were signed integer values: x <op> y (Where <op> is one of the 6 comparison operators: {==. iterator. var two = ScriptUtil.hasNext().Working with Fixed Length Integers (BigInteger) 119 | Or. } if (planetCount >= 1) { planets. assuming that variable one has a value of 1 and variable two has a value of 2: var one = ScriptUtil. we can have the planet counter as a signed integer.createBigInteger("0").

compareTo(one) < 0 two.compareTo(two) != 0 one. Therefore.compareTo(y) < 0 Less than one.compareTo(one) <= 0 x.compareTo(one) < 0 x. Business Data Services Guide .compareTo(two) > 0 one.compareTo(y) == 0 Description Equals Example one. However. for example. all the above methods do not change the object that they are working on.compareTo(two) >= 0 one.compareTo(two) == 0 one. they do not change once they are created.compareTo(one) >= 0 x.compareTo(one) == 0 x.compareTo(one) <= 0 two.compareTo(y) <= 0 Less than or equals one. they return a new BigInteger object that has the new value.compareTo(one) != 0 x.120 | Chapter 6 Advanced Scripting Examples Then: Operator x.compareTo(y) >= 0 Greater than or equals one.compareTo(one) >= 0 two. These are: abs min add mod compareTo multiply divide negate equals pow gcd remainder max subtract One thing to note about BigIntegers is that they are Immutable.compareTo(y) > 0 Greater than one.compareTo(one) > 0 Result false true true false true false false true true false false true true false false true There are other methods available on the BigInteger objects.compareTo(y) != 0 Not Equals one. which you can read about in Fixed Length Integer (BigInteger) Methods on page 191. if appropriate.compareTo(two) <= 0 one.compareTo(two) < 0 one.compareTo(one) > 0 two.

so when initializing large BigInteger values. the value should be passed as a String. Otherwise accuracy can decrease since it is converted to a double and then onto a BigInteger. For more details on the BigInteger type.com/javase/6/docs/api/java/math/BigInteger.createBigInteger(12345678901234567890) The result is the creation of the number 9223372036854776.html Business Data Services Guide .oracle. For example: var bigInt = ScriptUtil. It is important to be aware that the JavaScript numeric type is only accurate to about 16 significant figures. located at the following web site: http://download.createBigInteger() method is that the number to create can be passed as a String or a Numeric type. rather than 12345678901234567890 as might be expected. see the Java documentation.Working with Fixed Length Integers (BigInteger) 121 | Another thing to bear in mind when creating BigInteger objects with the ScriptUtil.

multiply(). we would use the add() method of the Fixed Decimal attribute: dTotalKgs = earth. and divide() that can be used to perform the other arithmetic operators. in order to add the two fixed decimals together.add(moon. especially if the values are large. it is best to use a Text parameter.weight). see the reference section at the end of this document.0).createBigDecimal("0. = ScriptUtil.createBigDecimal() factory method. or a quoted string (or a BOM Text attribute value). Business Data Services Guide . Simple Operations Instead of using operators like "+" and "-" to perform basic arithmetic with Fixed Decimals. In most cases. For more details on these methods. so those methods that generate new BigDecimal results all return the new value. Fixed Decimal values are Java Objects that need to be created using the ScriptUtil. which is converted to the exact number. rather than update the object that is being operated on. as is done with Floating Point decimals. whereas some small errors can occur when using numeric parameters. There are similar methods called subtract().createBigDecimal(0. Creating and Initializing Fixed Decimal Values Instead of just initializing variables or attributes in scripts with numbers. For example. for example: var dTotalKgs var dTotalKgs = ScriptUtil. The value passed to the factory method can either be a JavaScript number (or a BOM Floating Point attribute value). if we had two Business Objects called earth and moon. you must use methods to perform these operations.0"). and each had a weight attribute of Fixed Decimal type.weight.122 | Chapter 6 Advanced Scripting Examples Working with Fixed Decimals (BigDecimal) Fixed Point (BigDecimal) objects are immutable like the BigInteger objects.

which is discussed following it): var dTotalKgs = ScriptUtil.averageWeight = dTotalKgs.5 1. var dPlanetCount = 0.1 Business Data Services Guide . which would be required to store 1/9 = 0.5 1.6 1.next(). it can be applied with or without the precision.hasNext(). There are two ways that Rounding Mode can be applied to the divide() method: either directly. However. This would work quite well now that we have 8 planets. since the BigDecimal class stores numbers up to an arbitrary level of precision.listIterator(). Table 11: Example Rounding Mode Results According to Single Digit Rounding Input Input Number 5. iterator. Additional details of the behavior regarding the different modes can be found in the reference section.add(planet. and attempting to divide a number by 9 often results in a recurring string of decimals if done exactly.planetList. CEILING. If applied directly.createBigDecimal(0.createBigDecimal(dPlanetCount)). but in the days before Pluto was downgraded to a Dwarf Planet we had nine planets. there is a problem with the code. There are eight possible values for RoundingMode: UP.weightKgs).5 2.6 1.divide(ScriptUtil. but you can also see from the example here how different values are rounded according to the different RoundingModes. HALF_EVEN. or by way of a MathContext object that contains a precision and RoundingMode.Working with Fixed Decimals (BigDecimal) 123 | Rounding If we needed more accuracy we would use a BigDecimal. also known as a Fixed Point Decimal.5 2. } planets. ) { var planet = iterator. for the averageWeight attribute as represented in the code below (however. HALF_DOWN. for example.111111….1 Up 6 3 2 2 Down 5 2 1 1 Ceiling 6 3 2 2 Floor 5 2 1 1 Half _up 6 3 2 1 Half_down 5 2 2 1 Half_even 6 2 2 1 Unnecessary 5. So when doing division operations that can result in recurring decimals or other overflows. dTotalKgs = dTotalKgs. Rounding Mode must be applied to the BigDecimal method that is being used. DOWN. FLOOR. dPlanetCount ++. for (var iterator = planets. it does NOT store numbers to an infinite level of precision. HALF_UP. This causes problems for BigDecimals.0). or UNNECESSARY.

5 There are three built-in MathContexts provided: DECIMAL32.1234512345123451234512345123451234512 3451234512346 Business Data Services Guide .5 Up 1 -1 -2 -2 -3 -6 Down 1 -1 -1 -1 -2 -5 Ceiling 1 -1 -1 -1 -2 -5 Floor 1 -1 -2 -2 -3 -6 Half _up 1 -1 -1 -2 -3 -6 Half_down 1 -1 -1 -2 -2 -5 Half_even 1 -1 -1 -2 -2 -6 Unnecessary 1.6 -2. UP HALF_UP UP HALF_UP UP 10 10 50 1 0 0. The table below shows the results of dividing 12345 by 99999 using BigDecimals with different Precisions. then a precision (number of significant figures) and Rounding Mode (HALF_UP) equivalent to that used by the Floating Point Decimal sub-type (which is the same as the Double type used in languages such as Java and C. no exact representable decimal result.5 -5. and MathContexts. RoundingModes.1234512346 0.0 -1. DECIMAL64.1234512345 0. and DECIMAL128.0 -1.lang. Table 12: Example Rounding Mode Results According to BigDecimals Digit Rounding Input Rounding Mode Precision Math Context Result java.124 | Chapter 6 Advanced Scripting Examples Table 11: Example Rounding Mode Results According to Single Digit Rounding Input Input Number 1.ArithmeticException: Non-terminating decimal expansion.1 -1. The UNNECESSARY rounding mode is the default RoundingMode. and the Numeric type used in JavaScript) is used. If the DECIMAL64 MathContext is used.1 -1.5 -5.0 -1. and will generate an exception if the resultant number of digits used to represent the result is more than the defined precision.0 -1.6 -2.

1.averageWeight = totalKgs. the compareTo() method sees that there is no difference between them.mc).1234512345123451234512345123451234512 3451234512345 0. and returns 0. Business Data Services Guide .4 to differ from 1.1234512 0.DECIMAL128).5 up planets.createBigDecimal (planetCount).5 up planets.1234512345123451 0.HALF_UP).averageWeight = totalKgs.createBigDecimal (planetCount).4 is stored in BigDecimal as the number 14 with a scale of 1 and a precision (for example.divide(ScriptUtil.averageWeight = totalKgs.5 up (using MathContext) var mc = ScriptUtil.lang. meaning they have the same value. The divide() method called above should be changed to: // 30 significant digits.createBigDecimal(planetCount). rounding 0. or // 34 significant digits.divide(ScriptUtil.ArithmeticException: Non-terminating decimal expansion.RoundingMode.Working with Fixed Decimals (BigDecimal) 125 | Table 12: Example Rounding Mode Results According to BigDecimals Digit Rounding Input Rounding Mode HALF_UP Precision 50 DECIMAL32 DECIMAL64 DECIMAL128 Math Context Result 0.createMathContext(30. When comparing BigDecimal values it is best to use the compareTo() method.40 is stored as the number 140 with a scale of 2 and a precision of 3.40. planets. or // 30 significant digits. rounding 0. The equals() method does not recognize them as the same. as the equals() method considers 1.divide(ScriptUtil.1234512345123451234512345123451235 java. This is because 1. number of digits) of 2. rounding 0. However. no exact representable decimal result. MathContext.RoundingMode.30.HALF_UP ).

compareTo(y) <= 0 Business Data Services Guide .126 | Chapter 6 Advanced Scripting Examples Comparing Fixed Decimals and BigDecimals The BigDecimal compareTo() method can be used in the same way as the BigInteger compareTo() method. when comparing two decimal fields x and y. For example. instead of using x <relational_operator> y you must use x.compareTo(y) <relational_operator> 0 This will return the value that you expect the first expression to return. if you want to use the expression x <= y you should write x. but in summary. Detailed information on how this can be used is available in the previous section on Integers.

0").createBigDecimal("0.divide(planetCount. For example.. The following example here is a version of the script that checks that the planetCount is greater than or equal to one using the BigDecimal compareTo() method: var totalKgs = ScriptUtil. For example. the value should be passed as a String. } When creating BigDecimal objects with the ScriptUtil.listIterator(). It is important to be aware that the JavaScript numeric type is only accurate to about 16 significant figures. If there is a problem with the script so that there are no planets in the list. var one = ScriptUtil.RoundingMode. Therefore.hasNext(). care should be taken to ensure that the divisor is not zero.createBigDecimal("0. even for values that you would not expect it to.next(). if great accuracy is required. } else { planets. so when initializing BigDecimal types.add(planet. you need to be aware of how BigDecimal values are stored. which may introduce some rounding errors. They are stored as two integer values: unscaled value and scale. If the value is not passed in a String.0"). } if (planetCount. then the planetCount variable will be 0. the value 0.5 up planets. iterator..compareTo(one) >= 0) { // 30 significant digits.add(one).1 may not be stored exactly in a Numeric type. otherwise an exception will be generated.30. as it results in a recurring sequence of binary digits when expressed in binary: 0. the number to create can be passed as a String or a Numeric type. planetCount = planetCount. The value of a BigDecimal is: (unscaled_value) * 10-scale Business Data Services Guide .456789 is stored as a BigDecimal value. When rounding BigDecimal variables.createBigDecimal ("1"). and our divide operation will cause an exception. it will have an unscaled value of 123456789 and a scale of 6. totalKgs = totalKgs.averageWeight = ScriptUtil. if the number 123.createBigDecimal ("0"). scripts should be programmed defensively to protect against such things. ) { var planet = iterator. for (var iterator=planets.averageWeight = totalKgs.createBigDecimal() method.planetList. var planetCount = ScriptUtil.Working with Fixed Decimals (BigDecimal) 127 | As with all divide operations.00011001100110011001100110011. rounding 0. the value entered in the script will first be converted to a Numeric type.HALF_UP).weightKgs).

For more information on BigDecimal. available at the following web site: http://download. otherwise an exception will be generated at runtime.128 | Chapter 6 Advanced Scripting Examples The setScale() method is used to round values. to 3. for example. If the setScale() method is called with a scale of 10. To convert to 3 decimals using the HALF_UP rounding strategy. You must tell setScale() how you want to round the value.4567890000 to 123.457. or the Java Documentation.oracle. rounding must take place often. in our example. When reducing the number of decimal places. RoundingMode.setScale(3.html Business Data Services Guide . see Fixed Point Decimal (BigDecimal) Methods on page 192. However.com/javase/6/docs/api/java/math/BigDecimal.HALF_UP). This converts.4567890000. it would actually represent 123. 123. then the scale would become 10 and the unscaled value would be changed to 1234567890000 so that the number still has the same numerical value. write: roundDecimal = decimal.

Object BOM Native Type 129 | Object BOM Native Type There are four different varieties of BOM objects: • • • • xsd:any xsd:anyAttribute xsd:anyType xsd:anySimpleType All of these allow for different assignments. or a BOM class. given the following BOM: If a Web Service process has the following fields and parameters Data Field / Parameter Input Parameter Data Field Data Field Type Class1 Class2 Class3 Name inputField1 bomField2 bomField3 Business Data Services Guide . For example. Using the Object BOM Native Type xsd:any The Object Type is used to handle sections of XML with an unknown format or where content is not known. It is also not possible to assign a BOM object of one variety into a BOM bject of a different variety. However. once data has been stored in an object. It must remain in that object. An Object type BOM class attribute can be assigned either another Object attribute. it cannot be read back out into its original type. xsd:any). but the data of which can still be passed on by the system. BOM Attributes can be defined as Object type (for example.

No other BOM type can be assigned either to or from it. You can also write outputField1. it behaves in the same manner but instead of taking a BOM Class as its input it takes a primitive type. bomField2 can be used as the input parameter to another Web Service. xsd:anySimpleType The xsd:anySimpleType is very similar to xsd:any.bomObject1. in which case the add() method will be used as usual for assigning values to the field. which would pass the xsd:any value from the input parameter of one service to the input parameter of another service.add(bomField3). for example: outputField1. Business Data Services Guide . This type can only be assigned to itself.bomObject1. Object BOM Native Type attributes can have a multiplicity greater than one.130 | Chapter 6 Advanced Scripting Examples Data Field / Parameter Output Parameter Type Class2 Name outputField1 Then a script in the process can be written as bomField2. xsd:anyAttribute The xsd:anyAttribute is a very restrictive form of Object BOM Native Type. which would pass the Business Object bomField3 in an xsd:any type construct in the response XML message for the web service.bomObject1 = bomField3.bomObject1 = inputField1.

This makes it the most flexible of storage types. due to ambiguities with knowing how to parse incoming XML if there are more than one. // Copy a text field into the anyType Class1. // Copy an entire BOM Class Instance Class1.anyType2). so do not use a Business Object that includes an Object BOM Native Type attribute as a parameter to the UserTask. a BOM Class instance). The difference is that it can be assigned either a BOM Class or primitive type. You cannot examine the contents of any of the Object BOM Native Types. // Copy an anyType from one Class to another Class1.copy(Class2. then you must use ScriptUtil.anyType1 = ScriptUtil.e. Business Data Services Guide . One important difference is that if you wish to set the value of an xsd:anyType to the same value as either another xsd:anyType or a Business Object (i.copy(Class2). BPM Forms do not support the Object BOM Native Type.anyType1 = ScriptUtil.copy() in order to take a copy of the source object before assigning it to the xsd:anyType.Object BOM Native Type 131 | xsd:anyType The xsd:anyType is again similar to both the xsd:any and xsd:anySimpleType.textData Restrictions There can only be one Object BOM Native Type attribute in any class hierarchy (this is the only case for xsd:any and xsd:anyAttribute).anyType1 = Class2.

132 | Chapter 6 Advanced Scripting Examples Object BOM Native Type and ScriptUtil. to find the parameters that can be used in this case you need to find the name of the element associated with the class (type). If the BOM was created in TIBCO Business Studio. Select the class in the BOM editor.setObject(outputField1. bomField3. if the BOM was created by importing an XSD Schema and the simple assignment interface is used. and look at the advanced properties sheet: Business Data Services Guide . then BDS will automatically select the best available element in which to store the complex object. as in the following example: ScriptUtil.Class3Element"). For situations where you wish to specify which element the complex data is stored as. "com.bomObject1 = bomField3. then there is only one element for each type. a utility method can be used.example. However.bomobjectexample. so the above example will always produce the desired result.bomObject1. For the above example. a BOM Class instance) to an Object BOM Native Type attribute (imported xsd:any) looks like this [from the previous example]: outputField1.setObject() The default assignment of a Business Object (for example.

The element name is combined with the BOM namespace to make up the third parameter to the ScriptUtil.setObject() line: ScriptUtil. In the screenshot above. bomField3.setObject(outputField1. This ScriptUtil function allows the script writer to define which element the xsd:any should be associated with.example. "com.Object BOM Native Type and ScriptUtil. Business Data Services Guide .bomobjectexample.setObject() method. For this BOM example.bomObject1.Class3Element"). the XsdTopLevelElement property is listed. there are two elements: Class3Element and Class3ElementB. the namespace can be found in the Name field of the BOM properties sheet: Concatenating the two parts results in the following ScriptUtil.setObject() 133 | At the bottom of the property sheet.

134

| Chapter 6

Advanced Scripting Examples

Additional Javascript Global Functions
Described below are some additional Javascript global functions you can use.

escape() and unescape()
The JavaScript escape() and unescape() functions can be used to encode strings that contain characters with special meanings or outside the ASCII character set. The escape() function encodes a string. This function makes a string portable, so it can be transmitted across any network to any computer that supports ASCII characters. The function does not encode A-Z, a-z, and 0-9. Additionally, the function encodes all other characters with the exception of: "*", "@", "-", "_", "+", ".", "/". The escape() function maps:
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmno pqrstuvwxyz{|}~

To:
%20%21%22%23%24%25%26%27%28%29*+%2C-./0123456789%3A%3B%3C%3D%3E%3F@ABCDEFGHIJKLM NOPQRSTUVWXYZ%5B%5C%5D%5E_%60abcdefghijklmnopqrstuvwxyz%7B%7C%7D%7E

encodeURI() and decodeURI()
The encodeURI() function is similar to the escape() function but encodes fewer character. Encoding the string:
!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\\]^_`abcdefghijklmno pqrstuvwxyz{|}~

Will produce:
%20!%22#$%25&'()*+,-./0123456789:;%3c=%3e?@ABCDEFGHIJKLMNOPQRSTUVWXYZ%5b%5c%5d%5 e_%60abcdefghijklmnopqrstuvwxyz%7b%7c%7d~

So only the following characters are encoded: SPACE, "“", "&", "<", ">", "[", "\", "]", "^", "`", "{", "|", "}"

Business Data Services Guide

Additional Javascript Global Functions 135

|

encodeURIComponent() and decodeURIComponent()
These functions are similar to the encodeURI() and decodeURI() methods, but they additionally encode and decode the following characters: ,/?:@&=+$#

Business Data Services Guide

136

| Chapter 6

Advanced Scripting Examples

Business Data Services Guide

Business Data Modeling Best Practice 137

|

Chapter 7

Business Data Modeling Best Practice

This chapter gives some brief guidance on best practice.

Topics
• • • • • • • • Choose Appropriate Data Types, page 138 Use Sub-Packages to Aggregate Related Concepts, page 139 Process Data Field Granularity, page 140 BOM Class, Attribute and Variable Names, page 141 Do Not Split a Namespace Across Projects, page 144 Reference a Common Business Object Model, page 142 Do Not Modify Generated BOMs , page 145 Business Data Scripting Best Practice, page 146

Business Data Services Guide

If it is insufficient. Be aware of the limitations of the default Floating Point Decimal sub-type . use the Fixed Integer type.138 | Chapter 7 Business Data Modeling Best Practice Choose Appropriate Data Types Take care when selecting attribute types: • • Be aware of the value space of the default Signed Integer sub-type [-231.231-1].16 significant digits. Limitation of accuracy and rounding issues may indicate that it’s not suitable for handling large values. use Datetimetz. • Business Data Services Guide . With Datetime types if a timezone is required.

Use Sub-Packages to Aggregate Related Concepts 139

|

Use Sub-Packages to Aggregate Related Concepts
It is a good practice to put all related concepts in a sub-package. For example, in a claim model BOM there can be classes, primitive types, and enumerations relating to customers, policies, and claims. So three sub-packages can be created to collect the different types together in different groups. If the root package name is com.example.claimmodel, then there can be sub-packages called:
• • • com.example.claimmodel.customer com.example.claimmodel.policy com.example.claimmodel.claim

Organizing classes, enumerations, and primitive types in sub-packages makes them easier to find when viewing the BOM, and also when scripting it means that the factory has fewer methods in it, which makes it easier to find the method that you need. As an extension to this, you can actually have sub-packages in different BOM files. When doing this, it is important that each package or sub-package is only in one BOM file. Using the above example, you can have three BOM files for the three sub-packages, or you can have four if some things are defined in the root package. Alternatively, it can just be split into two BOM files with the root package and two sub-packages in one BOM file, and the third sub-package in the second file.

Business Data Services Guide

140

| Chapter 7

Business Data Modeling Best Practice

Process Data Field Granularity
If a number of related parameters are commonly passed to Tasks, it is a good idea to create a BOM class that contains all the parameters. Then, all the values can be passed to the tasks as a single parameter. However, one thing to be aware of is that if you have parallel paths within your process that are both processing a Business Object, then the changes made by the first branch to complete may be overwritten by data from the second branch if it is all stored in a single Business Object. To get around this problem, each branch should only be given the data it needs. Then, the data should be merged back into the single Business Object after the branches have merged together.

Business Data Services Guide

BOM Class, Attribute and Variable Names 141

|

BOM Class, Attribute and Variable Names
It is recommended that BOM class names begin with an uppercase letter and that variable and attribute names begin with a lowercase letter so that they can easily be distinguished. This is the convention used by Java, and what is done by the label to name mapping if Labels contain words with initial capital letters. In order to read variable names that are made up of several words, it is recommended that you use "camelcase", where the initial letter of every word (apart from the initial word in a data field or attribute name) is capitalized. A data field holding a customer account should be written customerAccount. Similarly you can have data fields called headOfficeName. This naming convention is used in the factory methods, so if there is a CustomerAccount class, then there will be a createCustomerAccount() method in the factory. If you enter Labels with initial capitals for each word then this will be achieved. Therefore, a label written as "Customer Account" will be converted to a class name of CustomerAccount, or an attribute name of customerAccount. If the label is written as "Customer account", the class name and attribute name will be Customeraccount and customeraccount, both of which are not so readable.

Business Data Services Guide

142

| Chapter 7

Business Data Modeling Best Practice

Reference a Common Business Object Model
It can be valuable to define commonly-used Business Objects in one Business Object Model in a common project, and then re-use these objects by referencing them from multiple other projects. Just as it is common practice for an Organization Model to be defined in one project and referenced from other projects, the same can be done for BOMs that are to be used by many projects.

For example, company-wide generic Business Objects can be put in a shared BOM project that defines BOM classes in a top-level package. Here is an example of what the top-level BOM package can look like:

Business Data Services Guide

The following screenshot shows the AcmeWeb BOM referring to BOM classes defined in the top-level BOM: You can see that the Book and Electrical classes are specializations of the Product class. Business Data Services Guide . and the other projects can define processes that use objects from both the local and the shared BOMs. Any projects that just contain BOMs do not get deployed. The other projects that reference the BOMs will each include the BDS plug-ins for the shared BOMs as part of their own deployment.Reference a Common Business Object Model 143 | The AcmeIntranet and AcmeWeb projects can define their own BOM sub-packages that inherit from the top-level BOM package. and the Order class contains Products that are defined in the top-level BOM.

example.claimmodel.example.claimmodel.claimmodel.customerdetails package.Customer must both be defined in the package that defines the com. the following classes must both be defined in the package that defines the com. For example.claimmodel. Business Data Services Guide .144 | Chapter 7 Business Data Modeling Best Practice Do Not Split a Namespace Across Projects Classes from the same package must not be defined in separate BOM files.customerdetails.example.customerdetails.example.customerdetails package: • • com.Address com.

Do Not Modify Generated BOMs | 145 Do Not Modify Generated BOMs Do not modify the contents of BOMs in the Generated Business Objects folder of a project. then the XSD (or WSDL) should be imported into the Business Objects folder. then any changes made by editing the BOM could be lost. Business Data Services Guide . If the intention is to import an XSD and generate a BOM. The BOMs created in the Generated Business Objects folder as a result of importing XSDs or WSDLs into the Service Descriptors folder should not be edited because if the file is regenerated.

so ensure that all the Out and In / Out fields for the task have valid values before the script task is completed. Check for Nulls It is very important to check that fields and attributes are not null before attempting to get their values. You can do this by breaking potentially large chunks of logic into separate scripts. Keep the Scripts Small It is recommended that you keep scripts small. Use Comments in Scripts It is good practice to comment code to make it easier for others who follow you to understand what the scripts are doing. Ensure Business Objects Are Valid Before Scripts Complete Remember that the length. and multiplicity are checked at the end of every script. limits. Business Data Services Guide . the former construction will result in a syntax error. Use Constant First when Comparing a Constant with a Variable Using: constant == variable is safer than: variable == constant If "=" is used instead of "==" by mistake.146 | Chapter 7 Business Data Modeling Best Practice Business Data Scripting Best Practice This section contains some suggestions for Business Data scripting.

page 151 Business Data Services Guide . page 150 Troubleshooting BDS Scripting .Troubleshooting 147 | Chapter 8 Troubleshooting This chapter describes how to identify and resolve some problems you may encounter when using Business Data Services. Topics • • • Viewing BDS-generated BDS Plug-in Hidden Projects. page 148 BDS Plug-in Generation Problems.

change the view so that it does not hide folder and file names that begin with ". Business Data Services Guide .". To view the BDS Plug-ins that have been generated. uncheck . This can be done by clicking the View Menu in the Project Explorer: Select Customize View…. In the Available Customizations dialog.*resources.148 | Chapter 8 Troubleshooting Viewing BDS-generated BDS Plug-in Hidden Projects BDS Plug-ins can be seen in the Project Explorer.

a pair of projects are created: Looking at these can be useful to understand how things are working.Viewing BDS-generated BDS Plug-in Hidden Projects 149 | For each BOM. Business Data Services Guide .

the BDS Plug-in folders should be regenerated: In the above screenshot. Then. Then the project that the Scripting Guide BOM comes from can be cleaned and rebuilt to regenerate the projects. If the projects are not regenerated. then click the Problems tab to check for reasons that the BOM generation may not be working: The BOM editor warns you about problems by showing a red cross in the upper-right corner of the problem element: Pointing to the red cross causes a dialog to display containing information about the error.150 | Chapter 8 Troubleshooting BDS Plug-in Generation Problems Check to see if the BDS plug-ins are being created by looking for the hidden folders as described in the previous section. if the project is rebuilt. To verify that they are being generated. the BDS plug-in folders can be removed. for example: Business Data Services Guide . the two Scripting Guide folders can be deleted.

Break Script into Smaller Scripts Add User Tasks between script tasks to see the field values. Log files are located in: <CONFIG_HOME>/tibcohost/<INSTANCE_NAME>/nodes/BPMNode/logs/BPM.log On Windows. Business Data Services Guide .Troubleshooting BDS Scripting | 151 Troubleshooting BDS Scripting Occasionally. This section provides instruction on how to identify and resolve BDS scripting problems. ensure that the debugging level is turned up to maximum (see the Administrator interface documentation for your BPM runtime for more information about editing logging levels). BDS Classes Do Not Appear or Changes Do Not Appear Check that there are no problems with the BDS Plug-in generation. as described previously. In order to do this. It can be useful to look at these logs when debugging scripts that are not working. the default location for CONFIG_HOME is: /opt/amxbpm/tibco/data The default INSTANCE_NAME is Admin-AMX BPM-AMX BPM Server. a script does not function as planned. the default location for CONFIG_HOME is: C:\ProgramData\amx-bpm\tibco\data On UNIX. Examine the Server Logs TIBCO BPM components write out logging information as they process work.

tibco.Async schedule work item with model message failed ¬{extendedMessage=`Param [integer] Value [111222333444] exceeds the defined maximum limit of 9`. methodName=`scheduleWorkItemWithModel`.util.n2.tibco.bpm.privScheduleWorkItem(WorkIt emSchedulerBase. severity=`ERROR`.n2.java:619) `. compositeApplicationName=`amx.tibco.brm.DataModelFactory.AsyncWorkItemSchedulerService Impl`.brm.impl.util.83.tibco.invoke(Unknown Source) … at java. hostAddress=`10.brm. environmentName=`BPMEnvironment`.java:1707) at com.Thread.n2.model. eventType=`FAULT`.tibco. Business Data Services Guide .417+0000`.DataModelFactory.tibco.n2.WorkItemSchedulerBase.scheduleWorkItemWithWorkMod el(WorkItemSchedulerBase.DataModelFactory.152 | Chapter 8 Troubleshooting Checking the log file can help locate the cause of scripting problems.brm. nodeName=`BPMNode`. stackTrace=`com. priority=`HIGH`.java:2280) at com. componentClassName=`com. message=`Async schedule work item with model message failed`. threadId=`1056`.lang.services.run(Thread.417 [Default Service Virtualization Thread_72] [ERROR] com.services.services. creationTime=`2011-03-23T17:53:50.checkItemBodyDataTypesFromPayload(D ataModelFactory.services.AsyncWorkItemSchedulerServiceImpl .checkDataTypeValues(DataModelFactor y.GeneratedMethodAccessor635. ¬} Write Variable Values and Progress Updates from the Script to the BPM Log File A facility for writing messages from scripts to the server called the BPM Log file is provided.java:621) at com. componentId=`BRM`.80`.brm.n2.brm.util.impl.WorkItemSchedulerBase. threadName=`Default Service Virtualization Thread_72`.[ERROR] {BRM_WORKITEM_ASYNC_SCHEDULE_WORK_ITEM_WITH_MODEL_MESSAGE_FAILED} . correlationId=`6fb66791-595c-499b-ad55-5b56b7404fac`.services.n2. messageCategory=`WORK_ITEM`. principalName=`tibco-admin`. contextId=`6fb66791-595c-499b-ad55-5b56b7404fac`.java:2185) at com. serviceName=`AsyncWorkItemSchedulerService`.100.impl. requestReceived=`Wed Mar 23 17:53:50 GMT 2011`.n2. hostName=`uk-keitht`.n2.java:1323) at com.AsyncWorkItemSchedulerServiceImpl.tibco.impl.tibco. lineNumber=`290`. managedObjectId=`78`.reflect.app`. messageId=`BRM_WORKITEM_ASYNC_SCHEDULE_WORK_ITEM_WITH_MODEL_MESSAGE_FAILED`.java:263) at sun.scheduleWorkIte mWithModel(AsyncWorkItemSchedulerServiceImpl. For example: 23 Mar 2011 17:53:50.WorkItemFault: Param [integer] Value [111222333444] exceeds the defined maximum limit of 9 at com.checkDataTypeValue(DataModelFactory .tibco.model.model.brm.brm. principalId=`tibco-admin`.n2.services. methodId=`asyncScheduleWorkItemWithModel`.impl.brm.

529 [PVM:Persistent STWorkProcessor:5] [INFO ] stdout . Customer: '"+cust. for example. eval() The eval() function provides the ability to execute a dynamic script useful for debugging purposes. and executes it as if it was part of a script. eval (scriptField). which allows you to step through a process and to examine process flow and data manipulation. New Customer Process.or part of the message. This generates a message like the following in the BPM Log file. you could enter them into a Text field on a Form. For example. Then. Use the Process Debugger A debugger. the following can be done from a script: Log.name + "' added"). which can be found by searching for the text stdout .Troubleshooting BDS Scripting | 153 For example. get a script to execute the commands in the Text field. TIBCO recommends that you do not use this function in a production environment because it allows the execution of any script text that is provided at runtime. is provided with TIBCO Business Studio. to test some expressions. 11 Feb 2011 09:42:06. see the tutorial How to Debug a Business Process. Although useful for experimenting with scripts and testing them. Business Data Services Guide . This is given a string. However.New Customer Process. Customer: Fred Blogs added See Examine the Server Logs on page 151 for the location of the log. which is available in the TIBCO Business Studio help and the HTML help that is installed on disk in the BPM runtime. this function is only useful if you have access to the BPM Log file which is stored on the server.write("New Customer Process. For more information.

For example.154 | Chapter 8 Troubleshooting Catch Exceptions If there is the possibility that a script will generate an exception at runtime. and the properties of one of them: Business Data Services Guide . you can catch the exception and take corrective action in the process using a catch event. the following are some ScriptTasks with IntermediateCatch events attached to them.

page 163 BDS Limitations. Topics • • • • • • Data Type Mappings.| 155 Appendix A Supplemental Information This appendix includes reference material to support your use of Business Data Services. page 180 Business Data Services Guide . page 170 JavaScript Features not Supported in TIBCO BPM Scripting. page 156 Unsupported XSD Constructs. page 177 Reserved Words in Scripts. page 164 Data Mapping.

Table 13: BOM Native Type to BDS Type Mapping BOM Native Type Attachment Boolean Date Datetime Datetimetz Decimal – Fixed Point Decimal – Floating Point Duration ID Integer – Fixed Length Integer – Signed Object .Duration java.xsd.lang.XMLGregorianCalendar Mutable? N/A No Yes Yes Yes No No No No No No No No No No No Yes Business Data Services Guide .lang.datatype.emf.lang.eclipse.datatype.Math.Integer org.xsd.eclipse. and whether they are mutable or not.Double javax.anyAttribute Object .xml.FeatureMap org.BigDecimal java.Math.xml.xml.ecore.util.lang.XMLGregorianCalendar java.datatype.XMLGregorianCalendar javax.XMLGregorianCalendar javax.datatype.util.156 | Appendix A Supplemental Information Data Type Mappings This section contains tables showing data type mappings.xml.Boolean javax.xsd.any Object .String javax.BigInteger java.anytype Object .Object java.lang.xsd. BOM Native Type to BDS Type Mapping This table shows which Java Type the BOM Native Types are mapped onto.ecore.emf.datatype.anySimpleType Text Time BDS Java Type N/A java.lang.String java.FeatureMap EObject java.xml.

lang. but the values of immutable types cannot. The methods that operate on them return new objects with the new values instead of mutating the value of the original object. XSD Type to BDS Type Mapping The following table shows what BDS types the different XSD types are mapped to Table 14: XSD Type to BDS Type Mapping XSD Type xsd:base64Binary xsd:byte xsd:byte (nillable) xsd:decimal xsd:float xsd:float (nillable) xsd:gDay xsd:gMonth xsd:gMonthDay xsd:gYear xsd:gYearMonth xsd:hexBinary xsd:IDREF xsd:IDREFS xsd:integer xsd:language BOM Native Type Text Integer (signed) Decimal (fixed – BigDecimal) Decimal (floating point – Double) Text Text Text Text Text Text Text Text Integer (fixed – BigInteger) Text BDS Type String Integer BigDecimal Double String String String String String String String String BigInteger String Business Data Services Guide .String Mutable? No The values of Mutable types can be changed.Data Type Mappings 157 | Table 13: BOM Native Type to BDS Type Mapping BOM Native Type URI BDS Java Type java.

158

| Appendix A

Supplemental Information

Table 14: XSD Type to BDS Type Mapping XSD Type xsd:long xsd:long (nillable) xsd:Name xsd:NCName xsd:negativeInteger xsd:NMTOKEN xsd:NMTOKENS xsd:nonNegativeInteger xsd:nonPositiveInteger xsd:normalizedString xsd:positiveInteger xsd:QName xsd:short xsd:short (nillable) xsd:unsignedByte xsd:unsignedByte (nillable) xsd:unsignedInt xsd:unsignedInt (nillable) xsd:unsignedLong xsd:unsignedShort xsd:unsignedShort (nillable) xsd:string BOM Native Type Integer (fixed – BigInteger) Text Text Integer (fixed – BigInteger) Text Text Integer (fixed – BigInteger) Integer (fixed – BigInteger) Text Integer (fixed – BigInteger) Text Integer (signed) Integer (signed) BDS Type BigInteger BigInteger String String BigInteger String String BigInteger BigInteger String BigInteger String Integer Integer

Integer (fixed – BigInteger)

BigInteger

Integer (fixed – BigInteger) Integer (signed)

BigInteger Integer

Text

String

Business Data Services Guide

Data Type Mappings 159

|

Table 14: XSD Type to BDS Type Mapping XSD Type xsd:int xsd:int (nillable) xsd:double xsd:double (nillable) xsd:ID xsd:date xsd:datetime xsd:duration xsd:time xsd:anyURI xsd:boolean xsd:boolean (nillable) xsd:ENTITY xsd:ENTITIES xsd:anyType xsd:anySimpleType xsd:token xsd:any xsd:anyAttribute Decimal (floating point – double) Text Date Datetime Duration Time Text Boolean Text Text Object Object Text Object Object Double BOM Native Type Integer (signed) BDS Type Integer

String XMLGregorian Calendar XMLGregorian Calendar Duration XMLGregorian Calendar String Boolean String String EObject Java Object String FeatureMap FeatureMap

Business Data Services Guide

160

| Appendix A

Supplemental Information

JDBC Database Type to BOM Data Type Mapping
The following table shows mappings between: • • JDBC database types TIBCO Business Studio Business Object Model (BOM) types. See TIBCO Business Studio Business Object Modeler User’s Guide for more detail.

Table 15: JDBC Database Type to BOM Data Type Mapping JDBC Database Type BIT TINYINT SMALLINT INTEGER BIGINT FLOAT REAL DOUBLE NUMERIC DECIMAL CHAR VARCHAR LONGVARCHAR DATE TIME TIMESTAMP BINARY VARBINARY LONGVARBINARY BOM Type Boolean Integer (signed) Integer (signed) Integer (signed) Integer (fixed - BigInteger) Decimal (floating point - double) Decimal (floating point - double) Decimal (floating point - double) Decimal (fixed point - BigDecimal) Decimal (fixed point - BigDecimal) Text Text Text Date Time Datetime Attachment1 Attachment1 Attachment1

Business Data Services Guide

Data Type Mappings 161

|

Table 15: JDBC Database Type to BOM Data Type Mapping JDBC Database Type NULL OTHER JAVA_OBJECT DISTINCT STRUCT ARRAY BLOB CLOB REF DATALINK BOOLEAN ROWID NCHAR NVARCHAR LONGNVARCHAR NCLOB SQLXML 1. Not currently supported. BOM Type Text Text Attachment1 Text Text Text Attachment1 Text URL URL Boolean Text Text Text Text Text Text

Business Data Services Guide

162

| Appendix A

Supplemental Information

Process Primitive Data Type Mapping
TIBCO Business Studio supports the following process basic data types. Table 16: Process Primitive Data Type Mapping Process Primitive Type Boolean Integer Java Type Representation Boolean Integer Constrained to 9 digits. TIBCO Business Studio validates that the upper limit is not exceeded. Decimal Text Date Time Datetime Performer Double String XMLGregorianCalendar XMLGregorianCalendar XMLGregorianCalendar String Date, without timezone offset. Time, without timezone offset. Date and time, with optional timezone offset. A 64-bit floating point number. Comments

Business Data Services Guide

Unsupported XSD Constructs 163

|

Unsupported XSD Constructs
The following XSD Constructs are not supported: • • • • • • • XSD list XSD Redefine XSD Key XSD KeyRef XSD Unique XSD Notation XSD ComplexType as restriction of another complex type

Business Data Services Guide

164

| Appendix A

Supplemental Information

BDS Limitations
The following sub-sections contain further notes and restrictions.

BDS and Forms
Object Type The BDS Object type is not supported in Forms, so Business Objects that include Object type attributes cannot be displayed on Forms.

Simple Type Default Values
Currently, simple types with default values are not supported. The default value is ignored. This is an EMF restriction. For example:
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:tns=http://example.com/ElementSimpleDefault targetNamespace="http://example.com/ElementSimpleDefault"> <xsd:element name="elementWithDefault" type="tns:NewType" default="10"/> <xsd:complexType name="NewType"> <xsd:simpleContent> <xsd:extension base="xsd:integer"> <xsd:attribute name="NewAttribute" type="xsd:string"/> <xsd:attribute name="NewAttribute1" type="xsd:string"/> </xsd:extension> </xsd:simpleContent> </xsd:complexType> </xsd:schema>

Fixed Attribute Overwrite
If an element or attribute in a complex object exists, it is possible in EMF to actually overwrite the fixed value with a different value. This is then persisted in the XML instead of the fixed value, thus creating invalid XML against the schema.

Business Data Services Guide

the following is an XSD fragment: <xs:sequence maxOccurs="unbounded"> <xs:element name="fruit" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="cake" type="xs:int" minOccurs="1" maxOccurs="1"/> </xs:sequence> Group Multiplicity The use of multiplicity on the "ref" side of a group is not supported. maxOccurs) at the sequence or choice level the XML generated may not be valid. For example. This is because EMF does not support outputting XML where the pattern/order of elements in the group reoccurs in group order. Business Data Services Guide .BDS Limitations 165 | For example: <xsd:complexType name="compType"> <xsd:sequence> <xsd:element name="anElement" type="xsd:string" fixed="A fixed value"/> </xsd:sequence> </xsd:complexType> Multiplicity at the Sequence or Choice Level If you have multiplicity (e.g. Nested xsd:any in Sequences EMF is unable to handle nested sequences where there is an xsd:any or xsd:anyattribute in each sequence. and will result in a validation error.

it is not possible to set another class in the BOM to it.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.org/2001/XMLSchema" xmlns="http://example. For example: <?xml version="1. This is because the BOM class will already have a namespace associated with it.org/2001/XMLSchema" xmlns="http://example.com/nsLocalAny" targetNamespace="http://example. where the namespace is set to ##local. EMF will not strip the namespace automatically.com/nsLocalAny"> <xs:element name="TrainSpotter" type="ResearchType"/> <xs:complexType name="ResearchType"> <xs:sequence> <xs:element name="details" type="xs:string"/> </xs:sequence> </xs:complexType> <xs:element name="train"> <xs:complexType> <xs:sequence> <xs:element name="line" type="xs:string"/> <xs:element name="company" type="xs:string"/> <xs:any namespace="##local" processContents="lax" minOccurs="0" maxOccurs="5"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema> Business Data Services Guide .0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.com/NestedAny" targetNamespace="http://example. of which contain an xsd:any: <?xml version="1.166 | Appendix A Supplemental Information For example.com/NestedAny"> <xs:element name="train" type="TrainType"/> <xs:complexType name="TrainType"> <xs:sequence> <xs:element name="line" type="xs:string"/> <xs:element name="company" type="xs:string"/> <xs:any processContents="lax" minOccurs="1" maxOccurs="1"/> <xs:sequence> <xs:any processContents="skip" minOccurs="1" maxOccurs="1"/> </xs:sequence> </xs:sequence> </xs:complexType> </xs:schema> xsd:any "##local" When there is an xsd:any. in the following schema. there is a sequence within another sequence.w3.w3.

com/ComplexRestriction" targetNamespace="http://example.org/2001/XMLSchema" xmlns="http://example. For example. Business Data Services Guide .BDS Limitations 167 | Restrictions between Complex Types A Complex Type cannot be a restriction of another Complex Type. EMF restrictions prevent this. the following schema is not supported: <?xml version="1.w3.com/ComplexRestriction"> <!-.base type --> <xs:complexType name="BaseInfo"> <xs:sequence> <xs:element name="numPosts" type="xs:integer" minOccurs="0" maxOccurs="1"/> </xs:sequence> <xs:attribute name="firstSubscribed" type="xs:date" use="optional"/> <xs:attribute name="mailReader" type="xs:string"/> </xs:complexType> <!-.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.derived type --> <xs:complexType name="RestrictedOne"> <xs:complexContent> <xs:restriction base="BaseInfo"> <xs:sequence> <xs:element name="numPosts" type="xs:integer" minOccurs="1"/> </xs:sequence> <xs:attribute name="firstSubscribed" type="xs:date" use="required"/> <xs:attribute name="mailReader" type="xs:string" fixed="Microsoft Outlook"/> </xs:restriction> </xs:complexContent> </xs:complexType> <xs:complexType name="NoBaseRestricted"> <xs:sequence> <xs:element name="numPosts" type="xs:integer" minOccurs="1"/> </xs:sequence> <xs:attribute name="firstSubscribed" type="xs:date" use="required"/> <xs:attribute name="mailReader" type="xs:string" fixed="Microsoft Outlook"/> </xs:complexType> </xs:schema> Attempting to import this schema results in the following error: XML Schema contains an unsupported Complex Type restriction of another Complex Type.

com/RecurringElements" targetNamespace="http://example. They will be allowed to import and run as if the block does not exist. For example.org/2001/XMLSchema" xmlns="http://example.com/RecurringElements"> <xs:element name="BoatElement" type="Boat"/> <xs:complexType name="Boat"> <xs:sequence> <xs:element name="power" type="xs:string" minOccurs="3" maxOccurs="3"/> <xs:element name="hulltype" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="power" type="xs:string" minOccurs="3" maxOccurs="3"/> </xs:sequence> </xs:complexType> </xs:schema> Attempting to import the above schema into TIBCO Business Studio will fail with the following message: XML Schema contains unsupported duplicate element names inside the same complex type. For example. see the following schema fragment: Business Data Services Guide . The "block" Function EMF will not enforce a block if used on either Complex Types or Elements.168 | Appendix A Supplemental Information Recurring Elements in Sequence Having an ordered sequence with multiple instances of the same element name is not supported in XML schemas due to an EMF restriction. the following schema would not be supported: <xs:schema xmlns:xs="http://www.w3.

BDS Limitations 169 | <xsd:complexType name="coreIdentifier" block="#all"> <xsd:sequence> <xsd:element name="surname" type="xsd:string"/> </xsd:sequence> </xsd:complexType> <xsd:complexType name="enhancedIdentifier"> <xsd:complexContent> <xsd:extension base="ns1:coreIdentifier"> <xsd:sequence> <xsd:element name="firstname" type="xsd:string"/> </xsd:sequence> </xsd:extension> </xsd:complexContent> </xsd:complexType> <xsd:complexType name="Household"> <xsd:sequence> <xsd:element name="family" type="ns1:coreIdentifier"/> </xsd:sequence> </xsd:complexType> <xsd:element name="myBaseInfo" type="ns1:coreIdentifier"/> <xsd:element name="myFullInfo" type="ns1:enhancedIdentifier"/> <xsd:element name="myHousehold" type="ns1:Household"/> Business Data Services Guide .

decimalFloat).textAttribute). Table 17: Converting Values Between Different BOM Attribute Types To Type Boolean From Type Text Example bomField.integerFixed.0 == bomField.createBoolean( bomField.createBigDecimal(1)) == 0).170 | Appendix A Supplemental Information Data Mapping These tables show data mappings within the BOM.4) evaluates to false due to rounding errors Comments Parameter to createBoolean() should be true or false Boolean Decimal Fixed bomField.booleanAttribute = (bomField. Boolean Integer-Fixed bomField. (14/10==1. Boolean Decimal Signed bomField. Converting Values Between Different BOM Attribute Types This section shows how to convert between fields of different types.decimalFixed.createBigInteger(1)). e. for example.equals( ScriptUtil.booleanAttribute = (1 == bomField.integerSigned).booleanAttribute = bomField. Testing for equality may not give expected result due to floating point inaccuracies. Business Data Services Guide . Boolean Integer-Signed bomField.booleanAttribute = (1.booleanAttribute = ScriptUtil.compa reTo( ScriptUtil.g. how to convert between a text field containing the String 123 and an integer field containing the number 123.

intSigned.text = bomField.text = bomField.text = bomField. bomField. Datetime. bomField. Text Text Duration ID. bomField.Data Mapping 171 | Table 17: Converting Values Between Different BOM Attribute Types To Type Boolean From Type Date.text = bomField.uri. Same value yyyy-mm-dd hh:mm:ss yyyy-mm-ddThh:mm:ss yyyy-mm-ddThh:mm:ssZ Results in true or false value being assigned. Example N/A Comments N/A Business Data Services Guide .text = bomField.text = bomField.text = bomField. Datetimetz bomField.datetimetz.text = bomField.bool. bomField.time.text = bomField. bomField.integerFixed. P12DT3H for 12 days and 3 hours. URI. bomField. ID.text = bomField. Time.text = bomField. bomField.duration.date.decimalFixed.text = bomField.id. Attachment Text Text Text Text Text Text Boolean Integer-Signed Integer-Fixed Decimal Float Decimal Fixed Date. Attachment N/A N/A For example. bomField. bomField. bomField. Datetime.decimal. URI bomField. Datetimetz Duration.datetime. Object. Text Object. Time.

ID. Datetime. Rounds towards 0 Using ScriptUtil Factory Using ScriptUtil Factory N/A N/A Goes by a String Goes by a String Can result in loss of precision Rounds toward 0 Comments parseInt() stops at first non-number character.createBigInteger( bomField.toS tring()). Attachment Integer Fixed Text bomField.createBigInteger( bomField.intFixed. Integer Fixed Integer-Signed bomField.toS tring()). intSigned = bomField. Datetimetz. Decimal Float bomField. URI.10).text).decFloat).intSigned). intSigned = parseInt(bomField. Integer Signed Integer Signed Integer Signed Business Data Services Guide .text).172 | Appendix A Supplemental Information Table 17: Converting Values Between Different BOM Attribute Types To Type Integer Signed From Type Text Example bomField. intSigned = parseInt(bomField. Date. Boolean.intFixed = ScriptUtil. Integer Signed Integer-Fixed bomField.intSigned = parseInt(bomField. bomField.intFixed = ScriptUtil. intSigned = parseInt(bomField.decFloat. Object.intFixed = ScriptUtil. Copes with base.text. Decimal Fixed bomField. Duration.createBigInteger( bomField.intFixed. Integer Fixed Decimal Float bomField. Time.

decFloat =parseFloat(bomField. N/A NaN if starts with non-digit. Time.intSigned). Using ScriptUtil Factory Business Data Services Guide . Object.createBigDecimal( bomField.decFloat =parseFloat(bomField.decFixed .decFixed = ScriptUtil. Using ScriptUtil Factory Decimal Fixed Integer-Signed bomField.decFixed = ScriptUtil. Datetimetz. for example.createBigDecimal( bomField. Object. First converts value to a String and then to a Floating Point. Datetime.toString()). N/A Integer-Fixed Floating Point Decimal Fixed Floating Point Boolean . bomField. Datetimetz. Attachment Decimal Fixed Text bomField. URI. Integer Fixed Boolean.decFloat = parseFloat( bomField.createBigInteger( bomField. 45z  45. Possible loss of precision. Duration. Datetime. First converts value to a String and then to a Floating Point. Date. Attachment Text N/A N/A Comments Rounds towards 0 Floating Point Floating Point bomField.text). toString()).text).intFixed. Possible loss of precision. ID. bomField. ID. Or ignores after non-digit. URI.intFixed = ScriptUtil.Data Mapping 173 | Table 17: Converting Values Between Different BOM Attribute Types To Type Integer Fixed From Type Decimal Fixed Example bomField.decFixed). Date. Time. Duration.

bomField. Datetimetz. Datetimetz bomField.text).createDate( bomField. bomField.decFloat). ID.createDatetimetz( bomField. Decimal Fixed Integer Fixed bomField. Attachment Text N/A N/A Using ScriptUtil Factory Comments Using ScriptUtil Factory Date. URI. Date.createDate( bomField.date = DateTimeUtil.g. Datetimetz Integer.text).intDay).decFixed = ScriptUtil. bomField.intYear.date = DateTimeUtil.time = DateTimeUtil. Decimal Float e.text). Duration. Object.text). bomField.text).createDatetime( bomField. Time.datetime = DateTimeUtil. Datetime.datetimetz = DateTimeUtil. See DateTimeUtil for more factory methods Business Data Services Guide . Decimal Fixed Boolean . Datetime. Datetime. bomField. Time.174 | Appendix A Supplemental Information Table 17: Converting Values Between Different BOM Attribute Types To Type Decimal Fixed From Type Decimal Float Example bomField. Time. bomField.decFixed = ScriptUtil.intMonth.createTime( bomField.createBigDecimal( bomField.createBigDecimal( bomField. Date.

Datetimetz From Type Date.text. ID. URI.uri = bomField.text. Datetimetz Date.time).duration = DateTimeUtil. Time. ID. Time. Fixed Integer.createDuration( bomField. Fixed Decimal. Fixed Integer.Data Mapping 175 | Table 17: Converting Values Between Different BOM Attribute Types To Type Date. URI Object All other types All Business Objects All Types N/A N/A N/A Can only be assigned an Object attribute or a Business Object N/A Specify duration in milliseconds using any of the 4 numeric sub-types N/A Example bomField. N/A bomField.id = bomField. Decimal Float.createDatetime( bomField. bomField. Duration.datetime = DateTimeUtil. Decimal Fixed All other types Text bomField. Object. Datetime. Attachment Duration Text bomField.createDuration( bomField. bomField. Duration Signed Integer.text).date. time. Datetimetz Boolean. Datetime. N/A N/A Comments See DateTimeUtil for more factory methods Duration ID. URI Attachment N/A Business Data Services Guide . Datetime.integerOrDecimal).duration = DateTimeUtil.

Business Data Services Guide .176 | Appendix A Supplemental Information Mapping to or from Process Basic Types There are 8 different Process Basic Types that Business Object Attributes can be assigned to or from. If it doesn’t. so all values that this can take will fit in a BOM Attribute Integer (which is a 32-bit Integer). Others are slightly different. Some of these types have equivalent BDS Attribute types. The Basic Datetime type can be assigned to a BOM Datetimetz Attribute. No problems mapping data No problems mapping data No problems mapping data No problems mapping data. No problems mapping data Boolean Date Time Datetime Boolean Date Time Datetime Performer Text The Process Basic Types can be mapped to BOM Attributes of different types if the guidelines in the previous section are followed. provided that it contains a timezone. as shown below. an exception will be raised. Table 18: Mapping to or From Process Basic Types Process Basic Type Text Decimal Integer Equivalent BOM Attribute Type Text Decimal (Floating Point sub-type) Integer (Signed Integer sub-type) Comments No problems mapping data No problems mapping data The range of values supported by the Process Basic Integer is constrained to 9 digits.

New Operator The new operator from JavaScript is not supported. break } Instead. try/catch Statement The try/catch statement is not supported: try { BLOCK. Switch Statement The switch statement from JavaScript is not supported: switch (value) { case constant: BLOCK. } Finally { BLOCK. Business Data Services Guide . break. … default: BLOCK.JavaScript Features not Supported in TIBCO BPM Scripting 177 | JavaScript Features not Supported in TIBCO BPM Scripting Certain JavaScript features are not supported. } The only way to catch an exception in a script is to catch the error on ScriptTask or another task. } catch (error) { BLOCK. the factory methods must be used to create new instances of classes. Instead. an if () {} else if () {} … statement should be used.

Code must be written out in full. JavaScript Arrays Using [ ] for array indices is not supported. For example. the following loop is not supported: for (FIELD in ARRAYFIELD) { BLOCK.178 | Appendix A Supplemental Information JavaScript Functions JavaScript functions are not supported. as there is no way to create JavaScript arrays in TIBCO BPM. the Text field replace() method only supports string substitution. Consequently. not the substitution of a pattern matched by a regular expression. "==="operator The === operator (same value and type) is not supported. JavaScript RegExp Object The JavaScript RegExp object is not supported. Instead. } Business Data Services Guide . the List type is used.

For.Using If. and While Expressions The curly braces are required in TIBCO Business Studio scripts for if. and for expressions. while. and While Expressions 179 | Using If. Business Data Services Guide . For.

Business Data Services Guide . Other reserved words cannot be used in the case shown. Cannot be used. regardless of case. but WHILE is acceptable).180 | Appendix A Supplemental Information Reserved Words in Scripts Array RegExp boolean class do false goto int package static throw upper Boolean String break const double final if interface private strictfp throws var Date abstract byte continue else finally implements long protected super transient void Math assert case debugger enum float import native public switch true volatile Number bdsId1 catch default export for in new return synchronized try while Object bdsVersion1 char delete extends function instanceof null short this typeof with 1. but can be used by changing the case (for example. while is prohibited.

Topics • • • • Static Factory Methods. This appendix describes the additional functions that are supported to help with BDS scripting.| 181 Appendix B Business Data Scripting TIBCO Business Studio used with TIBCO BPM enables you to write scripts for various purposes. page 206 Business Data Services Guide . page 191 Other Supported Methods. Standard JavaScript is supported. page 204 Other JavaScript Functions. page 182 BOM Native Type Methods.

Date and Time. month. should also be within normal ranges. createDate() This creates a Date object set to today’s date. 2009-11-30T23:50:00-05:00 becomes 2009-12-01. it strips timezone. and String Functions DateTimeUtil These methods are used to create date and time objects of the types used in BPM. int day) createDate(Text isoFormatDate) This is a native type used in BPM for storing dates in YYYY-MM-DD format only. createDate(Datetime datetime) This ignores any timezone offset. such as year. For example: 2009-11-30T23:50:00-05:00 becomes 2009-11-30.182 | Appendix B Business Data Scripting Static Factory Methods This section describes the following classes of factory methods: • • • DateTimeUtil ScriptUtil IpeScriptUtil (and ScriptUtil) Conversion. This ignores any timezone offset. Parameters. should be in the range 0-59. normalizes to Zulu time. Business Data Services Guide . int month. Type Name Date Factory Method createDate(int year. Other parameters. For example. Boolean normalize) This is a Boolean that. If set to False. createDate(Datetimetz datetime. hours. as shown in the following tables. if set to True. such as seconds and minutes. day. The same example date becomes 2009-11-30. and seconds.

int day. Time time) No timezone offset set. int minute. int day. normalizes to Zulu time. Boolean normalize) This is a Boolean that. int millisecond) createTime(Text isoFormatTime) This ignores any timezone offset. Datetime createDatetime(BigInteger) year. if set to True. int minute. Business Data Services Guide . The Timezone offset is to be set only if specified in the string. createTime(Datetimetz datetimetz. BigDecimal fractionalSecond) createDatetime(int year. createTime() This creates a Time object set to the current time. int month.Static Factory Methods 183 | Type Name Time Factory Method createTime(int hour. createTime(Datetime datetime) This ignores any timezone offset. int second. int minute. int second. createDatetime(Datetimetz datetime. int hour. If it is set to False. it strips timezone as with Date previously mentioned. int minute. createDateTime() This creates a Datetime object set to the current date and time. int month. normalizes to Zulu time. int second. int hour. createDatetime(Date date. BigDecimal fractionalSecond) createTime(int hour. it strips timezone. If it is set to False. as with Date above. if set to True. int millisecond) createDatetime(String lexicalRepresentation) This creates a new Datetime by parsing the String as a lexical representation. Boolean normalize) This is a Boolean that. int second.

int second. BigInteger days.GregorianCalendar instance would need to convert to an XMLGregorianCalendar instance. int day. createDatetimetz(Datetime datetime. BigInteger years. years. Integer offset_minutes) createDatetimetz(String lexicalRepresentation) This creates a new Datetimetz by parsing the String as a lexical representation. int minute. createDuration(String lexicalRepresentation) This obtains a new instance of a Duration specifying the Duration as its string representation PnYnMnDTnHnMnS. seconds. BigInteger hours. months. int timezone_offset) This is a constructor allowing for complete value spaces allowed by W3C XML Schema 1. int years. years. int month.0 recommendation for xsd:dateTime and related built-in datatypes. days. hours. int second. createDuration(boolean isPositive. int timezone_offset) This is a constructor of value spaces that a java. int hour. int days. int hours. int seconds) This obtains a new instance of a Duration specifying the Duration as isPositive. Business Data Services Guide . days. int minutes. and defaults to zulu time if not specified. months. int minute. minutes and seconds. createDatetimetz(int year. int month.184 | Appendix B Business Data Scripting Type Name Datetimetz Factory Method createDatetimetz(BigInteger) year. createDuration(long durationInMilliSeconds) This obtains a new instance of a Duration specifying the Duration as milliseconds. minutes. createDateTimetz() This creates a Datetimetz object set to the current date and time. It takes the timezone offset from string. BigDecimal seconds) This obtains a new instance of a Duration specifying the Duration as isPositive. BigInteger months. int hour. int millisecond.util. BigDecimal fractionalSecond. Integer offset_minutes) createDatetimetz(Date date. BigInteger minutes. int day. hours. Time time. int months. Duration createDuration(boolean isPositive.

createBigDecimal (Text) createBigDecimal (BigInteger) MathContext createMathContext(Integer setPrecision) createMathContext(Integer setPrecision. HALF_UP. See Other Supported Methods on page 204 for more details on this format.com/j2se/1. and nearest to use). UP. and String Functions on page 186. the size of the mantissa).Static Factory Methods 185 | ScriptUtil The following methods are used to create objects of the following types used in TIBCO BPM. for more information. Return Type BigInteger Function createBigInteger(Integer) createBigInteger(Text) createBigInteger(BigDecimal) Comments BigDecimal createBigDecimal(Integer) createBigDecimal(Decimal) This uses an implicit MathContext. See IpeScriptUtil (and ScriptUtil) Conversion. DOWN. MathContext is not used when creating BigDecimal objects unless otherwise stated. UNNECESSARY Boolean createBoolean(Text booleanText) The MathContext object specifies the number of digits used to store the number (that is. down. Business Data Services Guide . and also how to round numbers (of various forms.5. up. It is the scale parameter in BigDecimal methods that specifies the number of decimal places that should be maintained in the objects.html. HALF_DOWN. see http://java. RoundingMode is an enumeration with the following values: CEILING. Date and Time. RoundingMode setRoundingMode) . Some of the functions provided by the ScriptUtil factory are also supported in an IpeScriptUtil factory.DECIMAL64. For more information about MathContext. FLOOR.sun. HALF_EVEN.0/docs/api/java/math/MathContext.

in an IpeScriptUtil factory designed for assistance in migrating iProcess scripts to BPM.integerSigned = ScriptUtil. Returns the fractional second part of the duration measured in milliseconds.cr eateDate()). and String Functions The following functions are supported both in the ScriptUtil factory and.<FunctionName> IpeScriptUtil. iProcess expressions support the addition and subtraction of dates and times.<FunctionName>.time". and so on.du ration).NUM("123"). "time . Date and Time. Business Data Services Guide . Syntax and Example Conversion Functions DATESTR(Date) Field = ScriptUtil. expressed in arithmetic form "date + num". You can access these functions using either of the following: • • Return Type Text ScriptUtil. 20/08/2009.getMilliseconds(srcField. Operations of this kind in BPM should be performed by the supported add() or subtract() methods on the date and time objects.186 | Appendix B Business Data Scripting The following additional ScriptUtil functions are provided to enhance the basic interfaces provided for the XMLGregorianCalendar and Duration objects. Return Type BigDecimal Integer Function Prototype Duration getFractionalSeconds(Duration dur) getMilliseconds(Duration dur) dstField. Comments IpeScriptUtil (and ScriptUtil) Conversion.DATESTR(DateTimeUtil. Comments Converts String to Decimal. for example. Returns the fractional part of the seconds of the duration. Functions relating to the internal operations of iProcess or its environment are not supported. Converts a date field into a locale-specific string. Decimal NUM(Text) Field = ScriptUtil. for compatibility with the TIBCO iProcess™ Suite.

Integer DECIMALS) ScriptUtil. where nnn is a 3 digit decimal number in the range 000 . Integer OPCODE) ScriptUtil. Text STRCONVERT(Text TEXT. // Generate "2. Converts a time field into a locale-specific string. \r. the following conversions are applied to the text parameter . 2 Delete all leading spaces. Depending on which bits are set in the opcode parameter.STRTOUPPER("test").3. Returns an uppercase copy of the string passed in. 16 Convert to lowercase. Returns a lowercase copy of the string passed in.STRTOLOWER("TEST"). \t and \\.STR(2. since these cannot be input into a field. 4 Delete all trailing spaces. such as NEWLINE.the result is returned: 1 Delete all spaces. Comments Used for adding special characters.SPECIALCHARS("Your test results are\r\n English=80 \r\n Maths=90"). Text STR(Decimal DECIMAL. Text STRTOUPPER(TEXT) ScriptUtil. into a string.STRCONVERT("test".30" Converts from Decimal to a string with a specified number of decimal places. iProcess also supports \nnn.255.Static Factory Methods 187 | Return Type Text Syntax and Example SPECIALCHARS(Text) ScriptUtil. Text TIMESTR(TIME) Business Data Services Guide .2). for example.32). Text STRTOLOWER(TEXT) ScriptUtil. 21:23. Supports \n. 8 Reduce sequences of multiple spaces to single spaces. 32 Convert to uppercase.

createTime("12:00:00"). Integer CALCTIMECARRYOVER(Time time. Note that the offset is not restricted by the units used. Business Data Services Guide . Constructs a Date. Monday.40). The new time is from the original time. Integer dYr) ScriptUtil. 0.CALCTIMECARRYOVER( DateTimeUtil.DAYSTR(DateTimeUtil. Returns the minutes from the specified time. createDate().HOURNUM(DateTimeUtil. Returns the hour of the specified time. Returns the day of the month of the specified date.CALCTIME(DateTimeUtil. Integer dHr. for the specified date. Integer dHr. Integer dMi) newTime = ScriptUtil. Returns the day of the week as a string.12.DATE(31. createTime("12:00:00"). Adds an offset to a time. Integer mon.crea teDate("2001-10-08")).CALCDATE(DateTimeUtil. Integer dMo. The function returns an integer whose value is the number of days apart.DAYNUM(DateTimeUtil.createTime("06:24:00")). 0). Integer year) ScriptUtil. the function would return 2 (or -2 for -48hours). Integer dMi) carryDays = ScriptUtil.40).2 .MINSNUM(DateTime Util. 0.2. createTime("06:24:00")). Integer HOURNUM (Time time) ScriptUtil. Text DAYSTR (Date date) ScriptUtil. Integer MINSNUM (Time time) DateTimeUtil. Comments Adds an offset to a date. Date DATE(Integer day.cr eateDate("2001-10-08")).188 | Appendix B Business Data Scripting Return Type Date Syntax and Example CALCDATE(Date date. Date and Time Functions Time Time CALCTIME(Time time. an offset expressed as a number of days is not restricted to the number of days in a week or a month. Integer dDy. Adds an offset to a time.2009) Integer DAYNUM (Date date) ScriptUtil. so for a 48 hour offset. for example. Integer dWk. for example. 1. The time plus offset is returned by the function.

BigDecimal getFractionalSecond(Duration dur) dstField.duration). Comments Returns the month number (1-12) from the specified date.integerSigned = ScriptUtil. January. Text MONTHSTR (Date date) ScriptUtil. Integer STRLEN (Text) ScriptUtil. "junkabcdefs"). Search for substring in string. returning the string length. Time TIME (Integer hours. String Functions Returns the year from the specified date.24).SEARCH("abc". Text SUBSTR ScriptUtil.STRLEN("abcdef"). Integer minutes) ScriptUtil. Returns the month name from the specified date. The indices are 1-based.createDate("2001-10-08")). Integer SEARCH ScriptUtil.c reateDate("2001-10-08")). Business Data Services Guide .TIME(6.RSEARCH("abc".0).createDate("2001-10-08")).WEEKNUM(DateTimeUtil.YEARNUM(DateTimeUtil. 3).MONTHSTR(DateTimeUtil . Constructs a time. Count the number of characters in a string. The indices are 1-based.Static Factory Methods 189 | Return Type Integer Syntax and Example MONTHNUM (Date date) ScriptUtil.SUBSTR("abcdefgh". 3. "junkabcdefs"). createDate("2001-10-08")).MONTHNUM(DateTimeUt il. Integer RSEARCH ScriptUtil. Returns "5". Returns "def". Returns the fractional part of the seconds of the duration (0 <= value < 1. The indices are 1-based. Returns "5". for example. Integer Integer WEEKNUM (Date date) ScriptUtil. Integer YEARNUM (Date date) ScriptUtil. Reverse search for substring in string. Returns the week number from the specified date.getFractionalSecond(srcFiel d.

List<BDSObject> copyAll(SrcBDSObjectList) destList.du ration). Comments Returns the duration measured in milliseconds BDSObject copy(BDSObject) Copies a BDS object as a BDS Object so it can be included in a second collection.190 | Appendix B Business Data Scripting Return Type Int Syntax and Example getMilliseconds(Duration dur) dstField. Note that this is for BDS objects only.getMilliseconds(srcField. since each BDS object can only be referenced from one collection. Business Data Services Guide .integerSigned = ScriptUtil.copyAll (sourceList)). Copies all the objects in the source List returning a new List that can be passed to the add All() method of another List. It is not for use with Process Array fields.addAll(ScriptUtil.

Compares this BigInteger with the specified Object. including the following: • • • • • Fixed Length Integer (BigInteger) Methods Fixed Point Decimal (BigDecimal) Methods IpeScriptUtil (and ScriptUtil) Conversion. Compares this BigInteger with the specified BigInteger. Returns the minimum of this BigInteger and val. Returns a BigInteger whose value is the greatest common divisor of abs(this) and abs(val). Returns a BigInteger whose value is (this divided by val). Type BigInteger BigInteger int int BigInteger boolean BigInteger BigInteger BigInteger Method abs() add(BigInteger val) compareTo(BigInteger val) compareTo(Object o) divide(BigInteger val) equals(Object x) gcd(BigInteger val) max(BigInteger val) min(BigInteger val) Notes Returns a BigInteger whose value is the absolute value of this BigInteger. Compares this BigInteger with the specified Object for equality. Returns a BigInteger whose value is (this plus val). and String Functions Duration Methods Text (String) Methods Fixed Length Integer (BigInteger) Methods The following methods using the BigInteger numeric format are supported in TIBCO BPM.BOM Native Type Methods 191 | BOM Native Type Methods This section describes supported methods using different BOM native types. Business Data Services Guide . Date and Time. Returns the maximum of this BigInteger and val.

BigDecimal supports three standard levels of precision: • static MathContext DECIMAL32: A MathContext object with a precision setting matching the IEEE 754R Decimal32 format. The type of rounding to be used by a BigDecimal operation can be specified when creating a MathContext. Possible values are: • CEILING Business Data Services Guide . Returns a BigInteger whose value is (thisexponent). 34 digits. Fixed Point Decimal (BigDecimal) Methods Some numeric objects in BPM are expressed in BigDecimal format. it is necessary to specify what precision to use in certain circumstances. Returns a BigInteger whose value is (this minus val). and the IEEE 754R default (which is equivalent to "float" arithmetic). static MathContext DECIMAL64: A MathContext object with a precision setting matching the IEEE 754R Decimal64 format. Returns a BigInteger whose value is (this times val). and the IEEE 754R default. BigDecimal format can cope with arbitrarily large numbers. • • In addition. Returns a BigInteger whose value is (this % val). Returns a BigInteger whose value is (minus this). seven digits. static MathContext DECIMAL128: A MathContext object with a precision setting matching the IEEE 754R Decimal128 format. a rounding mode of HALF_EVEN. 16 digits. a rounding mode of HALF_EVEN. tax calculations).192 | Appendix B Type BigInteger BigInteger BigInteger BigInteger BigInteger BigInteger Business Data Scripting Method mod(BIgInteger m) multiply(BigInteger val) negate() pow(int exponent) remainder(BigInteger val) subtract(BigInteger val) Notes Returns a BigInteger whose value is (this mod m). and the IEEE 754R default (which is equivalent to "double" arithmetic). However. when using the BigDecimal type. a rounding mode of HALF_EVEN. calculating one-third would produce an exception if precision is not specified. or passed directly to the relevant methods of BigDecimal. For example. the rounding rules can be specified when a particular method of rounding is required for a particular type of calculation (for example.

BigDecimal add(BigDecimal augend) BigDecimal add(BigDecimal augend. augend). int BigDecimal Compares this BigDecimal with the specified BigDecimal.BOM Native Type Methods 193 | • • • • • • • FLOOR UP DOWN HALF_UP HALF_DOWN HALF_EVEN UNNECESSARY The following table lists the methods available for BigDecimal objects. If the exact quotient cannot be represented (because it has a non-terminating decimal expansion). MathContext mc) Returns a BigDecimal whose value is (this and whose scale is as specified.divisor. / BigDecimal divisor). Business Data Services Guide . RoundingMode roundingMode) divide(BigDecimal divisor.scale(). Returns a BigDecimal whose value is (this + and whose scale is max(this. divisor).scale().scale() . augend. BigDecimal divide(BigDecimal divisor. divisor). int scale. an ArithmeticException is thrown. Returns a BigDecimal whose value is (this / with rounding according to the context settings. Returns a BigDecimal whose value is (this / and whose preferred scale is (this. and whose scale is this.scale()). Type BigDecimal Method abs() Notes Returns a BigDecimal whose value is the absolute value of this BigDecimal. MathContext mc) compareTo(BigDecimal val) divide(BigDecimal divisor) Returns a BigDecimal whose value is (this + with rounding according to the context settings.scale()). augend).

MathContext mc) precision() remainder(BigDecimal divisor) remainder(BigDecimal divisor. Returns a BigDecimal whose value is the integer part of (this / divisor). Returns the precision of this BigDecimal. BigDecimal Business Data Services Guide .scale()). Returns a BigDecimal whose value is (this divisor). BigDecimal BigDecimal Returns a BigDecimal whose value is (-this). % BigDecimal int BigDecimal BigDecimal pow(int n. multiplicand). MathContext mc) round(MathContext mc) divisor). to unlimited precision. BigDecimal Returns a BigDecimal whose value is (this × with rounding according to the context settings. Returns a BigDecimal whose value is (this multiplicand). and whose scale is this.194 | Appendix B Type Business Data Scripting Method divide(BigDecimal divisor.scale() + multiplicand. Returns a BigDecimal whose value is (this % with rounding according to the context settings. MathContext mc) negate() pow(int n) Notes divisor).scale(). Returns the maximum of this BigDecimal and val. Returns a BigDecimal whose value is (thisn). Returns a BigDecimal whose value is (thisn). Returns the minimum of this BigDecimal and val. BigDecimal Returns a BigDecimal whose value is the integer part of the quotient (this / divisor) rounded down. BigDecimal Returns a BigDecimal whose value is (this / and whose scale is this. MathContext mc) max(BigDecimal val) min(BigDecimal val) multiply(BigDecimal multiplicand) multiply(BigDecimal multiplicand.scale(). The power is computed exactly. and whose scale is × BigDecimal BigDecimal BigDecimal BigDecimal (this. Returns a BigDecimal rounded according to the MathContext settings. RoundingMode roundingMode) divideToIntegralValue(BigD ecimal divisor) divideToIntegralValue(BigD ecimal divisor.

Returns a string representation of this BigDecimal. subtrahend). Returns the string representation of this BigDecimal. using scientific notation if an exponent is needed. Returns a BigDecimal that is numerically equal to this one. String String String toPlainString() toString() BigDecimal ulp() Business Data Services Guide . subtrahend. Returns the size of an ulp (a unit in the last place) of this BigDecimal. and whose value is numerically equal to this BigDecimal's. and whose unscaled value is determined by multiplying or dividing this BigDecimal's unscaled value by the appropriate power of ten to maintain its overall value. Returns a BigDecimal whose scale is the specified value. BigDecimal setScale(int newScale. Returns a BigDecimal whose value is (this and whose scale is max(this.BOM Native Type Methods 195 | Type int BigDecimal BigDecimal Method scale() scaleByPowerOfTen(int n) setScale(int newScale) Notes Returns the scale of this BigDecimal. Returns a BigDecimal whose numerical value is equal to (this * 10n). Returns the signum function of this BigDecimal. using engineering notation if an exponent is needed.scale(). Returns a string representation of this BigDecimal without an exponent field. but with any trailing zeros removed from the representation. RoundingMode roundingMode) int BigDecimal signum() stripTrailingZeros() BigDecimal subtract(BigDecimal subtrahend) subtract(BigDecimal subtrahend. Returns a BigDecimal whose scale is the specified value. MathContext mc) toEngineeringString() BigDecimal Returns a BigDecimal whose value is (this subtrahend).scale()). with rounding according to the context settings.

196 | Appendix B Type BigInteger Business Data Scripting Method unscaledValue() Notes Returns a BigInteger whose value is the unscaled value of this BigDecimal. Business Data Services Guide .

FIE LD_UNDEFINED. Datetime and Datetimetz (XMLGregorianCalendar) Methods Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method void add(Duration duration) Add duration to this instance. Y Y Y Y Y Y Y Y Y int getDay() Return day in month or DatatypeConstants. getHour() Return hours or DatatypeConstants.BOM Native Type Methods 197 | Date. Y n/a Y Y Y n/a Y Y n/a BigDecima l int getFractionalSecond() Return fractional seconds. n/a Y Y Y n/a n/a n/a n/a n/a n/a Y Y Y n/a n/a n/a n/a n/a Business Data Services Guide . Y Y Y Y Y Y Y Y Y void clear() Unset all fields to undefined. Time. Y Y Y Y Y Y Y Y Y int compare(XMLGregorian Calendar xmlGregorianCalendar) Compare two instances of XMLGregorianCalendar Y Y Y Y n/a n/a n/a n/a n/a boolean equals(Object obj) Indicates whether parameter obj is equal to this one.FIELD _UNDEFINED.

n/a Y Y Y n/a n/a n/a n/a n/a int getTimezone() Return timezone offset in minutes or DatatypeConstants.FIE LD_UNDEFINED. n/a n/a Y Y n/a n/a n/a n/a n/a Business Data Services Guide . Y n/a Y Y n/a Y Y n/a Y int getSecond() Return seconds or DatatypeConstants.198 | Appendix B Business Data Scripting Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method int getMillisecond() Return millisecond precision of getFractionalSecond() n/a Y Y Y n/a n/a n/a n/a n/a int getMinute() Return minutes or DatatypeConstants.FIE LD_UNDEFINED.FIE LD_UNDEFINED.FIE LD_UNDEFINED if this optional field is not defined. n/a Y Y Y n/a n/a n/a n/a n/a int getMonth() Return number of month or DatatypeConstants.

Y n/a Y Y n/a n/a n/a Y Y void setDay(int day) Set days in month. n/a Y Y Y n/a n/a n/a n/a n/a Business Data Services Guide . Y n/a Y Y Y n/a Y n/a n/a void setFractionalSecond(Big Decimal fractional) Set fractional seconds. Y n/a Y Y n/a Y Y n/a Y void setSecond(int second) Set seconds. n/a Y Y Y n/a n/a n/a n/a n/a void setMillisecond(int millisecond) Set milliseconds.0 dateTime datatype field for year or DatatypeConstants. n/a Y Y Y n/a n/a n/a n/a n/a void setMinute(int minute) Set minutes.BOM Native Type Methods 199 | Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method int getYear() Return low order component for XML Schema 1.FIELD _UNDEFINED. n/a Y Y Y n/a n/a n/a n/a n/a void setMonth(int month) Set month. n/a Y Y Y n/a n/a n/a n/a n/a void setHour(int hour) Set hours.

In this case it is best to use two separate calls to set the hour. n/a Y Y Y n/a n/a n/a n/a n/a void setTime(int hour. int minute. BigDecimal fractional) Set time as one unit. second. int second) setMillisecond(int millisecond) Business Data Services Guide . int second. n/a Y Y Y n/a n/a n/a n/a n/a void setTime(int hour. int second) Set time as one unit. int millisecond) Set time as one unit. int minute. n/a Y Y Y n/a n/a n/a n/a n/a This method should not be used in scripts where the time field has been set before the script.200 | Appendix B Business Data Scripting Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method void setTime(int hour. including optional milliseconds. including the optional infinite precision fractional seconds. int minute. minute. and millisecond fields as: setTime(int hour. int second. int minute.

In this case it is best to use setYear(BigInteger year) instead. n/a n/a Y Y n/a n/a n/a n/a n/a void setYear(BigInteger year) Set low and high order component of XSD dateTime year field. Y n/a Y Y n/a n/a n/a Y Y void setYear(int year) Set year of XSD dateTime year field. Y Y Y Y Y Y Y Y Y Business Data Services Guide .BOM Native Type Methods 201 | Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method void setTimezone(int offset) Set the number of minutes in the timezone offset. Y n/a Y Y n/a n/a n/a Y Y This method should not be used in scripts where the date field has been set before the script. String toXMLFormat() Return the lexical representation of this instance.

boolean isShorterThan(Duration duration) Checks if this duration object is strictly shorter than another Duration object. int getMinutes() Obtains the value of the MINUTES field as an integer value. this+rhs. or 0 if not present. or 0 if not present. or 0 if not present. boolean isLongerThan(Duration duration) Checks if this duration object is strictly longer than another Duration object. boolean equals(Object duration) Checks if this duration object has the same duration as another Duration object. or 0 if not present. or 0 if not present. int getDays() Obtains the value of the DAYS field as an integer value.202 | Appendix B Business Data Scripting Duration Methods Type Duration Method add(Duration rhs) Computes a new duration whose value is int compare(Duration duration) Partial order relation comparison with this Duration instance. int getSeconds() Obtains the value of the SECONDS field as an integer value. int getHours() Obtains the value of the HOURS field as an integer value. Duration multiply(BigDecimal factor) Computes a new duration whose value is factor times longer than the value of this duration. int getYears() Get the years value of this Duration as an int or 0 if not present. int getMonths() Obtains the value of the MONTHS field as an integer value. Business Data Services Guide .

Methods charAt(index) indexOf(str[.fromIndex]) replace() Returns the character at the specified zero-based index.BOM Native Type Methods 203 | Type Duration Method multiply(int factor) Computes a new duration whose value is factor times longer than the value of this duration. and through the specified number of characters. Converts a string to lowercase letters. Extracts a part of a string and returns a new string. Searches for a match between a substring (or regular expression) and a string. Duration subtract(Duration rhs) Computes a new duration whose value is this-rhs. Returns the position of the first found occurrence of a specified value in a string. Converts a string to uppercase letters. beginning at a specified start position.fromIndex]) lastIndexOf(str[. Extracts the characters from a string. between two specified indices. Returns the position of the last found occurrence of a specified value in a string. and replaces the matched substring with a new substring. Extracts the characters from a string. Method Description Properties length Returns the length of a string. slice() substr() substring() toLowerCase() toUpperCase() Business Data Services Guide . Text (String) Methods The following methods are supported for use with String objects.

Returns a list iterator of the elements in this list (in proper sequence). page 205 List Methods The following List methods are supported for use in manipulating a range of values. Replaces the element at the specified position in this list with the specified element. Type boolean void void boolean E boolean ListIterator<E> E boolean E int Method add(E o) add(int index. Business Data Services Guide . Returns the number of elements in this list.204 | Appendix B Business Data Scripting Other Supported Methods The methods described in the following sections are supported for the types of object listed. Removes all of the elements from this list. Returns true if this list contains no elements. Inserts the specified element at the specified position in this list. Returns true if this list contains the specified element. This section includes: • • List Methods. E element) clear() contains(Object o) get(int index) isEmpty() listIterator() remove(int index) remove(Object o) set(int index. Methods not described are not supported. Returns the element at the specified position in this list. E element) size() Notes Appends the specified element to the end of this list. Removes the first occurrence in this list of the specified element. page 204 ListIterator Methods. Removes the element at the specified position in this list.

Returns the next element in the list. and toIndex. Returns the index of the element that would be returned by a subsequent call to next. exclusive.Other Supported Methods 205 | Type List Method subList(int fromIndex. Business Data Services Guide . Returns the previous element in the list. int toIndex) addAll(Collection c) Notes Returns a view of the portion of this list between the specified fromIndex. inclusive. Appends all of the elements in the specified collection to the end of this list. Returns true if this list iterator has more elements when traversing the list in the reverse direction. Returns true if this list iterator has more elements when traversing the list in the forward direction. boolean ListIterator Methods The following ListIterator methods are supported. Removes from the list the last element that was returned by next or previous. Replaces the last element returned by next or previous with the specified element. in the order that they are returned by the specified collection's iterator (optional operation). Returns the index of the element that would be returned by a subsequent call to previous. Type void boolean boolean E int E int void void Method add(E o) hasNext() hasPrevious() next() nextIndex() previous() previousIndex() remove() set(E o) Notes Inserts the specified element into the list.

Returns the value of x to the power of y. . Returns x.y. as a numeric value between -Pi/2 and +Pi/2 radians. in radians.718).206 | Appendix B Business Data Scripting Other JavaScript Functions Some other JavaScript methods are supported for Math objects. Returns the natural logarithm of 2 (approximately 0. Returns the natural logarithm of 10 (approximately 2. Returns the arcsine of x.693). Returns the number with the highest value. Method Description Properties E LN2 LN10 PI Returns Euler’s number (approximately 2. Methods abs(x) acos(x) asin(x) atan(x) ceil(x) cos(x) exp(x) floor(x) log(x) max(x. . Returns the arccosine of x. using 2 arguments. n) min(x. Returns the natural logarithm (base E) of x. z. . Returns the arctangent of x. n) pow(x. z. Math Methods The following methods are supported for use with Math objects.. in radians. . Returns x. Returns the value of Ex. Returns Pi (approximately 3. Returns the cosine of x (where x is in radians). ..14159).y.302).. Returns the number with the lowest value.y) Business Data Services Guide Returns the absolute value of x. using 2 arguments.. rounded up to the nearest integer. rounded down to the nearest integer.

Returns the sine of x (where x is in radians). Returns the square root of x.Other JavaScript Functions 207 | Method random() round(x) sin (x) sqrt(x) tan(x) Description Returns a random number between 0 and 1. Returns the tangent of the angle x. Business Data Services Guide . Rounds x to the nearest integer.

208 | Appendix B Business Data Scripting Business Data Services Guide .

| 209 Appendix C Process Scripting TIBCO Business Studio used with TIBCO BPM enables you to write scripts for various purposes. page 210 Business Data Services Guide . This appendix describes the additional functions that are provided to help with process scripting. Topics • Process Instance Attributes and Methods.

getId(). originator = Process. getPriority(). name = Process. description = Process. ou=system Returns Process Instance ID. pvm:0a128cu Business Data Services Guide . getDescription(). id = Process. start = Process. for example. getOriginator(). uid=admin.210 | Appendix C Process Scripting Process Instance Attributes and Methods This section summarizes the attributes and methods that are available for accessing information about process instances using the Process class. priority = Process. Description Returns priority of the Process Instance Returns Process Template name Returns description of Process Returns date/time the Process Instance was started Returns priority of the Process Instance Returns originator of Process Instance. priority. getStartTime().getName(). Attribute/Method priority : Integer getName() : String getDescription() : String getStartTime() : Datetimetz getPriority() : Integer getOriginator() : String getId() : String Example priority = Process. e.g.

getActivityStart Time('UserTask2').getActivityType( 'UserTask2').state Returns time task was started Returns time task was completed Business Data Services Guide . For a non-multi-instance task. Integer) getActivityType(Strin g) : String getActivityState(Strin g) : String getActivityStartTime( String) : Datetimetz getActivityCompleti onTime(String) : Datetimetz add = Process. done.getActivityCom pletionTime('UserTask2' ). Adds additional instances to a multi-instance loop task while that task is in progress Returns task type.Process Instance Attributes and Methods 211 | Attribute/Method getActivityLoopInde x() : Integer Example index = Process. getActivityLoopIndex() Description • • • Retrieves most local loop index.addActivityLoop AdditionalInstances ("UserTask". started = Process. • • addActivityLoopAdd itionalInstances: (String . for example. this will be the loop index for the nearest multi-instance embedded sub-process ancestor (defaulting to 0 if no multi-instance ancestor found). Index starts from 0 (zero) for first loop/multi-instance instance. userTask Returns task state.1) typ = Process. completed = Process. In nested multi-instance situations. the user can transfer an embedded sub-process loop index into a embedded sub-process local data field.getActivityState( 'UserTask2'). state = Process. For a loop/multi-instance task or embedded sub-process this will be the loop index for this task/embedded sub-process. for example.

200.setPriority(). String) : List<String> setPriority() : Integer attrs = Process. Only Participant is supported as an attribute name. Description Returns task deadline time Returns value of attribute. getOriginatorName() : String name = Process. getActivityArrayAttr ibute(String.getActivityAttri bute('UserTask2'. 430 Only WorkItemId and Completer are supported as attribute names. Business Data Services Guide .212 | Appendix C Process Scripting Attribute/Method getActivityDeadline( String) : Datetimetz getActivityAttribute( String.getOriginatorNa me() Returns the process instance originator login name. workItemId = Process. Once a process instance has been created. String) : String Example deadtime = Process.getActivityArray Attribute('UserTask2'. completer = Process.getActivityAttri bute('UserTask2'. The default value is 200. Valid entries are 100. it can change its own priority.getActivityDead line('UserTask2').'Compl eter').'WorkIt emId'). Returns array of attribute values. priority = Process. for example.'Pa rticipant'). 300 and 400.

This appendix describes the additional functions that are provided to help with work item scripting.| 213 Appendix D Work Item Scripting TIBCO Business Studio used with TIBCO BPM enables you to write scripts for various purposes. page 219 Business Data Services Guide . Topics • • • WorkManagerFactory. page 214 WorkItem. page 215 OrgModel.

See below for properties & methods Comments Business Data Services Guide . Attribute / Method WorkManagerFactory getOrgModel() : OrgModel getOrgModelByVersion() : OrgModel getWorkItem() : WorkItem Returns an OrgModel object. OrgModel must have a parameter to specify which version. Returns WorkItem object.214 | Appendix D Work Item Scripting WorkManagerFactory This table lists the WorkManagerFactory attributes and methods provided. See below for methods.

WorkItem 215 | WorkItem This table lists the WorkItem attributes and methods provided. If the item was originally offered to more than one organizational entity and is now allocated. Returns the work item’s unique ID. Returns a work item resource object for the work item. Comments getWorkItemOffers() : List<EntityDetail> Business Data Services Guide . this will contain all the entities to which the item was originally offered. Attribute / Method WorkItem cancel : Boolean description : Text priority : Integer getId() : Integer getVersion() : Integer getWorkItemResource() : EntityDetail Cancels an API that exists in BRM. The specified priority of the work item. Returns a resource that has this work item. It contains all the organizational entities whose work list currently contains this work item. Returns the version number of the work item. The description of the work item.

483. See description above.483.147.647.attribute1: Integer workItemAttributes.147. attribute2 can be used to hold a customer name. on a user task schedule script).216 | Appendix D Work Item Scripting Attribute / Method getContext() : ItemContext Comments Returns the work item's context information and provides read only methods to access the following information: • • • • • • activity ID activity name application name application instance application ID application instance description getSchedule() : ItemSchedule Returns the work item's schedule information and provides read only methods to access the start date and target date.attribute3: Text workItemAttributes. Business Data Services Guide . They are available where the WorkManagerFactory object can be accessed (for example.648 to 2. workItemAttributes. These work item attributes (attribute1 and the others listed below) can be used to contain data associated with a work item and to sort and filter your work list.attribute4: Text Limited to 64 characters in length. For example. The attribute1 work item attribute can be assigned integer values in the range -2. and attribute1 a customer reference number to aid work list sort and filter choices.attribute2: Text workItemAttributes.

attribute6: DateTime workItemAttributes.attribute5: BigDecimal Comments See description above.attribute10: Text workItemAttributes.attribute14: Text ItemContext getActivityId() : Text getActivityName() : Text getAppName() : Text getAppInstance() : Text getAppId() : Text getAppInstanceDescription() : Text ItemSchedule getStartDate() : Datetime getTargetDate : Datetime Business Data Services Guide .attribute8: Text workItemAttributes. See description above.attribute9: Text workItemAttributes.anything larger will be truncated.attribute7: DateTime workItemAttributes.attribute12: Text workItemAttributes. Limited to a maximum of 20 characters . workItemAttributes. See description above. This can be assigned Decimal or BigDecimal values.attribute11: Text workItemAttributes.attribute13: Text workItemAttributes.WorkItem 217 | Attribute / Method workItemAttributes. See description above.

when there is a 0 length value. "". note that the following will be shown: • • A null object when there is a null value. Business Data Services Guide .218 | Appendix D Work Item Scripting When using getWorkItem() or getSchedule(). An empty object.

Returns the list of EntityDetails that describe the Human Resources identified by the given name. If no such named Groups exist. the return value will be null. the return value will be an empty list. If no such Human Resource exists. Returns the list of EntityDetails that describe the Groups identified by the given name. Returns the single EntityDetail that describes the Group identified by its GUID. the return value will be an empty list. the return value will be null. If no such Organizational Unit exists. If no such named Organizational Units exist. the return value will be an empty list. Returns the list of EntityDetails that describe the Organizational Units identified by the given name.OrgModel 219 | OrgModel This table lists the OrgModel attributes and methods provided. Returns the single EntityDetail that describes the Human Resource identified by its GUID. the return value will be null. If no such Group exists. Comments ouByName(name:Text) : List<EntityDetail> groupByGuid(guid:Text) : EntityDetail groupByName(name:Text) : List<EntityDetail> resourceByGuid(guid:Text) : EntityDetail resourceByName(name:Text) : List<EntityDetail> Business Data Services Guide . Attribute / Method OrgModel ouByGuid (guid:Text) : EntityDetail Returns the single EntityDetail that describes the Organizational Unit identified by its GUID. If no such named Human Resources exist.

Returns the single EntityDetail that describes the Organization identified by its GUID. the return value will be null. Example values are: • • • • • ORGANIZATION ORGANIZATIONAL_UNIT GROUP POSITION RESOURCE Business Data Services Guide . Returns the single EntityDetail that describes the Position identified by its GUID. If no such Position exists. the return value will be null. positionByGuid(guid:Text) : EntityDetail positionByName(name:Text) : List<EntityDetail> orgByGuid(guid:Text) : EntityDetail orgByName(name:Text) : List<EntityDetail> EntityDetail getEntityType() : Text Returns the type identifier for this organizational model entity. the return value will be an empty list. If no such Human Resource exists. If no such Organization exists. the return value will be null.220 | Appendix D Work Item Scripting Attribute / Method resourceByLdapDN(ldapDN:Text): List<EntityDetail> Comments Returns the single EntityDetail that describes the Human Resource identified by its Primary LDAP DN. If no such named Positions exist. Returns the list of EntityDetails that describe the Positions identified by the given name. If no such named Organizations exist. the return value will be an empty list. Returns the list of EntityDetails that describe the Organizations identified by the given name.

this identifies the type of Resource: • • • "DURABLE" "CONSUMABLE" "HUMAN" getPositions() : List<EntityDetail> getName() : Text getGuid() : Text getAlias() : Text getDn() : Text getResourceType() : Text Currently. The name of the organizational model entity. this is the Alias of the LDAP Source from which the Resource is derived. For Human Resource entities this is the Distinguishing Name (DN) of the LDAP entry from which the Resource is derived. only HUMAN Resources are supported. For Human Resource entities. this will return the EntityDetails that describe the Positions to which the Resource is associated. Business Data Services Guide . getResources() : List<EntityDetail> For non-Resource entity types (such as Positions and Groups).OrgModel 221 | Attribute / Method getGroups() : List<EntityDetail> Comments For Human Resource entities. For entities of Entity Type RESOURCE. this will return the EntityDetails that describe the Groups to which the Resource is associated. For example. this will return the Resource entities associated with that entity. The GUID that uniquely identifies the organizational model entity. For Human Resource entities. it will be all the Resources that hold that Position. for a Position.

this will return the value of the named Resource Attribute held by that Resource entity. For Resource entity types. this will return the data type of the named Resource Attribute.222 | Appendix D Work Item Scripting Attribute / Method getAttributeValue(attrName:Text) :List<Text> Comments For Resource entity types. Possible values are: • • • • • • • • • string decimal integer boolean datetime date time enum enumset getAttributeType(attrName:Text) : Text Business Data Services Guide .

This is the most general of the UML relationships. URI. Primitive Types. an Order class. BOM Object. Attribute A property of a Class. BOM See Business Object Model (BOM). Duration. may contain date and orderNumber attributes. Association Association is a relationship where all the objects have their own lifecycle and there is no parent. if there is more than one BOM that contains an OrderId class. for example. but one object is related to the other object with a “has-a” type of relationship. BDS See Business Data Services. those that are defined within a BOM. For example: is the Teacher-Student relationship. amongst others. an Order or a Customer. which are not pre-defined. The Basic Types are: • • • • • • • Text Decimal Integer Boolean Date Time Date Time • Performer Note: There is no Datetimetz. for example. and the Performer field is a special type of Text field that contains an RQL query string. This can be useful. or ID type (or an Attachment type). for example. A BOM Class is a template for a Business Object. BOM Class An entity in the BOM that represents a particular part of the application data. Department-Teacher. When choosing a type for an attribute. BOM Editor refers to the BOM Native Types as Primitive Types.| 223 Glossary A Aggregation Aggregation is a specialized form of association. have the package name of the BOM against them when selecting the Type to use. Objects in an aggregation relation have their own lifecycle. The Basic Types are also known as Process Types. for instance. for example. The type of attribute can be one of the following: • • • Primitive Type (see below) Enumerated Type (see below) Class Type (see below) B Basic Type Process Template field values can be of a Basic Type or an External Reference Type that refers to a BOM Class. Business Data Services Guide .

DayOfWeek can have the following values: SUNDAY. This is not the case for Aggregation. Time. there is a Business Object that represents and holds information about a particular customer. Each of these entities will have a number of attributes. String Integer (Signed integer and Fixed integer sub-types) Decimal (Floating Point and Fixed Point sub-types) Date. and Orderline. SATURDAY G Generalization The Generalization relationship indicates that one of the two related classes (the subtype) is considered to be a specialized form of the other (the super type). and date. Attachment * * N. name. address. For example. An example of this type of relationship is School-Classroom. Object. Business Data Services Guide . if you count the numeric sub-types) that can be used to build other Primitive Types. for example. These types of relationships are characterized by the "is-a" phrase. Business Object Model (BOM) The Model representing the structure of the application data created using the BOM editor. Do not confuse this term with Object BOM Native Type.224 | Glossary BOM Native Types There are 13 predefined primitive types (or 15. Business Object An instance of a BOM Class. For example. Datetimetz. and supertype is considered as a Generalization of the subtype. Business Data Services A Component of AMX BPM that handles all the application data needs of the AMX BPM system. all the child objects will be deleted too. for example. It can also be imported from an XSD or WSDL file. FRIDAY. Customer. the classrooms will be destroyed too. and Tree is a generalization of the more specific Oak class. These objects will also be related to each other in different relationships and with different multiplicities. An Oak is a Specialization of the more general Tree class. Duration URI. For example. for a Customer class. Order. Datetime. TUESDAY. E Enum or Enumerated Type A type that can have a restricted set of values. If the School is destroyed. C Composition Composition is a specialized form of the Aggregation relationship. or used as types of attributes of classes: • • • • • Boolean. MONDAY. WEDNESDAY. In this relationship if the parent object is deleted. Community Site A type of portal site created and used by business users in support of team communications. THURSDAY. ID.B. Oak "is-a" Tree. Attachment type is not currently supported Business Data Structured data that contains information about real-world entities that an organization deals with.

UserTask A UserTask is a step in a process that is handled by a user and requires the user to complete a form. R RQL Resource Query Language – a language for selecting which resources can have access to a UserTask in a process. Process Template The definition of what a process should do. Process Types See Basic Type. U UML Unified Modelling Language – an international standard modelling language supported by many tools. W WSDL WSDL stands for Web Service Definition Language. A user may Close a form so that they can complete it later. See Generalization. A WSDL file can be imported by TIBCO Business Studio to make it easy to call web services. the user submits the values causing the changes to the field values to be saved. defining the format of the request and responses. When these Primitive Types are defined. it is possible to define a type based on one of the BOM Native Types or another Primitive Type. Process Local Data Data that lives within a Process Instance.wsdl extension contains the definition of a Web Service. They must be of BOM Types or Basic Types. for example: composition. The object will either be a Business Object or a Basic Type. S Specialization. it is possible to add some limitations using a regular expression or a range. Identifies different types of relationships that can exist between the objects being modelled. For example: resource(name="Clint Hill") Business Data Services Guide . association. and aggregation. Data Fields of Primitive Types cannot be used in processes. Process Instance An instance of a flow through a Process Template with data values that reflect the information being processed by this particular instance of the process.Glossary 225 | P Primitive Type In a BOM. A file with a . On completing the form. generalization/specialization.

Business Data Services Guide . A file with a .xsd extension contains XML that defines the format that some other XML should take.226 | Glossary X XSD XSD stands for XML Schema Definition. This other XML is used to pass data between processes.