programmers reference part1 6.2.8 reva

8/14/2019 Programmers Reference Part1 6.2.8 RevA

1/422

Agile Business Process

Platform (ABPP) 3Programmers Reference - Part 1

Revision A

Version 6.2.8


2/422

i2

Agile Business Process Platform (ABPP) 3Programmers Reference - Part 1Revision AVersion 6.2.8, January 2008

Copyright 2000-2008 i2 Technologies US, Inc. All Rights Reserved.

This notice is intended as a precaution against inadvertent publication and does not imply any waiver of

confidentiality. Information in this document is subject to change without notice. No part of this document may be

reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying,

recording, or information storage or retrieval systems, for any purpose without the express written permission of i2

Technologies US, Inc.

The software and/or database described in this document are furnished under a license agreement or nondisclosure

agreement. It is against the law to copy the software onto any medium except as specifically allowed in the license or

nondisclosure agreement. If software or documentation is to be used by the federal government, the following

statement is applicable: In accordance with FAR 52.227-19 Commercial Computer Software -- Restricted

Rights, the following applies: This software is Unpublished--rights reserved under the copyright laws of the

United States.

The text and drawings set forth in this document are the exclusive property of i2 Technologies US, Inc. Unless

otherwise noted, all names of companies, products, street addresses, and persons contained in the scenarios are

designed solely to document the use of i2 Technologies US, Inc. products.

The brand names and product names used in this document are the trademarks, registered trademarks, service marks,

or trade names of their respective owners. i2 Technologies US, Inc. is not associated with any product or vendor

mentioned in this publication unless otherwise noted.

The following registered trademarks are the property of i2 Technologies US, Inc. and its authorized affiliates: i2; i2

& Design; i2 User Group & Design; Planet; and Freightmatrix.

This product may be protected by one or more of the following patents:

Europe Patent No. 0861474 (E)German Patent No. 10195871German Patent No. 69508931.5German Patent No. 69507020.7German Patent No. 69601151.4German Patent No. 69601152.2German Patent No. 69601207.3German Patent No. 69601208.1Taiwan Patent No. 80326Taiwan Patent No. 93090Taiwan Patent No. 100569Taiwan Patent No. 108409Taiwan Patent No. 110827Taiwan Patent No. 113331Taiwan Patent No. 127358

Taiwan Patent No. 129860Taiwan Patent No. 133048Taiwan Patent No. 134299Taiwan Patent No. 136847Taiwan Patent No. 137376Taiwan Patent No. 139353Taiwan Patent No. 139680

Taiwan Patent No. 140308Taiwan Patent No. 146038Taiwan Patent No. 154327Taiwan Patent No. 154338Taiwan Patent No. 154339Taiwan Patent No. 155489Taiwan Patent No. 155708Taiwan Patent No. 157467Taiwan Patent No. 158220Taiwan Patent No. 159609Taiwan Patent No. 161120Taiwan Patent No. 161181Taiwan Patent No. 161494Taiwan Patent No. 162685Taiwan Patent No. 163816


Taiwan Patent No. 182974Taiwan Patent No. 191262Taiwan Patent No. 196235Taiwan Patent No. 199069Taiwan Patent No. 200370Taiwan Patent No. 205817Taiwan Patent No. 221578Taiwan Patent No. 221978Taiwan Patent No. 222584Taiwan Patent No. 222585Taiwan Patent No. 222586Taiwan Patent No. 222588Taiwan Patent No. 225208Taiwan Patent No. 225209Taiwan Patent No. 225605


01/16/08

One i2 Place

11701 Luna Rd.

Dallas, TX 75234 USA

CopyrightIn formation


3/422

Taiwan Patent No. 241800Taiwan Patent No. 242952Taiwan Patent No. 251760Taiwan Patent No. 251996Taiwan Patent No. 258090Taiwan Patent No. 266251Taiwan Patent No. 271617Taiwan Patent No. 284847Taiwan Patent No. 285339

Taiwan Patent No. 285342U. S. Patent No. 5,630,123U. S. Patent No. 5,742,813U. S. Patent No. 5,764,543U. S. Patent No. 5,778,356U. S. Patent No. 5,832,532U. S. Patent No. 5,835,910U. S. Patent No. 5,838,965U. S. Patent No. 5,845,258U. S. Patent No. 5,930,156U. S. Patent No. 5,931,900U. S. Patent No. 5,937,155U. S. Patent No. 5,943,244U. S. Patent No. 5,974,395U. S. Patent No. 5,983,194U. S. Patent No. 5,995,945U. S. Patent No. 6,031,984U. S. Patent No. 6,047,290U. S. Patent No. 6,055,519U. S. Patent No. 6,055,533U. S. Patent No. 6,076,108U. S. Patent No. 6,085,220U. S. Patent No. 6,119,149U. S. Patent No. 6,167,380U. S. Patent No. 6,169,992U. S. Patent No. 6,188,989U. S. Patent No. 6,222,533U. S. Patent No. 6,233,493U. S. Patent No. 6,233,572U. S. Patent No. 6,266,655U. S. Patent No. 6,289,384U. S. Patent No. 6,289,385U. S. Patent No. 6,321,207U. S. Patent No. 6,321,230U. S. Patent No. 6,332,130U. S. Patent No. 6,332,155U. S. Patent No. 6,334,146

