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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. the WSDL defining that service can be imported into the Service Descriptors folder. and selecting Import. this mismatch is normal if you have data types that are defined in an external system. including a file or a URL. which can then be imported into TIBCO Business Studio. Business Data Services Guide . 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. The information about the table structure can be used in tasks that interact with the database. the copy of the definitions in TIBCO Business Studio will differ from the source that they came from. The following is an example of how this might be used: If you have an existing database. then Service Import Wizard. This allows you to import a WSDL file from a number of sources.26 | Chapter 3 Business Data Definition If you modify these imported BOMs. This is done by right-clicking the Service Descriptors folder of a TIBCO Business Studio project. 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. the structure of it’s tables can be exported into an XSD file.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

its restrictions may be altered..1 1 * 0..1 * To 1..* Valid? Yes .5 1 0.1 * 1... 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.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. Examples are given in the following table..* 1 4..8 0.. Table 5: Examples of Compatible Change Rules From 1. as long as it makes it less restrictive (for example. Table 6: Attribute Type Change Restrictions Restriction Default value Lower limit Upper limit Lower limit inclusive Upper limit inclusive Maximum text length Number length Decimal places Business Data Services Guide Permitted Change May be changed May be decreased or removed if a former lower limit was set May be increased or removed if a former upper limit was set May be changed from false to true May be changed from false to true May be increased May be increased May be increased (if length increased by the same amount or more) .48 | Chapter 4 BDS Generation and Business Data Usage in TIBCO BPM Changes to Class Attributes and Composition Relationships The multiplicity of an attribute or composition relationship may be changed.* 1. as long as they are less restrictive than the old restrictions. If an attribute’s type remains the same.

Business Data Services Guide . page 48. 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.Process Migration 49 | Table 6: Attribute Type Change Restrictions Restriction Pattern Changes to an Enumeration • Addition of new enumeration literals.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

0 : Activities responsible for generating WSDL operations cannot have array parameters associated. 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.Scripting with Web Services 113 | Instead. (ProcessPackageProcess:StartEvent) Business Data Services Guide ..* indicates that the attribute can contain zero or more values which is like the Array setting on a Process Field): And then reference this type as a parameter: If you define a webservice with an Array parameter. instead please create a business object class to contain the array.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

it cannot be read back out into its original type. 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. However.Object BOM Native Type 129 | Object BOM Native Type There are four different varieties of BOM objects: • • • • xsd:any xsd:anyAttribute xsd:anyType xsd:anySimpleType All of these allow for different assignments. or a BOM class. BOM Attributes can be defined as Object type (for example. but the data of which can still be passed on by the system. It must remain in that object. xsd:any). once data has been stored in an object. For example. An Object type BOM class attribute can be assigned either another Object attribute. 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 .

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

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

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

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

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

16 significant digits.231-1]. 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. use Datetimetz. If it is insufficient. Be aware of the limitations of the default Floating Point Decimal sub-type . • Business Data Services Guide . use the Fixed Integer type.

Use Sub-Packages to Aggregate Related Concepts 139

|

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

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

Business Data Services Guide

140

| Chapter 7

Business Data Modeling Best Practice

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

Business Data Services Guide

BOM Class, Attribute and Variable Names 141

|

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

Business Data Services Guide

142

| Chapter 7

Business Data Modeling Best Practice

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

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

Business Data Services Guide

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

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

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

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

page 151 Business Data Services Guide . page 150 Troubleshooting BDS Scripting . 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. Topics • • • Viewing BDS-generated BDS Plug-in Hidden Projects.

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

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.

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

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

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

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

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

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

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

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

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

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

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

EMF restrictions prevent this.com/ComplexRestriction"> <!-.org/2001/XMLSchema" xmlns="http://example. For 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. the following schema is not supported: <?xml version="1. Business Data Services Guide .0" encoding="UTF-8"?> <xs:schema xmlns:xs="http://www.BDS Limitations 167 | Restrictions between Complex Types A Complex Type cannot be a restriction of another Complex Type.w3.base type --> <xs:complexType name="BaseInfo"> <xs:sequence> <xs:element name="numPosts" type="xs:integer" minOccurs="0" maxOccurs="1"/> </xs:sequence> <xs:attribute name="firstSubscribed" type="xs:date" use="optional"/> <xs:attribute name="mailReader" type="xs:string"/> </xs:complexType> <!-.com/ComplexRestriction" targetNamespace="http://example.

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

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 .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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. String toXMLFormat() Return the lexical representation of this instance.BOM Native Type Methods 201 | Date Time Date Time Date Timetz gDay gMonth gMonthDay gYear gYear Month Type Method void setTimezone(int offset) Set the number of minutes in the timezone offset. Y Y Y Y Y Y Y Y Y Business Data Services Guide . Y n/a Y Y n/a n/a n/a Y Y void setYear(int year) Set year of XSD dateTime year field. Y 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.

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

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

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

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

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

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 sine of x (where x is in radians). Returns the tangent of the angle x. Business Data Services Guide .

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Sign up to vote on this title
UsefulNot useful