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

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

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

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

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

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

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

Read the release notes for the various products for lists of new and changed features. These documents also contain lists of known issues and closed issues for the release. 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. TIBCO Business Studio™ BPM Implementation Read this manual to learn how to implement business processes (including using scripts).Related Documentation xi | Related Documentation This section lists documentation resources you may find useful. Business Data Services Guide .

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

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

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

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

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

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

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

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

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

This template is called a BOM class. and defines what the different objects will be like. However. for each type of object we want to process.BOM Class 7 | BOM Class As the name implies. you can define a Customer BOM class and an Order BOM class. For example. which would model real world customers and orders. before we can have objects we must create a template. the whole focus of OO is on objects. Business Data Services Guide . 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.

or read from. Each of these BOM classes and Business Objects have attributes. It is possible in a service task to write information out to. the Customer BOM class can have two Business Objects to represent two actual customers. a database. These instances are referred to as Business Objects. 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. and an Order may have attributes that include Customer and DateCreated. This is called Process Local Scope. For example. Although Customer attributes differ from Order attributes. generally all Customers have the same set of attributes. a Customer may have attributes that include a name and number. For example. The diagram below shows a simple Customer class and three Business Objects. 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. Business Data Services Guide . The structure of the database table may match one of the normal BOM classes.8 | Chapter 2 Concepts Business Objects At runtime. John Smith and Fred Blogs. instances of these BOM classes are created to represent particular instances of the generic BOM class.

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

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

a supplier can give them a Cat or a Dog because they both satisfy the "is-a" Mammal requirement. For example. and telephone).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. and so on. For example. or they can even be given a Hamster. both classes representing a person. 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. consider the following terms: Animal. these relationships would be represented like this: In OO terms. Cat. A Mammal is-an Animal. Mammal. However. (Also. this means that a Mammal is a specialization of an Animal. A Cat is-a Mammal. A Dog is-a Mammal. and a Cat is a specialization of a Mammal. you can create a Person class that holds the common attributes of Customer and Employee (for example. you may discover that some classes have some things in common. When modeling this. A Fish is-an Animal. there might be a Customer and an Employee class. name. While building up the model of what objects a business deals with. Goldfish. Fish. and Dog. as a hamster "is-a" Mammal. providing a Goldfish does not satisfy the "is-a" Mammal requirement. Business Data Services Guide . a Cat is-an Animal and a Dog is-an Animal). In the Business Object Modeler. a Goldfish is-an Animal). email. (Also. and they specify that they want a Mammal. If someone wants a pet.

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). adding the extra attributes that only a customer has (for example. 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. Using the previous diagram as an example. manager and so on).12 | Chapter 2 Concepts The Customer class can then specialize the Person class. the Employee class can specialize the Person class. if you had a Customer business object. 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). we can say that the Customer and Employee classes are specializations of the Person class. department. 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. customerNumber). Alternatively. We can say that the Person class is a generalization of the Customer and Employee classes. as its BOM class is a subtype of the Person class. Business Data Services Guide . Having done this.

In other words. it will only work if the Person attribute is actually referring to an instance of the Customer BOM class. 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. Business Data Services Guide . For example.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). or the Employee BOM classes then it will not work. it passes the "is-a" test. as they do not satisfy the "is-a Customer" requirement.

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

dob. person1.dob = DateTimeUtil. person2. person2.age + 1.make. // Value now 1970-01-04. person2.age person1.make = "Ford" // will not affect car.dob = person1.dob.make person1.createDate("1968-01-04").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.age = person2.dob // is still 1968-01-04 Business Data Services Guide .age.age = person2.setYear(1970). bus.make = bus.// Will not increment person1.

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

createAddress(). customer. leaving Customer with no Address: var address = com_example_refval_Factory.copy(customer. // 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". account.address = customer. // Removes address from // customer If this script is modified to use ScriptUtil. the final line of the script removes the Address from Customer.address = address.address). greetingDataField = greeting.createAddress(). greetingDataField = "Goodbye". customer.address = ScriptUtil.address = address.Assignment by Value and by Reference 17 | In the next example. although all assignments are by reference (there is only ever one Address).copy(…). // Will not affect local variable // greeting Business Data Services Guide .address. account and customer end up with independent copies of the address: var address = com_example_refval_Factory. account.

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

and the types of data it supports.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. page 29 Business Data Services Guide . Topics • • • • UML Relationships Supported by Process Local Data. page 20 BOM Native Types. page 21 Creating a Business Object Model (BOM).

Although in TIBCO Business Studio BOM Editor also supports Association and Aggregation relationships. Business Data Services Guide . so an understanding of UML can be useful. these relationships cannot be used in processes. BDS and Process Local Data support Generalization and Specialization relationships and Uni-directional Composition 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).

for example. xsd:anyType. The Attachment type is not currently supported by the BPM runtime. there are 18 different types. if you include the sub-types as types. in total. these BOM Native Types can be used to generate Primitive Types that have some application-specific restrictions. 4 sub-types of Object (xsd:any. Therefore. Business Data Services Guide .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). Using Business Object Modeler.. xsd:anySimpleType and xsd:anyAttribute). a range or a regular expression that it must match.