U. S. Patent No. 6,360,249U. S. Patent No. 6,366,922U. S. Patent No. 6,370,509U. S. Patent No. 6,374,227

U. S. Patent No. 6,374,249U. S. Patent No. 6,374,252U. S. Patent No. 6,397,191U. S. Patent No. 6,397,192U. S. Patent No. 6,442,528U. S. Patent No. 6,442,554U. S. Patent No. 6,456,996U. S. Patent No. 6,462,736U. S. Patent No. 6,480,894

U. S. Patent No. 6,486,899U. S. Patent No. 6,490,566U. S. Patent No. 6,560,501U. S. Patent No. 6,560,502U. S. Patent No. 6,567,783U. S. Patent No. 6,574,619U. S. Patent No. 6,577,304U. S. Patent No. 6,631,363U. S. Patent No. 6,658,413U. S. Patent No. 6,708,161U. S. Patent No. 6,708,174U. S. Patent No. 6,731,998U. S. Patent No. 6,778,991U. S. Patent No. 6,785,689U. S. Patent No. 6,789,252U. S. Patent No. 6,826,538U. S. Patent No. 6,828,968U. S. Patent No. 6,836,689U. S. Patent No. 6,839,711U. S. Patent No. 6,845,499U. S. Patent No. 6,857,017U. S. Patent No. 6,868,299U. S. Patent No. 6,873,994U. S. Patent No. 6,874,008U. S. Patent No. 6,895,384U. S. Patent No. 6,895,550U. S. Patent No. 6,898,593U. S. Patent No. 6,920,476U. S. Patent No. 6,922,675U. S. Patent No. 6,934,686U. S. Patent No. 6,944,598U. S. Patent No. 6,947,905U. S. Patent No. 6,947,982U. S. Patent No. 6,957,234U. S. Patent No. 6,963,847U. S. Patent No. 6,963,849U. S. Patent No. 6,973,626

U. S. Patent No. 6,980,885U. S. Patent No. 6,980,966U. S. Patent No. 6,983,276U. S. Patent No. 6,983,421

U. S. Patent No. 6,988,104U. S. Patent No. 6,988,111U. S. Patent No. 7,003,729U. S. Patent No. 7,013,485U .S. Patent No. 7,024,265U. S. Patent No. 7,024,371U. S. Patent No. 7,028,000U. S. Patent No. 7,031,955U. S. Patent No. 7,039,562

U. S. Patent No. 7,039,597U. S. Patent No. 7,039,602U. S. Patent No. 7,039,833U. S. Patent No. 7,043,444U. S. Patent No. 7,050,874U. S. Patent No. 7,054,841U. S. Patent No. 7,055,137U. S. Patent No. 7,062,540U. S. Patent No. 7,062,542U. S. Patent No. 7,065,499U. S. Patent No. 7,073,164U. S. Patent No. 7,085,729U. S. Patent No. 7,086,062U. S. Patent No. 7,089,196U. S. Patent No. 7,089,330U. S. Patent No. 7,093,233U. S. Patent No. 7,117,163U. S. Patent No. 7,117,164U. S. Patent No. 7,127,416U. S. Patent No. 7,127,458U. S. Patent No. 7,130,809U. S. Patent No. 7,139,719U. S. Patent No. 7,149,744U. S. Patent No. 7,162,453U. S. Patent No. 7,177,827U. S. Patent No. 7,197,473U. S. Patent No. 7,210,624U. S. Patent No. 7,213,037U. S. Patent No. 7,213,232U. S. Patent No. 7,216,142U. S. Patent No. 7,225,146U. S. Patent No. 7,248,937U. S. Patent No. 7,249,044U. S. Patent No. 7,251,614U. S. Patent No. 7,257,541U. S. Patent No. 7,260,550U. S. Patent No. 7,263,515

U. S. Patent No. 7,266,549U. S. Patent No. 7,277,862U. S. Patent No. 7,277,863


4/422


5/422

vAgile Business Process Platform 3 Programmers Reference Revision A

Contents

Preface........................................................................................................ xvii

1 Introduction.................................................................................................... 1

Overview ...................................................................................................................................................1

Elements of ABPP Framework.................................................................................................................3

X-Server.............................................................................................................................................4

X-Service............................................................................................................................................4

X-Documents .....................................................................................................................................5

X-Rules...............................................................................................................................................5

X-Workflow .......................................................................................................................................6

How to Use This Guide .............................................................................................................................6

2 Modeling Concepts....................................................................................... 7Definitions .................................................................................................................................................7

Document ...........................................................................................................................................7

Property.......................................................................................................................................8

Key ..............................................................................................................................................8

Link.............................................................................................................................................9

Facets ........................................................................................................................................11

Dictionary.........................................................................................................................................17

Model Sets & Model Instances ........................................................................................................18

