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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. and then return to this section. This section describes the implications of this OO design. Business Data Services Guide . It is important to understand the concepts described in this section to achieve the desired behavior from your scripts. refer to the examples in later sections. as is the scripting environment that supports it. If you have difficulty understanding this section.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

+14:00 or Z for Zero offset] For example: "2011-12-31T23:59:59" or "2011-12-31T23:59:59-05:00" Datetimetz Date and Time fields according to Datetime type above. Table 3: Value Spaces for BOM Native Types BOM Native Type Attachment Boolean Date Value Space N/A true.225E-307 0 Positive values between 2.79769E+308 and -2. For example: 1234567890. 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.1234567890 Decimal – Floating Point • • • Negative numbers between -1. For example: 1.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 .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.99.225E-307 and 1.999 – 999.999.79769E+308. false Year in range [-999.23 Business Data Services Guide .999] Month in range [1 – 12] Day in range [1 .

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

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

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

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

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

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

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

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

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

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

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

34 | Chapter 3 Business Data Definition If you attempt to set a default on an optional attribute. and BOM attributes have a Label as well as a Name. the following warning is generated: If you attempt to set a default on an attribute with a multiplicity greater than 1. the following warning is generated: BOM Labels and Names BOM packages. A Label is a free format field that is designed to be a user-friendly description of the attribute or class. one with a potential multiplicity of zero. BOM classes. for example. The label text is displayed by the BOM editor as shown below: 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. For example. the attribute name is used. Only characters used in ASCII A-Z (excluding accented characters). In scripting. Space and most punctuation is removed. the names that can be used to refer to attributes are considerably constrained. The characters that are valid for subsequent characters in the name are the same as the initial character.engineCapacitycc. and currency symbol have all been ignored when the names were generated. with the addition of digit characters (ASCII digits 0-9 only). the Label cannot be used with the entire product. For example: var engineSize = car.listPrice + delivery + tax.BOM Design-time Model 35 | And by the default Forms: However. var carPrice = car. a-z. brackets. You can see that the spaces. a name is defined for each class and attribute. The screenshot of the form above shows the names as well as the labels for the different fields. and the underscore character "_" are valid characters for use as a name's first-character. Therefore. The default name is generated by using the characters from the label that are allowed in names. Business Data Services Guide . as in scripting.

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

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

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

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

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

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

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

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

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

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

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

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

.. 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..5 1 0.1 * 1..1 * To 1..48 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Changes to Class Attributes and Composition Relationships The multiplicity of an attribute or composition relationship may be changed. as long as they are less restrictive than the old restrictions...* Valid? Yes . as long as it makes it less restrictive (for example. If an attribute’s type remains the same.1 1 * 0.8 0.* 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) .* 1 4. its restrictions may be altered. Examples are given in the following table.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.. Table 5: Examples of Compatible Change Rules From 1.

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

which means there are no restrictions and the Task has access to all the fields in the process. User Task BOM fields can be displayed and updated in User Task steps. There is also a Mandatory flag that can be specified. If the Interface tab is used. no fields are listed. By default. 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. which controls whether the field has to have a value. Each field that is specified in the Interface tab is specified to be one of the following: • • • In Out In / Out These specifications define whether the value is input or output to the script. Business Data Services Guide . See Creating a New Business Object on page 59 and the following sections for more details on using BOM fields in Script Tasks. 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. and using Scripts in general. After a User Task has been completed. the new field will not be available in the Task until it is added to the Interface. and a new field is added to the process.

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

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

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

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

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

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

the name of the factory contains the package and sub-package hierarchy in its name. separated by "_".58 | Chapter 5 Business Data Scripting by Example If the scriptingguide BOM contains a sub-package called ordersystem. 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. Creating objects for classes in the sub-package would be done in a similar way to creating objects in the top-level package.createOrder().

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

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

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

not for just copying BOM Primitive values. It is only for copying whole Business Objects. Business Data Services Guide .copy() method performs a "deep" copy. as well as the Business Object itself. The ScriptUtil.62 | Chapter 5 Business Data Scripting by Example The script in the example above. 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. and cust3 to refer to the same Business Object that the cust1 process data field refers to.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Business Data Services Guide .remove(ix).clear(). for example: bike. There is also a clear() method on Lists that can be used to remove all entries in the list.widgets.get(ix). custList. ix++) { var customer = custlist. as in the second example. ix < custlist.creditLimit >= 1000000) { custlist.86 | Chapter 5 Business Data Scripting by Example Alternatively this can be done just using the methods on the List object: // Iterate through the list of customers removing customers with large credit // limit for (var ix=0.size(). // check if credit limit above 1. // decrement index so next iteration check the new nth item } } If the list index is managed in the script. ix--.000.000 if (customer.clear(). 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.

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

add a Service Task onto the process diagram by dragging it from the tasks palette: Then. Locate your WSDL using one of the mechanisms provided (file location. First. in the General Properties sheet. then click Import WSDL. we can see the WSDL file under the Service Descriptors heading. URL. we perform the following tasks. 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. and select the webservice you want to invoke from the WSDL: Looking in the Package Explorer. and so on). we can see what types the Web Service takes as parameters: Business Data Services Guide . Viewing the WSDL in the WSDL Editor.

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

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

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

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

User Tasks or ScriptTasks.114 | Chapter 5 Business Data Scripting by Example When calling the webservice. Business Data Services Guide . as shown below: If an array of Business Objects was being passed using the ScriptUtil. Only the WebService task does not support Array fields. but that cannot be used for Basic fields like the Text array in this example. copy the text array into the parameter structure with a loop like this in the ServiceTask’s Init Script.copyAll() method. for example. An Array object can be passed to other Task types. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Any projects that just contain BOMs do not get deployed. and the Order class contains Products that are defined in the top-level BOM. Business Data Services Guide . and the other projects can define processes that use objects from both the local and the shared BOMs. The other projects that reference the BOMs will each include the BDS plug-ins for the shared BOMs as part of their own deployment.Reference a Common Business Object Model 143 | The AcmeIntranet and AcmeWeb projects can define their own BOM sub-packages that inherit from the top-level BOM package. 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

For example. maxOccurs) at the sequence or choice level the XML generated may not be valid. 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.g. Business Data Services Guide . and will result in a validation error. 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.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.

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

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

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.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. For example. 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. see the following schema fragment: Business Data Services Guide .org/2001/XMLSchema" xmlns="http://example.

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 .

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

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