79769E+308 and -2. false Year in range [-999.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.23 Business Data Services Guide .+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.225E-307 0 Positive values between 2.999.1234567890 Decimal – Floating Point • • • Negative numbers between -1. For example: 1234567890. For example: 1. 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.999] Month in range [1 – 12] Day in range [1 .225E-307 and 1.99.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 . Table 3: Value Spaces for BOM Native Types BOM Native Type Attachment Boolean Date Value Space N/A true.999 – 999.79769E+308.

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

org/TR/2001/REC-xlink-20010627/ For example: http://www. See World Wide Web Consortium. XML Linking Language (XLink) available at: http://www.com Business Data Services Guide .tibco.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.w3.

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. although there cannot be circular references (dependencies) between BOMs. • • Manually in the Business Object Modeler. If you intend to call the interfaces. you can explore the data structures that have been imported in the Business Objects folder. By importing existing XSD or WSDL files that contain data definitions used by existing applications. by one who knows the structure of the data that the business uses. the structure of the data can be imported into the Business Objects folder. 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. 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. There can be multiple BOMs with cross-references between them. as shown in the following figure: User-defined BOMs can be found in the Business Objects folder of the TIBCO Business Studio project. BOMs are created from the context menu in the Business Objects folder in the Project Explorer. Once the import has completed. Business Data Services Guide . import the WSDL as described in Importing WSDLs into the Service Descriptors Folder on page 26.Creating a Business Object Model (BOM) 25 | Creating a Business Object Model (BOM) There are two ways to create a BOM.

The information about the table structure can be used in tasks that interact with the database. This is done by right-clicking the Service Descriptors folder of a TIBCO Business Studio project. including a file or a URL. and selecting Import. then Service Import Wizard. Importing WSDLs into the Service Descriptors Folder If you have a web service that you want to invoke. The following is an example of how this might be used: If you have an existing database. which can then be imported into TIBCO Business Studio. Once the data structure in the XSD (or WSDL) file has been imported into a BOM. 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. this mismatch is normal if you have data types that are defined in an external system.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. then imported and extended to cope with known and future requirements. causing TIBCO Business Studio to display the following warning: Despite the warning. the copy of the definitions in TIBCO Business Studio will differ from the source that they came from. Business Data Services Guide . the WSDL defining that service can be imported into the Service Descriptors folder.

a BOM is generated that contains all the structured data definitions used by the web service.Creating a Business Object Model (BOM) 27 | Once imported. as you risk losing changes if the file is regenerated. 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. Business Data Services Guide . if you attempt to change one of the generated BOMs. However. for example: As part of the importing of the WSDL file. 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. you can view the services defined by the WSDL file. In order to call a web service. 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 warning is generated: TIBCO recommends that you do not change a generated file. a service task must be added to a BPM process and the Task Type must be set to Web Service. These Business Objects can then be mapped onto the input and output parameters of the Web Service task that is being called.

As previously explained.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. because it has not yet been produced). 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. Business Data Services Guide . it can be created here For a more detailed overview of defining Web Services. see Scripting with Web Services on page 109. 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. the data types used by the web service are defined in a BOM created in the Generated Business Objects folder. If the WSDL does not exist yet. 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). Generating a WSDL for a Web Service You Are Creating If you do not have a WSDL file for a web service (for example. 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.

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

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

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

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

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

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. BOM classes.34 | Chapter 3 Business Data Definition If you attempt to set a default on an optional attribute. The label text is displayed by the BOM editor as shown below: Business Data Services Guide . and BOM attributes have a Label as well as a Name. for example. one with a potential multiplicity of zero. the following warning is generated: BOM Labels and Names BOM packages.

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

Character Description Dot Comma Hyphen BOM Class Label and Name Any characters are valid in a label. 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. including the following: Character .36 | Chapter 3 Business Data Definition Spaces and punctuation characters are not allowed in names. Because the Name is used in scripts. For example: Business Data Services Guide . In the following example. as in the example above. As the label is converted to the class name. it is easier to read if initial capital letters are used for each separate word. . any illegal name characters are ignored. in which case the name must then be manually changed. 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.

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

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. The project lifecycle ID can be viewed by right-clicking on the Project and selecting Properties > Lifecycle: The BOM Label is free format text. but there are no such restrictions for Labels. which is also a dot-separated name in the same format. Business Data Services Guide . A full list of reserved words can be found in Reserved Words in Scripts on page 180. meaning it can be any text that you want to display. The Label is displayed in the BOM editor. 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. Words that are keywords in Java or JavaScript cannot be used as Class or Attribute names.

as shown below: Business Data Services Guide . Therefore. For example. attribute and class names must be unique and ignore case and underscores.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. an error is generated against the BOM: Errors can be found in the Problems tab or by using the red-cross marker. if another attribute is added with the name "thmonth". there are further restrictions on names that can cause other clashes. 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. as shown below: This is a generic BOM problem and has to be fixed manually. Because of the internal workings of BDS.

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

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

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

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

Activities responsible for generating WSDL operations cannot have array parameters associated. please create a Class to contain the array. Business Data Services Guide . Instead.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. Document literal type bindings must have formal parameters of type external reference.

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

Each time a TIBCO Business Studio project is deployed.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. 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. Business Data Services Guide . any change can be made to the BOM between deployments without affecting existing projects that make use of the BOM. therefore. However. they are independent of each other. As each deployed project has its own copy of the BOM artifacts. See the next section for details. it will be deployed with a copy of the BDS plug-ins from each BOM that the project references. or redeployed. there are restrictions if you want to migrate Process Instances between different versions of a Process Template.

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

1 * 1.. as long as it makes it less restrictive (for example. 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) ...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. 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. Examples are given in the following table.8 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. its restrictions may be altered..* 1 4.. Table 5: Examples of Compatible Change Rules From 1.1 * To 1.1 1 * 0. If an attribute’s type remains the same... as long as they are less restrictive than the old restrictions.* Valid? Yes .* 1.5 1 0.

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

By default. There is also a Mandatory flag that can be specified. which controls whether the field has to have a value. 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. the new field will not be available in the Task until it is added to the Interface. After a User Task has been completed. which means there are no restrictions and the Task has access to all the fields in the process. User Task BOM fields can be displayed and updated in User Task steps. Business Data Services Guide . and using Scripts in general. See Creating a New Business Object on page 59 and the following sections for more details on using BOM fields in Script Tasks.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. and a new field is added to the process. If the Interface tab is used. and therefore need to be initialized using the factory method before any of the attributes can be referenced. 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. no fields are listed.

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

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 .

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.org/math/types/" xsi:type="tns1:Customer"> <name>Fred</name> <email>fred@myemail.com/. are encouraged to first learn the basics of JavaScript before progressing onto TIBCO BPM Scripting. It does not include a full description of the syntax of the JavaScript language. Business Data Services Guide . A useful introduction to JavaScript can be found at the W3Schools web site http://www. This means that. the xsi:type is present. This is described in the specification: http://www. 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.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. or who are struggling with the syntax. The following section gives an example of how to use Business Data Scripting in practice in TIBCO BPM. wherever possible.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. For clarity. You can learn more about JavaScript from many sources.w3. this data is fully compliant with the use of xsi:type as described in the specifications. you must provide an xsi:type when using extended types. Those not familiar.w3schools.

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

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

complete. 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. there are some places where the processes require custom processing of the data beyond the direct mapping of attributes. In these cases. 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. but has some unique restrictions and extensions. cancel. for example: • • • • • Script tasks within processes Action Scripts that are run on particular events related to tasks (for example. through a number of examples. However. Business Data Services Guide . timeout. or attributes of one object can be mapped onto attributes of another object in graphical ways using the mappers.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.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. both within and between processes. submit and close) Timer Scripts . initiate. can sometimes be mapped as whole objects from one process to another. open. the scripting capabilities can be used.

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

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

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

This is done by creating a new Data Field in a process.60 | Chapter 5 Business Data Scripting by Example In order to create an customer 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 . we first need a data field to hold the instance. and setting the Type to be an External Reference to a type in the BOM.

One of the differences between BPM Script and standard JavaScript is the new operator is not supported. Factory methods have to be used to create objects. cust2 = ScriptUtil.copy(cust1). Create a Copy of a Business Object Another way of creating a new Business Object is to create a copy of an existing object. as shown below. cust3 = cust1.Creating a New Business Object 61 | View the Script Task properties and from Script Defined As needs. The instances of the Customer class are created by the "Customer Factory Method". is provided for doing this: cust1 = com_example_scriptingguide_Factory. by clicking Maximize.createCustomer(). cust = com_example_scriptingguide_Factory. The ScriptUtil utility method. as shown below: It is very important to understand that when a process starts. select JavaScript: The Describe Task Script dialog is displayed. it just has the ability to. Type the script. 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. the cust process data field will not contain or refer to an instance of the Customer class.createCustomer(). 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. Maximise the Describe Task Script dialog. Business Data Services Guide .

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

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

name = customerName.getYear().name if not already set */ if (null != cust.dateOfBirth) { year = cust. as shown below: /* * Set the cust. Business Data Services Guide .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). even for Optional parameters). then all text until a matching "*/" is ignored by the script engine. although this will only work for attributes that do not have a default value.dateOfBirth.createCustomer(). Similarly. you should check that an attribute is not null before using any methods on an object. 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. } The example above shows how to use a multi-line comment. 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. then after the UserTask is complete the BOM field will always refer to an object. } /* Set the cust.name if not already set */ if (null == cust.name) { cust. The comment is opened with a "/*". We can check to see if attributes have been previously assigned by comparing them against null. • Once we know that the cust field has a value. we can then set the name. } Otherwise you will get a runtime exception. For example: if (null == cust) { cust = com_example_scriptingguide_Factory.

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

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

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

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

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

The List objects do not need to be created. the process data field cust has only referred to a single instance of the Customer class (a single Customer Business Object). cust.custNumber = "C123456". They are created by default as empty Lists. 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. However. This is shown below.70 | Chapter 5 Business Data Scripting by Example Multiple Instances of a BOM Class In the examples we have looked at so far. the process data field will refer to multiple instances of the Business Object.createCustomer(). cust = com_example_scriptingguide_Factory. it is possible for it to refer to multiple instances. This is done through a List 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). Let us consider a process data field that holds a List of Customer objects called custList. Business Data Services Guide . then instead of referring to a single Business Object. you can assign the cust field with a single instance field. If you want to associate a particular Customer with the custList variable.name = "Fred Blogs". which can contain multiple Business Objects. cust.

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

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

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

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

orderline.Multiple Instances of a BOM Class 75 | or using the ScriptUtil.copy(orderline). Business Data Services Guide . see Using the List set() Method on page 84.add(orderline).quantity = 3. order. orderline. order.partNumber = 10056.orderlines. 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. To learn more about what you can do with the List object. orderline = ScriptUtil. orderline.add(orderline). Removing an Item from a List or a Containment Relationship on page 85.quantity = 1.createOrderLine().copy() method: var orderline = com_example_scriptingguide_Factory. Scripting Containment Relationships on page 82. The List object provides methods for finding out how many items there are in the list. and enumerating the list. Using the List set() Method on page 84. orderline.orderlines. accessing particular entries in the list.partNumber = 10023.

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

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

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

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

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

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

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

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

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

To remove an item from a list means iterating through the list to find the item and then deleting it.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.remove(). Be careful using the first example above. and not a copy of it.000 if (customer. ) { var customer = iterator. or: order. This method checks to see if it is the same object that was adde. or other value passed.orderlines.orderlines. 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. you should use the Iterator’s remove method.remove(0). } } Business Data Services Guide . It does not compare the contents of the objects.remove(orderline1). The Business Object.hasNext(). If you don’t know which item you want to remove.listIterator(). the remove() method should be used. must be the same Business Object instance that is in the list. iterator. // check if credit limit above 1. or the index of the object to be removed: //Remove an object from a collection order.next().000.creditLimit >= 1000000) { iterator. It can be used with the object to be removed.

There is also a clear() method on Lists that can be used to remove all entries in the list. ix++) { var customer = custlist.creditLimit >= 1000000) { custlist.000. ix--. ix < custlist. // decrement index so next iteration check the new nth item } } If the list index is managed in the script. for example: bike. custList.clear().size().get(ix).clear(). Business Data Services Guide .000 if (customer. 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.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.remove(ix). // check if credit limit above 1.widgets. as in the second example.

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

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

if (ProductType. we can create a variable called book. If the Product field or attribute actually refers to a Product or Electrical Business Object. Howerver.createISBNList(). The assignment will fail when the value is saved at the end of the task. However.isbn).isbns.Scripting on Business Objects That Use Inheritance 89 | To get around this problem. will only work at runtime if the Product actually refers to an instance of the Book class (or a sub-type). In our example.type) { var book = com_example_spec3_Factory.listIterator(). However. after which TIBCO Business Studio allows access to the attributes of the Book class. Business Data Services Guide . it is not always OK to do things the other way around. Assigning an attribute or process data field that is a Book type.add(book. we know from the test that we conducted previously. bookList.createBook(). } } 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. for (var iter = productCatalog. Book "is-a" Product. which we initialize to an object of type Book.BOOK == product. 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. 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. iter.next().products. that in this case it is safe: If we do not have the above check. then it does not satisfy the "is-a" Book condition. ) { var product = iter. book = product.hasNext(). Then we assign the Product Business Object to the book variable. from a variable or attribute of a Product type.

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

length str. 5 characters long Return substring starting at 6th position in string str. var thirdString = "Fred's World". considering the following String variable: var str = "Hello TIBCO!". // // // 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. for example. Table 7: String Operations Expression str. var nextString = 'Hello Fred!'. The following operations can be done on the String. // // var fifthString = "Fred's \"Old\" House". for example: var firstString = "Hello World!". they must be of the same type.substr(0. However. 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. // // // // var fourthString = ' "The Old House" '.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.substr(6) Business Data Services Guide .5) Result 12 Hello TIBCO! Comment Returns length of string Return substring starting at offset 0.

consider using the User-defined Types described in Working with Primitive Types on page 106. str. so when one of the above functions returns a String value.slice(-6).slice(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.92 | Chapter 5 Business Data Scripting by Example Table 7: String Operations Expression str. see Text (String) Methods on page 203.slice(6.slice(0. The original String is not changed. str.indexOf(" "))) str.toLower Case(). If you want to restrict what Strings can be put into certain Text fields. or whole string if one word str. or whole string if one word Returns last word in String.lastInd exOf(" ")+1) For more information about String class methods. Business Data Services Guide . it is a reference to a new String. The String objects are immutable.

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

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

you can do the following: var totalKgs = 0. using the arithmetic abbreviations that can be used in scripting. totalKgs = totalKgs + member. for (var iterator = team. ) { var member = iterator. var teamSize = 0. do not divide by 0.averageWeight = totalKgs / teamSize. teamSize = teamSize + 1. The code above checks for this special case.hasNext(). } if (teamSize > 0) { team. iterator. teamSize++. to work out the average weight of a team member. } Note that the two lines in the loop that update the running totals can be shortened to: totalKgs += member. When dividing.members. } else { team.averageWeight = 0.listIterator().next().weightKgs.Working with Basic Integer Numbers 95 | In scripting. 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 .weightKgs.

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 .

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

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

// equivelant to “2010-12-25” datetime = DateTimeUtil.createDate("2010-12-25"). datetimetz = DateTimeUtil. Time. 25).createDatetimetz("2010-12-25T15:00:00+05:00").0.createDatetime("2010-12-25T15:00:00"). Business Data Services Guide .createDate(2010. With no parameters these methods create an object representing the current date or time. and Datetimetz types are represented using a XMLGregorianCalendar object within the Script Engine. for example. This provides methods to manipulate the date/time type variables and attributes.createDatetime("2010-12-25T15:00:00Z"). Specifically.M. 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. The following are some examples of date/time types. 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. 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.createTime(17.0). This type is used to hold a time. datetime = DateTimeUtil. time = DateTimeUtil. or alternatively. date = DateTimeUtil. with a mandatory timezone offset.30.createDatetime("2010-12-25T15:00:00+05:00"). they can be given a string or other parameter types to construct the appropriate object with the required value.createDatetimetz("2010-12-25T15:00:00Z"). time = DateTimeUtil. Datetime. with an optional timezone offset. datetime = DateTimeUtil. as shown below.// equivelant to “17:30:00” date = DateTimeUtil. 1st January 2011. 12. The date/time attributes and fields can be initialized in scripts using methods on the DateTimeUtil factory. for example 4:25 P. This type is used to hold a date and time.createTime("17:30:00"). This type is used to hold a date and time. datetimetz = DateTimeUtil.

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

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

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. The equals() method is just a wrapper around the compare() method. the result is deemed to be indeterminate.compare(startdate) == DatatypeConstants. The compare() method should be used to compare items that either do or do not have a timezone. To check for greater than or equals. The method still works if the date/times are more 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.GREATER enddate.LESSER) { // End date is greater than or equal to start date – OR INDETERMINATE!! } Business Data Services Guide .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.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.compare(startdate) == DatatypeConstants. either the compare() or equals() method should be used.

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

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

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

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

the partNum field can be assigned using: order.orderline.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. Business Data Services Guide .partNum = "PN-123456".orderline. as shown in the example below: order.partNum = "ROB-123456". If a script is written with an invalid format value. the script editor will not detect this as an error. Instead. this will cause a runtime validation exception when the Task that contains the script completes. since it does not check that Strings have the correct content. using the above example.

setTime(0.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. // back to end of prev.add(DateTimeUtil. Loop Conditions – Boolean expressions that determine whether a loop should continue or not.setDay(1).createDuration("P7D")). // get current datetime datetime. // move on to next month datetime. // return value of script Business Data Services Guide .add(DateTimeUtil. month datetime. which is 7 days in the future.createDuration("P1M")).0. Task TimerEvent – Datetime expressions that determine when a task should timeout. The value of the script is the value of the last line in the script. For example. // change to 7 days time datetime. we can use the following: var datetime = DateTimeUtil.createDuration("-P1D")).add(DateTimeUtil. minutes & seconds datetime.createDatetimetz(). // adjust in case on 31-Jan datetime. if we want a script to calculate a timeout to be the end of the month. // clear hours. These expressions can be multi-line expressions.0).

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

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

repeat for the output of the Web Service: Then. on the General property sheet. This can be done in scripts. for example. Then. 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. change the name of the task to something appropriate.Scripting with Web Services 111 | The mapping will then be shown like this: Then. drag two script tasks onto the Process Diagram before and after the Web Service call and name them appropriately: Business Data Services Guide . To do this.

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

the following error message appears: BDS Process 1.0 : Activities responsible for generating WSDL operations cannot have array parameters associated. instead please create a business object class to contain the array.Scripting with Web Services 113 | Instead.. create a BOM class to wrap the multiple Text values like this (Note that multiplicity of 0.* 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. (ProcessPackageProcess:StartEvent) Business Data Services Guide .

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

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

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

page 118 Working with Fixed Decimals (BigDecimal).setObject(). page 134 encodeURI() and decodeURI(). page 129 Object BOM Native Type and ScriptUtil. page 122 Object BOM Native Type. Topics • • • • • • • Working with Fixed Length Integers (BigInteger). page 134 encodeURIComponent() and decodeURIComponent().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 132 escape() and unescape(). page 135 Business Data Services Guide .

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

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

compareTo(two) <= 0 one.compareTo(two) != 0 one.compareTo(two) > 0 one.compareTo(y) > 0 Greater than one.compareTo(y) == 0 Description Equals Example one.compareTo(two) >= 0 one.compareTo(one) >= 0 x.compareTo(y) < 0 Less than one. Therefore. for example.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. all the above methods do not change the object that they are working on. 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(two) < 0 one. they do not change once they are created. However.compareTo(one) != 0 x.compareTo(one) <= 0 x.compareTo(one) < 0 two.compareTo(y) >= 0 Greater than or equals one.compareTo(one) < 0 x.compareTo(one) <= 0 two. Business Data Services Guide .compareTo(y) != 0 Not Equals one.compareTo(y) <= 0 Less than or equals one.compareTo(one) > 0 two.compareTo(one) >= 0 two.120 | Chapter 6 Advanced Scripting Examples Then: Operator x.compareTo(two) == 0 one. if appropriate. which you can read about in Fixed Length Integer (BigInteger) Methods on page 191. they return a new BigInteger object that has the new value.compareTo(one) == 0 x.

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

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

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

5 There are three built-in MathContexts provided: DECIMAL32.1 -1.6 -2.1234512345123451234512345123451234512 3451234512346 Business Data Services Guide . If the DECIMAL64 MathContext is used.1234512345 0.6 -2.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. RoundingModes. The table below shows the results of dividing 12345 by 99999 using BigDecimals with different Precisions. UP HALF_UP UP HALF_UP UP 10 10 50 1 0 0.0 -1.0 -1. and the Numeric type used in JavaScript) is used.0 -1. no exact representable decimal result. The UNNECESSARY rounding mode is the default RoundingMode.1234512346 0.0 -1. and will generate an exception if the resultant number of digits used to represent the result is more than the defined precision.lang.5 -5.1 -1.ArithmeticException: Non-terminating decimal expansion. 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. Table 12: Example Rounding Mode Results According to BigDecimals Digit Rounding Input Rounding Mode Precision Math Context Result java. DECIMAL64. and DECIMAL128. and MathContexts.124 | Chapter 6 Advanced Scripting Examples Table 11: Example Rounding Mode Results According to Single Digit Rounding Input Input Number 1.5 -5.

createBigDecimal(planetCount).lang. planets.averageWeight = totalKgs.5 up planets. The divide() method called above should be changed to: // 30 significant digits.1234512345123451234512345123451235 java. number of digits) of 2. rounding 0.4 to differ from 1. as the equals() method considers 1.30. or // 34 significant digits. or // 30 significant digits. This is because 1.40.HALF_UP ).mc).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.DECIMAL128).averageWeight = totalKgs.5 up (using MathContext) var mc = ScriptUtil. 1.HALF_UP). Business Data Services Guide . MathContext.RoundingMode.1234512 0. no exact representable decimal result.ArithmeticException: Non-terminating decimal expansion. rounding 0.createMathContext(30. meaning they have the same value. rounding 0.1234512345123451 0.40 is stored as the number 140 with a scale of 2 and a precision of 3. When comparing BigDecimal values it is best to use the compareTo() method.divide(ScriptUtil.createBigDecimal (planetCount). the compareTo() method sees that there is no difference between them.RoundingMode. However.divide(ScriptUtil.divide(ScriptUtil.averageWeight = totalKgs. The equals() method does not recognize them as the same. and returns 0.5 up planets.4 is stored in BigDecimal as the number 14 with a scale of 1 and a precision (for example.createBigDecimal (planetCount).1234512345123451234512345123451234512 3451234512345 0.

compareTo(y) <relational_operator> 0 This will return the value that you expect the first expression to return. instead of using x <relational_operator> y you must use x.compareTo(y) <= 0 Business Data Services Guide . For example. when comparing two decimal fields x and y. if you want to use the expression x <= y you should write x.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. Detailed information on how this can be used is available in the previous section on Integers. but in summary.

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

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

However. It is also not possible to assign a BOM object of one variety into a BOM bject of a different variety. or a BOM class.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. For example. BOM Attributes can be defined as Object type (for example. once data has been stored in an object. 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 must remain in that object. it cannot be read back out into its original type. xsd:any). An Object type BOM class attribute can be assigned either another Object attribute. but the data of which can still be passed on by the system. 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 .

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

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

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

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

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

231-1].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. Limitation of accuracy and rounding issues may indicate that it’s not suitable for handling large values.16 significant digits. use Datetimetz. If it is insufficient. With Datetime types if a timezone is required. Be aware of the limitations of the default Floating Point Decimal sub-type . use the Fixed Integer type. • Business Data Services Guide .

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 other projects that reference the BOMs will each include the BDS plug-ins for the shared BOMs as part of their own deployment. and the other projects can define processes that use objects from both the local and the shared BOMs. Business Data Services Guide . Any projects that just contain BOMs do not get deployed. 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.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.

claimmodel.claimmodel.customerdetails package: • • com.example.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.Customer must both be defined in the package that defines the com.example.Address com. Business Data Services Guide .example.claimmodel.customerdetails.claimmodel.example. the following classes must both be defined in the package that defines the com.customerdetails package. For example.customerdetails.

Business Data Services Guide .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. 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. then any changes made by editing the BOM could be lost.

You can do this by breaking potentially large chunks of logic into separate scripts. and multiplicity are checked at the end of every script. 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. 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. Check for Nulls It is very important to check that fields and attributes are not null before attempting to get their values. limits. Keep the Scripts Small It is recommended that you keep scripts small. Ensure Business Objects Are Valid Before Scripts Complete Remember that the length. so ensure that all the Out and In / Out fields for the task have valid values before the script task is completed.146 | Chapter 7 Business Data Modeling Best Practice Business Data Scripting Best Practice This section contains some suggestions for Business Data scripting. the former construction will result in a syntax error. Business Data Services Guide .

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

". In the Available Customizations dialog. This can be done by clicking the View Menu in the Project Explorer: Select Customize View….148 | Chapter 8 Troubleshooting Viewing BDS-generated BDS Plug-in Hidden Projects BDS Plug-ins can be seen in the Project Explorer. uncheck . 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.*resources.

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

Then the project that the Scripting Guide BOM comes from can be cleaned and rebuilt to regenerate the projects. if the project is rebuilt. the BDS plug-in folders can be removed. 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. the BDS Plug-in folders should be regenerated: In the above screenshot. for example: Business Data Services Guide . the two Scripting Guide folders can be deleted. To verify that they are being generated. Then.

the default location for CONFIG_HOME is: C:\ProgramData\amx-bpm\tibco\data On UNIX. Break Script into Smaller Scripts Add User Tasks between script tasks to see the field values. the default location for CONFIG_HOME is: /opt/amxbpm/tibco/data The default INSTANCE_NAME is Admin-AMX BPM-AMX BPM Server. In order to do this. It can be useful to look at these logs when debugging scripts that are not working. Business Data Services Guide . a script does not function as planned.log On Windows. Examine the Server Logs TIBCO BPM components write out logging information as they process work. Log files are located in: <CONFIG_HOME>/tibcohost/<INSTANCE_NAME>/nodes/BPMNode/logs/BPM. 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).Troubleshooting BDS Scripting | 151 Troubleshooting BDS Scripting Occasionally. as described previously. BDS Classes Do Not Appear or Changes Do Not Appear Check that there are no problems with the BDS Plug-in generation.

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

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

For example. the following are some ScriptTasks with IntermediateCatch events attached to them. 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.154 | Chapter 8 Troubleshooting Catch Exceptions If there is the possibility that a script will generate an exception at runtime.

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

xml.Integer org.xsd.XMLGregorianCalendar javax.Double javax.eclipse.datatype.any Object .Boolean javax.BigInteger java.util.Math.Math.xml.lang.Duration java.ecore.datatype. and whether they are mutable or not.xsd. BOM Native Type to BDS Type Mapping This table shows which Java Type the BOM Native Types are mapped onto.FeatureMap org.XMLGregorianCalendar javax.String javax.BigDecimal java.lang.156 | Appendix A Supplemental Information Data Type Mappings This section contains tables showing data type mappings.emf.anyAttribute Object .datatype.anytype Object .lang.FeatureMap EObject java.anySimpleType Text Time BDS Java Type N/A java.datatype.String java.lang.datatype.lang.util.xml.emf.lang.xsd.xml.eclipse.ecore.Object java.XMLGregorianCalendar Mutable? N/A No Yes Yes Yes No No No No No No No No No No No Yes Business Data Services Guide .XMLGregorianCalendar java.xsd.xml. 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 .

lang. but the values of immutable types cannot. 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. The methods that operate on them return new objects with the new values instead of mutating the value of the original object.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

Nested xsd:any in Sequences EMF is unable to handle nested sequences where there is an xsd:any or xsd:anyattribute in each sequence.g. 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. For example. Business Data Services Guide . maxOccurs) at the sequence or choice level the XML generated may not be valid.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. and will result in a validation error. This is because EMF does not support outputting XML where the pattern/order of elements in the group reoccurs in group order.

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.w3.com/nsLocalAny" targetNamespace="http://example. of which contain an xsd:any: <?xml version="1.com/NestedAny" targetNamespace="http://example.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="http://example. there is a sequence within another sequence.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 .org/2001/XMLSchema" xmlns="http://example.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.166 | Appendix A Supplemental Information For example. it is not possible to set another class in the BOM to it. in the following schema. EMF will not strip the namespace automatically. For example: <?xml version="1. This is because the BOM class will already have a namespace associated with it. where the namespace is set to ##local.

com/ComplexRestriction"> <!-.0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www. Business Data Services Guide . the following schema is not supported: <?xml version="1.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> <!-.com/ComplexRestriction" targetNamespace="http://example.BDS Limitations 167 | Restrictions between Complex Types A Complex Type cannot be a restriction of another Complex Type.w3.org/2001/XMLSchema" xmlns="http://example. EMF restrictions prevent this.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. For example.

the following schema would not be supported: <xs:schema xmlns:xs="http://www. They will be allowed to import and run as if the block does not exist.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.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.org/2001/XMLSchema" xmlns="http://example. For example. For example.com/RecurringElements" targetNamespace="http://example.w3. 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.

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 .

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

ID.id.text = bomField.text = bomField.bool. bomField.datetime. 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. bomField. Example N/A Comments N/A Business Data Services Guide .date. URI. Text Object. bomField.datetimetz.duration. Datetimetz bomField. bomField. bomField.text = bomField. URI bomField.text = bomField. Text Text Duration ID.decimalFixed. Datetime.Data Mapping 171 | Table 17: Converting Values Between Different BOM Attribute Types To Type Boolean From Type Date.text = bomField. Datetime.text = bomField.time.text = bomField.integerFixed. Object.text = bomField. bomField. Attachment N/A N/A For example. bomField.text = bomField.text = bomField.uri. bomField. P12DT3H for 12 days and 3 hours. bomField. Attachment Text Text Text Text Text Text Boolean Integer-Signed Integer-Fixed Decimal Float Decimal Fixed Date. Time.text = bomField. Time.text = bomField. intSigned. Datetimetz Duration.decimal. bomField.

intSigned = parseInt(bomField. bomField. Time.10). Attachment Integer Fixed Text bomField. Object.text). 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. URI.intSigned = parseInt(bomField.toS tring()).createBigInteger( bomField. Integer Signed Integer Signed Integer Signed Business Data Services Guide . Duration.decFloat).172 | Appendix A Supplemental Information Table 17: Converting Values Between Different BOM Attribute Types To Type Integer Signed From Type Text Example bomField. Decimal Float bomField. Integer Fixed Integer-Signed bomField.text.intFixed. Boolean. Integer Fixed Decimal Float bomField. Integer Signed Integer-Fixed bomField.text).createBigInteger( bomField. intSigned = parseInt(bomField.intFixed = ScriptUtil.intFixed. ID. Datetimetz. Date.intFixed = ScriptUtil. Datetime.createBigInteger( bomField.intFixed = ScriptUtil. intSigned = bomField. Decimal Fixed bomField.toS tring()). Copes with base. intSigned = parseInt(bomField.decFloat.intSigned).

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

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

Duration. Attachment Duration Text bomField. Datetime. Time. Datetime. time. Object. Datetimetz From Type Date.time).text. URI.id = bomField. N/A N/A Comments See DateTimeUtil for more factory methods Duration ID. Datetimetz Boolean.Data Mapping 175 | Table 17: Converting Values Between Different BOM Attribute Types To Type Date. Decimal Fixed All other types Text bomField. Decimal Float.date. Fixed Integer. Fixed Decimal.createDatetime( bomField. Datetimetz Date. Fixed Integer.duration = DateTimeUtil.integerOrDecimal). Datetime. URI Attachment N/A Business Data Services Guide .text.createDuration( bomField.createDuration( bomField.datetime = DateTimeUtil. ID. N/A bomField. 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. Duration Signed Integer. bomField.duration = DateTimeUtil. ID. bomField. Time.uri = bomField.text).

as shown below. No problems mapping data No problems mapping data No problems mapping data No problems mapping data. an exception will be raised. The Basic Datetime type can be assigned to a BOM Datetimetz Attribute. Others are slightly different. 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. so all values that this can take will fit in a BOM Attribute Integer (which is a 32-bit Integer). If it doesn’t.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. 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. Business Data Services Guide . Some of these types have equivalent BDS Attribute types.

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

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

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

but WHILE is acceptable). Other reserved words cannot be used in the case shown. Business Data Services Guide . regardless of case. but can be used by changing the case (for example. while is prohibited. Cannot be used.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.

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

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

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

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

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

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

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

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

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

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

Compares this BigInteger with the specified BigInteger. including the following: • • • • • Fixed Length Integer (BigInteger) Methods Fixed Point Decimal (BigDecimal) Methods IpeScriptUtil (and ScriptUtil) Conversion. Returns the maximum of this BigInteger and val. Business Data Services Guide . Returns a BigInteger whose value is the greatest common divisor of abs(this) and abs(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. Returns a BigInteger whose value is (this divided by val). Returns the minimum of this BigInteger and val. Returns a BigInteger whose value is (this plus val).BOM Native Type Methods 191 | BOM Native Type Methods This section describes supported methods using different BOM native types. Compares this BigInteger with the specified Object. 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. Compares this BigInteger with the specified Object for equality. Date and Time.

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

MathContext mc) compareTo(BigDecimal val) divide(BigDecimal divisor) Returns a BigDecimal whose value is (this + with rounding according to the context settings. int scale. Returns a BigDecimal whose value is (this + and whose scale is max(this. augend). BigDecimal add(BigDecimal augend) BigDecimal add(BigDecimal augend.scale() . RoundingMode roundingMode) divide(BigDecimal divisor. augend. BigDecimal divide(BigDecimal divisor.scale().scale(). If the exact quotient cannot be represented (because it has a non-terminating decimal expansion). int BigDecimal Compares this BigDecimal with the specified BigDecimal.scale()). and whose scale is this. Type BigDecimal Method abs() Notes Returns a BigDecimal whose value is the absolute value of this BigDecimal. / BigDecimal divisor). augend).divisor.scale()). Returns a BigDecimal whose value is (this / and whose preferred scale is (this. an ArithmeticException is thrown. divisor). MathContext mc) Returns a BigDecimal whose value is (this and whose scale is as specified. Returns a BigDecimal whose value is (this / with rounding according to the context settings.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. Business Data Services Guide . divisor).

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

subtrahend). subtrahend. using scientific notation if an exponent is needed. BigDecimal setScale(int newScale. Returns a BigDecimal whose value is (this and whose scale is max(this. with rounding according to the context settings. using engineering notation if an exponent is needed. and whose value is numerically equal to this BigDecimal's. Returns a BigDecimal whose numerical value is equal to (this * 10n). MathContext mc) toEngineeringString() BigDecimal Returns a BigDecimal whose value is (this subtrahend). Returns a BigDecimal whose scale is the specified value. Returns a BigDecimal whose scale is the specified value. String String String toPlainString() toString() BigDecimal ulp() Business Data Services Guide . 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 the string representation of this BigDecimal. Returns the signum function of this BigDecimal. but with any trailing zeros removed from the representation.scale().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 string representation of this BigDecimal. Returns a string representation of this BigDecimal without an exponent field.scale()). Returns a BigDecimal that is numerically equal to this one. Returns the size of an ulp (a unit in the last place) of this BigDecimal. RoundingMode roundingMode) int BigDecimal signum() stripTrailingZeros() BigDecimal subtract(BigDecimal subtrahend) subtract(BigDecimal subtrahend.

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 .

BOM Native Type Methods 197 | Date. Time. getHour() Return hours or DatatypeConstants. Y n/a Y Y Y n/a Y Y n/a BigDecima l int getFractionalSecond() Return fractional seconds. Y Y Y Y Y Y Y Y Y void clear() Unset all fields to undefined.FIE LD_UNDEFINED. 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. 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 int getDay() Return day in month or DatatypeConstants. 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.FIELD _UNDEFINED.

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.FIE LD_UNDEFINED.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. 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 if this optional field is not defined.FIE LD_UNDEFINED. n/a Y Y Y n/a n/a n/a n/a n/a int getMonth() Return number of month or DatatypeConstants.

n/a Y Y Y n/a n/a n/a n/a n/a void setMinute(int minute) Set minutes. Y n/a Y Y n/a n/a n/a Y Y void setDay(int day) Set days in month.0 dateTime datatype field for year or DatatypeConstants. n/a Y Y Y n/a n/a n/a n/a n/a Business Data Services Guide . n/a Y Y Y n/a n/a n/a n/a n/a void setHour(int hour) Set hours.FIELD _UNDEFINED.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. n/a Y Y Y n/a n/a n/a n/a n/a void setMillisecond(int millisecond) Set milliseconds. n/a Y Y Y n/a n/a n/a n/a n/a void setMonth(int month) Set month. Y n/a Y Y n/a Y Y n/a Y void setSecond(int second) Set seconds. Y n/a Y Y Y n/a Y n/a n/a void setFractionalSecond(Big Decimal fractional) Set fractional seconds.

int second) Set time as one unit.200 | Appendix B Business Data Scripting Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method void setTime(int hour. n/a Y Y Y n/a n/a n/a n/a n/a void setTime(int hour. int minute. including the optional infinite precision fractional seconds. 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. including optional milliseconds. 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. and millisecond fields as: setTime(int hour. BigDecimal fractional) Set time as one unit. int minute. int second. second. int minute. int second. minute. int second) setMillisecond(int millisecond) Business Data Services Guide . int millisecond) Set time as one unit.

String toXMLFormat() Return the lexical representation of this instance. 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 void setYear(int year) Set year of XSD dateTime year field. In this case it is best to use setYear(BigInteger year) instead. 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. 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.

int getMinutes() Obtains the value of the MINUTES field as an integer value. int getMonths() Obtains the value of the MONTHS field as an integer value. int getSeconds() Obtains the value of the SECONDS field as an integer value. boolean equals(Object duration) Checks if this duration object has the same duration as another Duration object.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. or 0 if not present. Duration multiply(BigDecimal factor) Computes a new duration whose value is factor times longer than the value of this duration. or 0 if not present. boolean isShorterThan(Duration duration) Checks if this duration object is strictly shorter than another Duration object. this+rhs. Business Data Services Guide . int getHours() Obtains the value of the HOURS field as an integer value. boolean isLongerThan(Duration duration) Checks if this duration object is strictly longer than another Duration object. int getDays() Obtains the value of the DAYS field as an integer value. or 0 if not present. or 0 if not present. or 0 if not present. int getYears() Get the years value of this Duration as an int or 0 if not present.

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

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

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

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

Business Data Services Guide . Returns the square root of x. Returns the sine of x (where x is in radians). Rounds x to the nearest integer.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.

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

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

getDescription(). priority. getPriority().g. originator = Process. for example. priority = Process. getOriginator(). pvm:0a128cu Business Data Services Guide . getId(). getStartTime(). 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. id = Process.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. name = Process.getName(). description = Process. start = Process. ou=system Returns Process Instance ID. Attribute/Method priority : Integer getName() : String getDescription() : String getStartTime() : Datetimetz getPriority() : Integer getOriginator() : String getId() : String Example priority = Process. e. uid=admin.

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

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

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

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

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

For example.147.attribute3: Text workItemAttributes. They are available where the WorkManagerFactory object can be accessed (for example.attribute1: Integer workItemAttributes.483. and attribute1 a customer reference number to aid work list sort and filter choices.attribute4: Text Limited to 64 characters in length.483. 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. The attribute1 work item attribute can be assigned integer values in the range -2.647. workItemAttributes.attribute2: Text workItemAttributes.648 to 2.147.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. Business Data Services Guide . attribute2 can be used to hold a customer name. See description above. on a user task schedule script).

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

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

OrgModel 219 | OrgModel This table lists the OrgModel attributes and methods provided. the return value will be null. the return value will be an empty list. If no such named Organizational Units exist. Attribute / Method OrgModel ouByGuid (guid:Text) : EntityDetail Returns the single EntityDetail that describes the Organizational Unit identified by its GUID. Returns the single EntityDetail that describes the Human Resource identified by its GUID. Returns the single EntityDetail that describes the Group identified by its GUID. If no such named Groups exist. the return value will be null. the return value will be null. If no such Human Resource exists. Returns the list of EntityDetails that describe the Human Resources identified by the given name. If no such Group exists. Returns the list of EntityDetails that describe the Groups identified by the given name. the return value will be an empty list. 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 . If no such named Human Resources exist. Returns the list of EntityDetails that describe the Organizational Units identified by the given name. the return value will be an empty list. If no such Organizational Unit exists.

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. the return value will be null. If no such named Organizations exist. the return value will be null. the return value will be null. Returns the list of EntityDetails that describe the Organizations identified by the given name. If no such Human Resource exists. Returns the single EntityDetail that describes the Organization identified by its GUID. Example values are: • • • • • ORGANIZATION ORGANIZATIONAL_UNIT GROUP POSITION RESOURCE Business Data Services Guide . the return value will be an empty list. If no such Organization exists. 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. If no such Position exists. Returns the list of EntityDetails that describe the Positions identified by the given name. Returns the single EntityDetail that describes the Position identified by its GUID. the return value will be an empty list. If no such named Positions exist.

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

For Resource entity types. this will return the data type of the named Resource Attribute. this will return the value of the named Resource Attribute held by that Resource entity.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 .

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

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

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

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. Business Data Services Guide .

Sign up to vote on this title
UsefulNot useful