Model Extension and Inheritance............................................................................................................19

Model Dependancy and Composite View...............................................................................................21

Model Data Types vs Database Data Types............................................................................................23

3 X-Documents................................................................................................ 25

Introduction .............................................................................................................................................26

Document Identifiers ...............................................................................................................................27

Surrogate Key..........................................................................................................................................28

Document Index ......................................................................................................................................28

Document Properties ...............................................................................................................................29


6/422

vi Agile Business Process Platform 3 Programmers Reference Revision A

Contents

boolean............................................................................................................................................. 29

string ................................................................................................................................................ 30

encryptedString................................................................................................................................30

int .....................................................................................................................................................30

float .................................................................................................................................................. 30

double .............................................................................................................................................. 31

BigDecimal ...................................................................................................................................... 31

date................................................................................................................................................... 31

datetime............................................................................................................................................ 31

time .................................................................................................................................................. 31

timestamp......................................................................................................................................... 31

Default Values ........................................................................................................................................ 32

Document Constraints............................................................................................................................. 32

Document Links...................................................................................................................................... 33

Referential Integrity Constraints............................................................................................................. 35

Overlay Documents ................................................................................................................................36

Flex Properties ........................................................................................................................................ 37

Pre-defined Flex Properties ............................................................................................................. 37

Dynamic Flex Properties ................................................................................................................. 38

4 X-Commands ................................................................................................41

System Commands ................................................................................................................................. 42

GET_RESOURCE_STATS ............................................................................................................43

GET_BUILD_INFO........................................................................................................................ 44

ENABLE/DISABLE/SET_LOG_LEVELS .................................................................................... 44

GET_LOG_LEVELS ......................................................................................................................46

CLEAR_ALL_LOGS ......................................................................................................................47

DROP_CACHE ............................................................................................................................... 47

BROADCAST ................................................................................................................................. 48

SHUT_DOWN ................................................................................................................................49

SET_XSERVICE_PARAM ............................................................................................................50

User Commands...................................................................................................................................... 50

Definition ......................................................................................................................................... 50

request_descriptor..................................................................................................................... 51

Implementation ................................................................................................................................53

Inline the implementation along with the command definition................................................ 54

Provide the implementation separate from the definition ........................................................ 54

Invoking Commands............................................................................................................................... 55Command Envelope......................................................................................................................... 56

REQUESTS.............................................................................................................................. 56

Utilities for Posting Commands ...................................................................................................... 59

................................................................................................................................................................64

5 X-Rules ..........................................................................................................65

Introduction............................................................................................................................................. 65

Variables and Expressions ...................................................................................................................... 67


7/422

Contents

viiAgile Business Process Platform 3 Programmers Reference Revision A

LhsExpression ..................................................................................................................................67

RhsExpression..................................................................................................................................68

Variable Types.........................................................................................................................................69

Local Variables ................................................................................................................................69

Service Variables..............................................................................................................................69

X-Rule Types...........................................................................................................................................69

DEFINE_METHOD.........................................................................................................................69

DEFINE_LISTENER.......................................................................................................................74

DEFINE_IMPLEMENTATION......................................................................................................75

DEFINE_PRE_CREATE.................................................................................................................77

DEFINE_POST_CREATE ..............................................................................................................79

DEFINE_PRE_MODIFY.................................................................................................................80

DEFINE_POST_MODIFY ..............................................................................................................81

DEFINE_INIT ................................................................................................................................81

DEFINE_PRE_SHUTDOWN .........................................................................................................82

DEFINE_POST_SHUTDOWN .......................................................................................................83

X-Rule Components ................................................................................................................................84

Exceptions thrown by Components within X-rules .........................................................................84

X-Rule Components Syntax Notations ............................................................................................85

Condition X-Rule Components ...............................................................................................................87

Simple Condition..............................................................................................................................87

Compound Condition .......................................................................................................................88

Action X-Rule Components ....................................................................................................................88

Core Components .............................................................................................................................89

SET............................................................................................................................................89

PRINT/PRINTLN .....................................................................................................................90

LOG ..........................................................................................................................................91

IF_TEST-THEN-ELSE.............................................................................................................91

IF-THEN-ELSE ........................................................................................................................92

CHOOSE-WHEN-OTHERWISE.............................................................................................94

FOR_EACH-BREAK-CONTINUE .........................................................................................95

REPEAT....................................................................................................................................96

WHILE......................................................................................................................................98

EXIT..........................................................................................................................................99

EXCEPTION ............................................................................................................................99

TRY-CATCH-THROW..........................................................................................................101

HANDLE_SYSTEM_EXCEPTION ......................................................................................103

Command Components ..................................................................................................................104

Data Access Components...............................................................................................................106

CREATE_DOCUMENT_ID ..................................................................................................106

ADD_DOCUMENT ...............................................................................................................106

Query Condition......................................................................................................................109

REMOVE_DOCUMENT .......................................................................................................110

MODIFY_DOCUMENT ........................................................................................................111

SAVE ......................................................................................................................................112

GET_DOCUMENT ................................................................................................................113