toS tring()). URI. Integer Signed Integer-Fixed bomField.decFloat. Copes with base. intSigned = parseInt(bomField. bomField.intFixed = ScriptUtil. Attachment Integer Fixed Text bomField. Boolean. Integer Fixed Integer-Signed bomField.toS tring()).createBigInteger( bomField.intFixed = ScriptUtil.10). Decimal Float bomField.createBigInteger( bomField.intFixed = ScriptUtil.text).text. intSigned = parseInt(bomField.intSigned = parseInt(bomField.intFixed. intSigned = 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. Integer Signed Integer Signed Integer Signed Business Data Services Guide . Integer Fixed Decimal Float 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.decFloat). Date. Duration. intSigned = parseInt(bomField. Datetimetz.intSigned).createBigInteger( bomField.text). Decimal Fixed bomField. ID. Datetime.intFixed. Object.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

n/a Y Y Y n/a n/a n/a n/a n/a This method should not be used in scripts where the time field has been set before the script. int second. In this case it is best to use two separate calls to set the hour. int minute. minute. BigDecimal fractional) Set time as one unit. int second) setMillisecond(int millisecond) Business Data Services Guide . 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.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. int second) Set time as one unit. int minute. int minute. int minute. int millisecond) Set time as one unit. n/a Y Y Y n/a n/a n/a n/a n/a void setTime(int hour. second. including optional milliseconds. including the optional infinite precision fractional seconds.

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. Y n/a Y Y n/a n/a n/a Y Y void setYear(int year) Set year of XSD dateTime year field.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. String toXMLFormat() Return the lexical representation of this instance. In this case it is best to use setYear(BigInteger year) instead. n/a n/a Y Y n/a n/a n/a n/a n/a void setYear(BigInteger year) Set low and high order component of XSD dateTime year field. Y Y Y Y Y Y Y Y Y Business Data Services Guide .

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

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

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

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

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

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

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

This appendix describes the additional functions that are provided to help with process scripting.| 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. page 210 Business Data Services Guide .

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

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

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

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

See below for methods. See below for properties & methods Comments Business Data Services Guide .214 | Appendix D Work Item Scripting WorkManagerFactory This table lists the WorkManagerFactory attributes and methods provided. OrgModel must have a parameter to specify which version. Attribute / Method WorkManagerFactory getOrgModel() : OrgModel getOrgModelByVersion() : OrgModel getWorkItem() : WorkItem Returns an OrgModel object. 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. this will contain all the entities to which the item was originally offered. The specified priority of the work item. Returns the work item’s unique ID. Comments getWorkItemOffers() : List<EntityDetail> Business Data Services Guide . Attribute / Method WorkItem cancel : Boolean description : Text priority : Integer getId() : Integer getVersion() : Integer getWorkItemResource() : EntityDetail Cancels an API that exists in BRM. Returns the version number of the work item. The description of the work item. If the item was originally offered to more than one organizational entity and is now allocated. Returns a resource that has this work item. Returns a work item resource object for the work item.

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

workItemAttributes.attribute9: Text workItemAttributes.attribute5: BigDecimal Comments See description above.attribute10: Text workItemAttributes. Limited to a maximum of 20 characters . See description above.attribute7: DateTime workItemAttributes.anything larger will be truncated.attribute12: Text workItemAttributes. See description above. See description above.attribute11: Text workItemAttributes.WorkItem 217 | Attribute / Method workItemAttributes.attribute8: 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 .attribute13: Text workItemAttributes. This can be assigned Decimal or BigDecimal values.attribute6: DateTime workItemAttributes.

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

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

the return value will be an empty list. positionByGuid(guid:Text) : EntityDetail positionByName(name:Text) : List<EntityDetail> orgByGuid(guid:Text) : EntityDetail orgByName(name:Text) : List<EntityDetail> EntityDetail getEntityType() : Text Returns the type identifier for this organizational model entity. the return value will be null. Returns the single EntityDetail that describes the Organization identified by its GUID. the return value will be null. If no such named Organizations exist. If no such Position exists. Returns the list of EntityDetails that describe the Organizations identified by the given name. Example values are: • • • • • ORGANIZATION ORGANIZATIONAL_UNIT GROUP POSITION RESOURCE Business Data Services Guide . Returns the list of EntityDetails that describe the Positions identified by the given name. 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 named Positions exist. If no such Organization exists. Returns the single EntityDetail that describes the Position identified by its GUID. the return value will be null.

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful