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

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

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

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

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

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

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. Business Data Services Guide .x | Preface Changes from the Previous Release of this Guide This section itemizes the major changes from the previous release of this guide. Work Item Attributes Additional customizable work item attributes have been added. See WorkItem on page 215. See Assigning a Null Value on page 65.

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

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

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

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

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

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

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

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

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

If you have difficulty understanding this section. as is the scripting environment that supports it.6 | Chapter 2 Concepts Object Orientation (OO) The BPM runtime is an Object Oriented (OO) system. 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. Business Data Services Guide . refer to the examples in later sections. and then return to this section. This section describes the implications of this OO design.

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

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

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

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

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

Business Data Services Guide . manager and so on). the Employee class can specialize the Person class. adding the extra attributes that only a customer has (for example. Similarly. if you had a Customer business object. 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). Alternatively. Having done this. customerNumber).12 | Chapter 2 Concepts The Customer class can then specialize the Person class. Using the previous diagram as an example. as its BOM class is a subtype of the Person class. Generalization is the reverse of specialization (looking at the same relationship from the opposite direction). 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. We can say that the Person class is a generalization of the Customer and Employee classes. by adding any attributes that only the Employee had (for example. The relationship between these classes can be represented in the BOM as shown below: Assigning a Subtype to a Super Type It is always acceptable to assign a subtype to a super type.

or the Employee BOM classes then it will not work. Business Data Services Guide . For example. 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. as they do not satisfy the "is-a Customer" requirement.BOM Relationships and Process Local Data 13 | Assigning a Super Type to a Subtype The converse (a super type to a subtype) is acceptable when the super type actually refers to an instance of the subtype (or one of its subtypes). it passes the "is-a" test. If the Person attribute is referring to a Business Object of the generic Person. In other words.

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

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

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

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

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

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

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

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

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 .999 – 999. For example: 1234567890.999] Month in range [1 – 12] Day in range [1 . For example: 1.23 Business Data Services Guide .79769E+308 and -2.1234567890 Decimal – Floating Point • • • Negative numbers between -1.999.79769E+308.99. 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.+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. 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.225E-307 and 1. Table 3: Value Spaces for BOM Native Types BOM Native Type Attachment Boolean Date Value Space N/A true.

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

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

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

Importing WSDLs into the Service Descriptors Folder If you have a web service that you want to invoke. and selecting Import. including a file or a URL. 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. the structure of it’s tables can be exported into an XSD file. Once the data structure in the XSD (or WSDL) file has been imported into a BOM. then Service Import Wizard. This is done by right-clicking the Service Descriptors folder of a TIBCO Business Studio project. 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. 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 allows you to import a WSDL file from a number of sources. Business Data Services Guide . which can then be imported into TIBCO Business Studio. The information about the table structure can be used in tasks that interact with the database. then imported and extended to cope with known and future requirements. the WSDL defining that service can be imported into the Service Descriptors folder. The following is an example of how this might be used: If you have an existing database.

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

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

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

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

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

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

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

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

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

36 | Chapter 3 Business Data Definition Spaces and punctuation characters are not allowed in names. In the following example. in which case the name must then be manually changed. Because the Name is used in scripts. Character Description Dot Comma Hyphen BOM Class Label and Name Any characters are valid in a label. 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. 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. For example: Business Data Services Guide . The following example shows a Label and Name pair where only lowercase letters are used Compared that to the following: The Name field is generated from the Label field whenever the label is changed unless the Name field has been manually set. any illegal name characters are ignored. . including the following: Character .

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

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

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

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

bds.com. For example. if the BOM root package com. Business Data Services Guide .businessobjectmodel. BDS Plug-ins are generated in a project named .example. 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. the BDS Generator generates BDS Plug-ins that correspond to the BOM.

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

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

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

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

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

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

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

it may be altered subject to the compatible change rules described in Changes to Class Attributes and Composition Relationships. 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. page 48. Business Data Services Guide .

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

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

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

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

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

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

In these cases. However. for example: • • • • • Script tasks within processes Action Scripts that are run on particular events related to tasks (for example. open. both within and between processes. cancel. the scripting capabilities can be used. 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. or attributes of one object can be mapped onto attributes of another object in graphical ways using the mappers. there are some places where the processes require custom processing of the data beyond the direct mapping of attributes.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. all of which are described later in this guide. but has some unique restrictions and extensions. submit and close) Timer Scripts . Business Data Services Guide .56 | Chapter 5 Business Data Scripting by Example Overview The data objects that are passed around the system. complete. can sometimes be mapped as whole objects from one process to another. through a number of examples. timeout. initiate. This chapter illustrates how to write BDS server-side scripts. 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.

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

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

or use a copy of an existing object.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 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.compare(startdate) != DatatypeConstants. but if they are less than 14 hours apart. The equals() method is just a wrapper around the compare() method.compare(startdate) == DatatypeConstants. either the compare() or equals() method should be used.compare(startdate) == DatatypeConstants.102 | Chapter 5 Business Data Scripting by Example Comparing Dates and Times In order to compare two date/time types.GREATER enddate. the result is deemed to be indeterminate. 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. To check for greater than or equals.compare(startdate) == DatatypeConstants. 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.LESSER) { // End date is greater than or equal to start date – OR INDETERMINATE!! } Business Data Services Guide . use the following: // Verify end date is greater than or equal to start date if (enddate. The compare() method should be used to compare items that either do or do not have a timezone.

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

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

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

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

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

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

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

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. as shown in the diagram below: Business Data Services Guide . from the Input To Service property sheet.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

once data has been stored in an object. it cannot be read back out into its original type. 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. BOM Attributes can be defined as Object type (for example. For example. 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. However. It must remain in that object. 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 . 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. xsd:any). It is also not possible to assign a BOM object of one variety into a BOM bject of a different variety.

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

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

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

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

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

Use Sub-Packages to Aggregate Related Concepts 139

|

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

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

Business Data Services Guide

140

| Chapter 7

Business Data Modeling Best Practice

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

Business Data Services Guide

BOM Class, Attribute and Variable Names 141

|

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

Business Data Services Guide

142

| Chapter 7

Business Data Modeling Best Practice

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

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

Business Data Services Guide

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

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

Business Data Services Guide . If the intention is to import an XSD and generate a BOM. then the XSD (or WSDL) should be imported into the Business Objects folder. 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.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 any changes made by editing the BOM could be lost.

Use Comments in Scripts It is good practice to comment code to make it easier for others who follow you to understand what the scripts are doing. Ensure Business Objects Are Valid Before Scripts Complete Remember that the length. and multiplicity are checked at the end of every script. 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. 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. Business Data Services Guide . You can do this by breaking potentially large chunks of logic into separate scripts. Keep the Scripts Small It is recommended that you keep scripts small. the former construction will result in a syntax error.

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

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

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

Then the project that the Scripting Guide BOM comes from can be cleaned and rebuilt to regenerate the projects. the BDS Plug-in folders should be regenerated: In the above screenshot. the BDS plug-in folders can be removed. If the projects are not regenerated.150 | Chapter 8 Troubleshooting BDS Plug-in Generation Problems Check to see if the BDS plug-ins are being created by looking for the hidden folders as described in the previous section. if the project is rebuilt. the two Scripting Guide folders can be deleted. 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. for example: Business Data Services Guide . To verify that they are being generated. Then.

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

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

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

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

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

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

The methods that operate on them return new objects with the new values instead of mutating the value of the original object.String Mutable? No The values of Mutable types can be changed.Data Type Mappings 157 | Table 13: BOM Native Type to BDS Type Mapping BOM Native Type URI BDS Java Type java.lang. 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 . but the values of immutable types cannot.

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

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

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

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

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. The "block" Function EMF will not enforce a block if used on either Complex Types or Elements.org/2001/XMLSchema" xmlns="http://example.com/RecurringElements" targetNamespace="http://example.w3.com/RecurringElements"> <xs:element name="BoatElement" type="Boat"/> <xs:complexType name="Boat"> <xs:sequence> <xs:element name="power" type="xs:string" minOccurs="3" maxOccurs="3"/> <xs:element name="hulltype" type="xs:string" minOccurs="1" maxOccurs="1"/> <xs:element name="power" type="xs:string" minOccurs="3" maxOccurs="3"/> </xs:sequence> </xs:complexType> </xs:schema> Attempting to import the above schema into TIBCO Business Studio will fail with the following message: XML Schema contains unsupported duplicate element names inside the same complex type. For example. see the following schema fragment: Business Data Services Guide .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.

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 .

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

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

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

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

Date.text). bomField. bomField.text). Attachment Text N/A N/A Using ScriptUtil Factory Comments Using ScriptUtil Factory Date.createTime( bomField.text). Time. Datetime. bomField. Time.createBigDecimal( bomField. Decimal Fixed Boolean . See DateTimeUtil for more factory methods Business Data Services Guide .datetimetz = DateTimeUtil.intDay). Date.decFloat).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. ID. Datetimetz bomField.intYear. Datetime.g.date = DateTimeUtil. bomField.time = DateTimeUtil. bomField.datetime = DateTimeUtil.createDate( bomField.decFixed = ScriptUtil. bomField. Datetimetz.createDatetime( bomField.text). Time.intMonth. Datetime. Object.date = DateTimeUtil. Decimal Fixed Integer Fixed bomField.decFixed = ScriptUtil. Datetimetz Integer.text). Duration. Decimal Float e.createBigDecimal( bomField.createDatetimetz( bomField. URI.

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

provided that it contains a timezone. The Basic Datetime type can be assigned to a BOM Datetimetz Attribute. an exception will be raised. Table 18: Mapping to or From Process Basic Types Process Basic Type Text Decimal Integer Equivalent BOM Attribute Type Text Decimal (Floating Point sub-type) Integer (Signed Integer sub-type) Comments No problems mapping data No problems mapping data The range of values supported by the Process Basic Integer is constrained to 9 digits. so all values that this can take will fit in a BOM Attribute Integer (which is a 32-bit Integer). If it doesn’t. 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. as shown below.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. Business Data Services Guide . No problems mapping data No problems mapping data No problems mapping data No problems mapping data. Others are slightly different. Some of these types have equivalent BDS Attribute types.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 .

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. Y Y Y Y Y Y Y Y Y void clear() Unset all fields to undefined.FIELD _UNDEFINED. 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 n/a Y Y Y n/a Y Y n/a BigDecima l int getFractionalSecond() Return fractional seconds. getHour() Return hours or DatatypeConstants. Time. Datetime and Datetimetz (XMLGregorianCalendar) Methods Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method void add(Duration duration) Add duration to this instance. Y Y Y Y Y Y Y Y Y int getDay() Return day in month or DatatypeConstants.BOM Native Type Methods 197 | Date.FIE LD_UNDEFINED.

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

n/a Y Y Y n/a n/a n/a n/a n/a void setMillisecond(int millisecond) Set milliseconds. Y n/a Y Y n/a Y Y n/a Y void setSecond(int second) Set seconds.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 .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 setMonth(int month) Set month. n/a Y Y Y n/a n/a n/a n/a n/a void setHour(int hour) Set hours. Y n/a Y Y n/a n/a n/a Y Y void setDay(int day) Set days in month. Y n/a Y Y Y n/a Y n/a n/a void setFractionalSecond(Big Decimal fractional) Set fractional seconds. n/a Y Y Y n/a n/a n/a n/a n/a void setMinute(int minute) Set minutes.FIELD _UNDEFINED.

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

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. String toXMLFormat() Return the lexical representation of this instance. n/a n/a Y Y n/a n/a n/a n/a n/a void setYear(BigInteger year) Set low and high order component of XSD dateTime year field. Y n/a Y Y n/a n/a n/a Y Y This method should not be used in scripts where the date field has been set before the script.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 Y Y Y Y Y Y Y Y Business Data Services Guide .

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

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

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

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

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

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

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

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

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

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

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

Topics • • • WorkManagerFactory. page 215 OrgModel. page 214 WorkItem. 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. This appendix describes the additional functions that are provided to help with work item scripting.

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. OrgModel must have a parameter to specify which version. See below for properties & methods Comments Business Data Services Guide . See below for methods. Returns WorkItem object.

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

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

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

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

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

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

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

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. For Resource entity types.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 .

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

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

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

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

Sign up to vote on this title
UsefulNot useful