8/422

viii Agile Business Process Platform 3 Programmers Reference Revision A

Contents

Expression .............................................................................................................................. 116

ORDER_BY ........................................................................................................................... 118

GROUP_BY ........................................................................................................................... 119

QUERY_DOCUMENT_LINK.............................................................................................. 120

NOT_EXISTS_QDL .............................................................................................................. 121

SELECT + QUERY_DOCUMENT_LINK...........................................................................123

FETCH_DOCUMENT_LINK............................................................................................... 124

SQL_FN .................................................................................................................................125

Scalar Functions .....................................................................................................................128

GET_DOC_CHUNKED ........................................................................................................ 129

PROCESS_GET_DOCUMENT ............................................................................................ 130

EXEC_SQL_QUERY ............................................................................................................ 133

EXEC_LOGICAL_SQL_QUERY......................................................................................... 135

EXEC_SQL_DML ................................................................................................................. 138

EXEC_LOGICAL_SQL_DML.............................................................................................. 139

EXEC_BATCH_SQL_DML.................................................................................................. 140

EXEC_SQL_DDL.................................................................................................................. 141

EXEC_PROC ......................................................................................................................... 141

PROCESS_EXECUTE_SQL_QUERY ................................................................................. 142

XML-Manipulation Components .................................................................................................. 144

SET_PROPS........................................................................................................................... 144

REMOVE_ATTRIBUTE ....................................................................................................... 144

TO_DOCVAR........................................................................................................................ 145

TO_XML................................................................................................................................148

APPEND_TO_XML .............................................................................................................. 149

MAKE_INSTANCE_DOCUMENT......................................................................................151

SET_NAME ........................................................................................................................... 152

SET_TEXT............................................................................................................................. 152

GET_TEXT ............................................................................................................................ 153

SET_CHILD........................................................................................................................... 153

ADD_CHILDREN ................................................................................................................. 154

APPEND_CHILDREN .......................................................................................................... 157

REMOVE_CHILDREN ......................................................................................................... 158

REMOVE_NODES................................................................................................................ 159

DELETE_ALL_CHILDREN .................................................................................................160

COLLATE_XML................................................................................................................... 161

MAP_CREATE......................................................................................................................163

MAP_PUT_ALL .................................................................................................................... 165

MAP_REMOVE.....................................................................................................................166

MAP_CLEAR........................................................................................................................ 166

GROUP_DOCS......................................................................................................................167

MERGE_DOC........................................................................................................................ 169

MERGE_ERRORS_DOC ...................................................................................................... 171

STRING_TO_XML ............................................................................................................... 173

XML_TO_STRING ............................................................................................................... 173

CLONE_XML........................................................................................................................ 174


9/422

Contents

ixAgile Business Process Platform 3 Programmers Reference Revision A

SORT_DOCS..........................................................................................................................174

SORT ......................................................................................................................................178

SET_NAMESPACE ...............................................................................................................179

REMOVE_NAMESPACES ...................................................................................................180

User-Interface Related Components ..............................................................................................181

SET_SESSION .......................................................................................................................181

GET_SESSION.......................................................................................................................181

FORM_SEARCH_FILTER....................................................................................................181

FORM_GET............................................................................................................................184

FORM_REMOVE ..................................................................................................................185

FORM_UPDATE....................................................................................................................187

PAGINATE_LINES ...............................................................................................................189

TAG_ERRORS.......................................................................................................................190

DROP_DOWN_OPTIONS.....................................................................................................192

CREATE_URL .......................................................................................................................193

SET_REDIRECT_URL ..........................................................................................................194

Utility Components ........................................................................................................................194

EXECUTE_SHELL_COMMAND.........................................................................................194

EXEC_INFORMATICA ........................................................................................................196

LOAD_XML_FILE ................................................................................................................197

STORE_XML_FILE...............................................................................................................197

PRINT_TO_FILE ...................................................................................................................198

GET_CURRENT_TIME ........................................................................................................199

SET_LOGICAL_DATE .........................................................................................................199

DO_TRANSACTION.............................................................................................................199

REFRESH_FROM_CACHE ..................................................................................................200

NATIVE_FUNCTION............................................................................................................201

INSTANCE_METHOD..........................................................................................................201

POST.......................................................................................................................................202

POST_STRING ......................................................................................................................202

SLEEP.....................................................................................................................................202

TIMING_MARKER...............................................................................................................203

Framework Specification Components ..........................................................................................204

6 X-Path ......................................................................................................... 205

Introduction ...........................................................................................................................................205

X-Path Basics ........................................................................................................................................206

Selecting a node .............................................................................................................................207Selecting the value of a node..........................................................................................................207

Selecting a list of nodes..................................................................................................................207

Selecting a list of nodes based on a condition................................................................................209

Support for xml with namespaces ..................................................................................................210

Boolean X-Path Expressions .................................................................................................................211

Mathematical X-Path Expressions ........................................................................................................213

Node-Set Functions ...............................................................................................................................214

position ...........................................................................................................................................215


10/422

x Agile Business Process Platform 3 Programmers Reference Revision A

Contents

count .............................................................................................................................................. 215

name............................................................................................................................................... 216

String Functions .................................................................................................................................... 216

string .............................................................................................................................................. 217

concat............................................................................................................................................. 218

strlen .............................................................................................................................................. 218

starts-with ...................................................................................................................................... 219

subString ........................................................................................................................................ 219

substringBefore.............................................................................................................................. 219

substringAfter................................................................................................................................220

normalize-space ............................................................................................................................. 220

trim................................................................................................................................................. 220

upperCase ...................................................................................................................................... 221

lowerCase ...................................................................................................................................... 221

contains ..........................................................................................................................................221

containsToken................................................................................................................................222

stringTokenToXml ........................................................................................................................ 222

Boolean Functions ................................................................................................................................223

true() .............................................................................................................................................. 223

false() ............................................................................................................................................. 223

boolean...........................................................................................................................................223

Number Functions.................................................................................................................................224

int ................................................................................................................................................... 225

float ................................................................................................................................................ 225

double ............................................................................................................................................225

absolute ..........................................................................................................................................226

minDouble ..................................................................................................................................... 226

maxDouble..................................................................................................................................... 226

sum................................................................................................................................................. 227

Arithmetic Functions ............................................................................................................................ 227

+ ..................................................................................................................................................... 227

- ......................................................................................................................................................228

mul ................................................................................................................................................. 228

div .................................................................................................................................................. 228

mod ................................................................................................................................................ 229

ceiling ............................................................................................................................................229

floor................................................................................................................................................ 229

power............................................................................................................................................. 229

roundWithPrecision ....................................................................................................................... 230

Comparison Functions .......................................................................................................................... 230

< ..................................................................................................................................................... 230

> ..................................................................................................................................................... 231

=................................................................................................................................................... 232

= ..................................................................................................................................................... 232

!=.................................................................................................................................................... 233


11/422

Contents

xiAgile Business Process Platform 3 Programmers Reference Revision A

and ..................................................................................................................................................233

or.....................................................................................................................................................233

stateCompare..................................................................................................................................234

XMLform & Core Functions.................................................................................................................234

text..................................................................................................................................................235

getId................................................................................................................................................235

sort..................................................................................................................................................235

collate .............................................................................................................................................236

clone ...............................................................................................................................................237

transform ........................................................................................................................................237

docMinus........................................................................................................................................238

docDiff...........................................................................................................................................239

ifElse...............................................................................................................................................240

stringToXml ...................................................................................................................................240

listGet .............................................................................................................................................241

listUnion .........................................................................................................................................241

findProp..........................................................................................................................................241

key ..................................................................................................................................................242

mapGet ...........................................................................................................................................242

mapContainsKey ............................................................................................................................244

Time Functions......................................................................................................................................244

date .................................................................................................................................................245

date() .......................................................................................................................................245

date(string)............................................................................................................................245

date(year,month,day) ..............................................................................................................246

date(year, month, day, hour, minute, second) .........................................................................247

getYear...........................................................................................................................................247

getYear() .................................................................................................................................247

getYear(date-string) ................................................................................................................248

getYear(date-object)................................................................................................................248

getMonth ........................................................................................................................................248

getMonth() ..............................................................................................................................248

getMonth(date-string) .............................................................................................................249

getMonth(date-object).............................................................................................................249

getDay ............................................................................................................................................249

getDay() ..................................................................................................................................249

getDay(date-string) .................................................................................................................250

getDay(date-object).................................................................................................................250

getHour...........................................................................................................................................250

getHour().................................................................................................................................250

getHour(date-string)................................................................................................................251

getHour(date-object) ...............................................................................................................251

getMinute .......................................................................................................................................251

getMinute()..............................................................................................................................252

getMinute(date-string) ............................................................................................................252

getMinute(date-object)............................................................................................................252


12/422

xii Agile Business Process Platform 3 Programmers Reference Revision A

Contents

getSecond....................................................................................................................................... 252

getSecond()............................................................................................................................. 253

getSecond(date-string)............................................................................................................ 253

getSecond(date-object) ...........................................................................................................253

duration ..........................................................................................................................................253

dstDuration .................................................................................................................................... 254

incrDate..........................................................................................................................................255

datediff...........................................................................................................................................256

minDate..........................................................................................................................................256

maxDate......................................................................................................................................... 256

stripTime........................................................................................................................................ 257

incrDateByDays............................................................................................................................. 259

parseDate ....................................................................................................................................... 259

Java's SimpleDateFormat......................................................................................................................259

Miscellaneous Functions....................................................................................................................... 262

getFirstDoc .................................................................................................................................... 263

getDocument.................................................................................................................................. 264

request............................................................................................................................................265

isEmpty ..........................................................................................................................................266

isDataType..................................................................................................................................... 266

isValidValue .................................................................................................................................. 267

getDBInfo ...................................................................................................................................... 268

getWorkingDirectory.....................................................................................................................268

system-property ............................................................................................................................. 268

buildSqlParamStr........................................................................................................................... 269

convertToDBType ......................................................................................................................... 269

Java Functions....................................................................................................................................... 270

nativeFunction ............................................................................................................................... 270

instanceFunction ............................................................................................................................ 271

instanceMethod.............................................................................................................................. 272

7 X-Config.......................................................................................................275

Topics: .................................................................................................................................................. 275

Introduction...........................................................................................................................................275

Service Configuration ........................................................................................................................... 276

Service Config ............................................................................................................................... 276

Register Handlers........................................................................................................................... 277

Extension Files .............................................................................................................................. 278X-Path Functions ........................................................................................................................... 279

Document Definition Files ............................................................................................................ 279

Rule Definition Files .....................................................................................................................280

Event Definition Files.................................................................................................................... 280

Validation Spec Files .....................................................................................................................280

Workflow....................................................................................................................................... 281

Export Definition Files .................................................................................................................. 282

Purge Definition Files.................................................................................................................... 282


13/422

Contents

xiiiAgile Business Process Platform 3 Programmers Reference Revision A

DBLock Specification Files ..........................................................................................................282

State Model Files...........................................................................................................................283

Search Definition Files..................................................................................................................283

Audit Trail Definition Files............................................................................................................284

IdGen Configuration ......................................................................................................................284

Service Parameters .........................................................................................................................285

Logger............................................................................................................................................287

CisTagNameMapping ....................................................................................................................290

SqlScriptFiles .................................................................................................................................290

SemanticValidation ........................................................................................................................290

Server Configuration .............................................................................................................................292

Locator Configuration ....................................................................................................................292

Protocols.........................................................................................................................................293

Client Configuration.......................................................................................................................293

App Server Configuration ..............................................................................................................294

Database Configuration..................................................................................................................294

JMS Configuration .........................................................................................................................296

Server Configuration ......................................................................................................................298

Schema Generation ........................................................................................................................299

Encryption Configuration...............................................................................................................300

Command Line Input .....................................................................................................................301

Enable JMS ....................................................................................................................................301

Logical Date ...................................................................................................................................301

WSDL Generation..........................................................................................................................301

WSDL Client Configuration ..........................................................................................................302

Cis Client Config............................................................................................................................303

CIS Generation...............................................................................................................................304

X-Server Parameters ......................................................................................................................304

Services Override Configuration....................................................................................................305

8 Workflow Concepts ................................................................................... 307

Generic Event Node ..............................................................................................................................308

Workflow Execution .............................................................................................................................308

Variables................................................................................................................................................308

Node Input & Output variables: .....................................................................................................308

Implicit Variables ...........................................................................................................................309

Pipeline Variables ..........................................................................................................................309

Workflow Properties .............................................................................................................................310Workflow Nodes ...................................................................................................................................313

Start Node ....................................................................................................................................313

Task Node ..................................................................................................................................315

Event Node ...................................................................................................................................316

Decision Node ..............................................................................................................................320

Branch Node ..................................................................................................................................322

Subworkflow Node .......................................................................................................................323

Timer Node .................................................................................................................................326


14/422

xiv Agile Business Process Platform 3 Programmers Reference Revision A

Contents

OR Node ...................................................................................................................................... 328

AND Node .................................................................................................................................... 328

Asynch Task Node......................................................................................................................... 329

Wsdl Node .................................................................................................................................. 332

UI Node ........................................................................................................................................ 338

Search Node .................................................................................................................................. 344

Serial/Parallel/Multi-Line Approval Nodes................................................................................... 352

Wait/Launch Process, Load SQL File, Execute SQL Procedure, FTP Files, Notification Nodes 352

Table Editor Component .............................................................................................................. 352

Adding a Record.....................................................................................................................355

Copying a Record ................................................................................................................... 356

Editing a Record .....................................................................................................................356

Deleting a Record ................................................................................................................... 356

Select and Return.................................................................................................................... 357

Mass Update ........................................................................................................................... 357

Clearing changes made...........................................................................................................357

Cancel ..................................................................................................................................... 357

Export to Excel ....................................................................................................................... 357

Configure Table......................................................................................................................358

Where Used ............................................................................................................................ 358

Advanced Filters.....................................................................................................................358

Add to Favorite....................................................................................................................... 358

Close and Refresh Node ............................................................................................................... 358

Master Details Node Configuration............................................................................................... 359

Pivot Node Configuration.............................................................................................................. 364

Workflow Commands........................................................................................................................... 369

START_WORKFLOW ................................................................................................................. 370

KILL_WORKFLOWS .................................................................................................................. 371

CANCEL_EVENT ........................................................................................................................ 373

CANCEL_NODE .......................................................................................................................... 373

Workflow Logging ............................................................................................................................... 374

Workflow Monitoring UI (Reference Implementation): ........................................................ 375

A Guide for Gathering Information on Hangs & Crashes...........................379

Server Hangs......................................................................................................................................... 379

Basic information........................................................................................................................... 379

Memory & CPU Information......................................................................................................... 379

Windows.................................................................................................................................380Unix ........................................................................................................................................ 380

Solaris ..................................................................................................................................... 380

HP...........................................................................................................................................380

AIX......................................................................................................................................... 381

Log files ......................................................................................................................................... 382

Xserver Logs .......................................................................................................................... 382

Weblogic logs......................................................................................................................... 383

Resource Stats of the Xserver........................................................................................................ 384


15/422

Contents

xvAgile Business Process Platform 3 Programmers Reference Revision A

Thread Dumps ................................................................................................................................384

Windows .................................................................................................................................384

Unix.........................................................................................................................................385

Solaris......................................................................................................................................385

HP............................................................................................................................................386

AIX..........................................................................................................................................386

System backup................................................................................................................................388

Steps to Replicate ...........................................................................................................................389

Server Crashes .......................................................................................................................................389

Basic information ...........................................................................................................................389

Log files..........................................................................................................................................389

System backup................................................................................................................................389

Steps to Replicate ...........................................................................................................................389

The Core file...................................................................................................................................389

Windows .................................................................................................................................390

Unix.........................................................................................................................................390

Solaris......................................................................................................................................390

HP............................................................................................................................................390

AIX..........................................................................................................................................390

B System Tables............................................................................................ 393

Maintenance of System Tables..............................................................................................................393

Details on System Tables ......................................................................................................................393

Encryption ......................................................................................................................................393

Export .............................................................................................................................................393

ID Generation.................................................................................................................................394

DB Locking ....................................................................................................................................394

Purge...............................................................................................................................................394

Workflow .......................................................................................................................................394

Index ........................................................................................................... 397


16/422

xvi Agile Business Process Platform 3 Programmers Reference Revision A

Contents


17/422

xviiAgile Business Process Platform 3 Programmers Reference Revision A

Preface

Welcome to i2 Agile Business Process Platform 3 Programmers Reference. It provides

the transactional framework for building business workflows by defining the

documents in the workflow using X-Docs, and expressing the logic that operates on

these documents using X-Rules. This framework enables the definition of workflows

in a configurable manner with very little programming effort.

About i2 Agile Business Process Platform 3

Programmers Reference

Current businesses more so than ever before, are experiencing tremendous

competitive pressures and changes. Business processes are being outsourced rapidly

and new alliances, partnerships and mergers are happening at a tremendous pace. In

this highly volatile environment the IT and data management systems are beingstretched to their limit. Most of them have been built with a fixed business process in

mind and are inflexible to the kind of change that they are being subject to in todays

economy. Under these circumstances companies are looking for a solution that would

have the following capabilities:

z An architecture that would allow leveraging existing legacy systems till the time

when they can be replaced or enhanced

z An architecture that would allow rapid prototyping of business ideas to see the

end result in days and months rather than years

z An architecture that allows a business user to be able to define and adjust process

flows more rapidly rather than having to depend on tech savvy people

z An architecture that can string multiple disparate applications to provide a

business process flow rather than having to rewrite all the individual applications

on a single technology or with a single vendor.

z An architecture that provides for data synchronization and data harmonization

across the myriad of systems that are in place

i2s Agile Business Process Platform (ABPP) has been built with the above mentioned

objectives in mind. It enables a business user to interact with the system at a business

abstraction through a graphical integrated development environment and an intuitive


18/422

Preface

xviii Agile Business Process Platform 3 Programmers Reference Revision A

scripting language to express business rules. It provides several pre-built constructs

(such as Approval nodes, Data Upload, Data Profiling, etc) that allow a user to

quickly prototype a business process without having to worry about the nitty-gritty

associated with generic application building software. It also allows a user to define

all aspects of an application in one single environment starting from data model

definition, process workflows, business rules and validations all the way to userinterface design and integration design.

For information on other i2 solutions, contact your i2 sales representative.


19/422

Preface

xixAgile Business Process Platform 3 Programmers Reference Revision A

About this Book

This book is intended to serve as a detailed reference guide on Agile Business Process

Platform (ABPP).

Target AudienceThis book is intended for SCOS i2 Application users.

What You Should Know

You must also have basic knowledge about business scenarios.

What This Book Contains

This book has the following chapters.

z Chapter 1Introduction on page 1. It gives an introduction to the ABPP

framework.z Chapter 3X-Documents on page 25. Explains the various properties of an X-

Doc and its relational structure.

z Chapter 4X-Commands on page 41. It discusses the input and output XML

documents commands.

z Chapter 5X-Rules on page 65. It discusses how business workflows can be

written in ABPP using sets of conditions and the corresponding actions (called X-

Rules).

z Chapter 6X-Path on page 205. It discusses how X-Rules are expressed

uniformly using an XML specification called X-Path.

z Chapter 7X-Config on page 275. This section explains the various parametersthat can be configured which define the behavior of an X-Service.

z Chapter 8Workflow Concepts on page 307. Explains the business process

workflows that enables to model a business process in ABPP.

Conventions

Table 1 lists examples of the typographic conventions used to display different types

of information in this document.
http://-/?-http://-/?-


20/422

Preface

xx Agile Business Process Platform 3 Programmers Reference Revision A

Table 1 Typographic conventions used in this document

Any of the following types of notes may appear in this book:

Note: This kind of note contains information that is useful or interesting but not

essential to an understanding of the main text.

CAUTION: This kind of note contains instructions that are especially important to

follow for proper functioning of the product.

WARNING! This kind of note contains instructions that must be followed to avoid

potential crashes or loss of data.

Item Example Explanation

Code Call NotifyPending; File names, executable code,commands, and configuration

statements are shown in monospaced

font.

Class Names Make the Class Configurations

pointer in the Module

Configuration class a primary

key.

Class names appear in bold.

Interface element ClickOrganization Management

in the toolbar.

Button names, field names, window

names are shown in a san-serif font.

Pathname C:\i261\webdriver

or

/i261/webdriver

Windows pathnames are shown in

monospaced font, with backslash path

separators.Unix pathnames are shown with

forward-slash path separators.

Meta-variable i2_Home\webdriver

or

i2_Home/webdriver

Portions of code that you replace with

specific values are shown in italic

monospaced font.

Documentation or

book names.

SCOS Installation Guide Document or book names referenced

in this book are shown in italics.


21/422

Preface

xxiAgile Business Process Platform 3 Programmers Reference Revision A

Related Documentation

For more information about i2 ABPP, refer to the following in the documentation set:

z Agile Business Process Platform (ABPP) 3 Release Notes

| [ABPP3_RelNotes_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Studio User Guide

| [ABPP3_Studio_UserGuide_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Manufacturing User Guide

| [ABPP3_Manufacturing_UserGuide_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Programmers Reference

| [ABPP3_Programmer_Reference_Part2_6.2.8.pdf]

| [ABPP3_Programmer_Reference_Part3_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Best Practices

| [ABPP3_BestPractices_6.2.8.pdf]z Agile Business Process Platform (ABPP) 3 Install Guide

| [ABPP3_Install_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Deployment Guide

| [ABPP3_DeploymentGuide_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 How To Guide

| [ABPP3_HowTo_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Manufacturing Admin Guide

| [ABPP3_Manufacturing_AdminGuide_6.2.8.pdf[

z Agile Business Process Platform (ABPP) 3 Performance Tuning Guide

| [ABPP3_PerformanceTuning_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Authentication and Authorization

Guide

| [ABPP3_Authentication_Authorization_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Frequently Asked Questions

| [ABPP3_FAQs_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 Monitoring Guide

| [ABPP3_Monitoring_Guide_6.2.8.pdf]

z Agile Business Process Platform (ABPP) 3 PGL Internationalization Guide

| [ABPP3_PGL_Internationalization_6.2.8.pdf]

To Read Documentation

To read the .pdf files, you must have Adobe Acrobat Reader, version 4.0 or higher.

If you do not have Acrobat Reader on your machine, you can download it from

Adobes Web site at http://www.adobe.com.
http://www.adobe.com/http://www.adobe.com/http://www.adobe.com/


22/422

Preface

xxii Agile Business Process Platform 3 Programmers Reference Revision A

To read the Help files, you must have one of the following browsers:

z Internet Explorer, version 5.0 or higher. You can download this software from the

Microsoft Web site at http://www.microsoft.com/.

z Netscape, version 4.0 or higher. You can download this software from the

Netscape Web site at http://home.netscape.com/.

If You Need Assistance

Customer support is available at the i2 Customer Support Web site (http://

support.i2.com), where you can:

z Request shipment of software.

z Request product license keys.

z Download software documentation.

z Submit new issues or cases.

z Track the status of current issues or cases.

To Obtain Licenses

To obtain licenses for i2 and third-party products, go to http://support.i2.com, and log

on. On the Contents list, expand Cases Menu, and then clickRequest LicenseKey.

Alternatively, you can request licenses by email, but the Web site provides priority

service.

To Contact Customer Support

To contact Customer Support, use one of the following options

Give Us Feedback

We value your comments and suggestions about our documentation. If you have

comments about this book or the online Help, please enter them in the Comments and

Feedback section of the i2 Customer Support Web page. We will use your feedback in

our plans to improve i2 documentation.

Internet Web site: http://support.i2.com

Email: [email protected]

Phone: US and Canada: 1.469.357.3456

EMEA: 32.2.717.66.77

APAC: +91.80.30288888

Japan: 81.3.6409.1212

Australia: 61.3.9832.7654
http://www.microsoft.com/http://home.netscape.com/http://support.i2.com/http://support.i2.com/http://support.i2.com/http://support.i2.com/http://support.i2.com/http://support.i2.com/http://support.i2.com/http://support.i2.com/http://home.netscape.com/http://www.microsoft.com/http://support.i2.com/


23/422

Preface

xxiiiAgile Business Process Platform 3 Programmers Reference Revision A

For the Latest Documentation

For the latest versions of any documentation, go to the i2 Customer Support Web page

(http://support.i2.com). From the Documentationlink underQuickMenu, you can

download the most recent version of the product documentation.
http://support.i2.com/http://support.i2.com/

8/14/2019 Programmers R