PeopleTools 8.

61: PeopleCode API

Reference

July 2024
PeopleTools 8.61: PeopleCode API Reference
Copyright © 1988, 2024, Oracle and/or its affiliates.

This software and related documentation are provided under a license agreement containing restrictions on use and
disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement
or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute,
exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or
decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you
find any errors, please report them to us in writing.

If this is software, software documentation, data (as defined in the Federal Acquisition Regulation), or related
documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government,
then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software,
any programs embedded, installed, or activated on delivered hardware, and modifications of such programs) and
Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users
are "commercial computer software," "commercial computer software documentation," or "limited rights data"
pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works,
and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs
embedded, installed, or activated on delivered hardware, and modifications of such programs), ii) Oracle computer
documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained
in the applicable contract. The terms governing the U.S. Government's use of Oracle cloud services are defined by
the applicable contract for such services. No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications. It is
not developed or intended for use in any inherently dangerous applications, including applications that may create a
risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible
to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation
and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous
applications.

Oracle®, Java, MySQL, and NetSuite are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.

Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used
under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD
logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The
Open Group.

This software or hardware and documentation may provide access to or information about content, products, and
services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all
warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an
applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any
loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as
set forth in an applicable agreement between you and Oracle.

Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program
website at https://docs.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle
Support. For information, visit https://docs.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit https://
docs.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.
Contents
Preface: Preface....................................................................................................................................cxxvii
Understanding the PeopleSoft Online Help and PeopleBooks.......................................................cxxvii
Hosted PeopleSoft Online Help............................................................................................... cxxvii
Locally Installed PeopleSoft Online Help............................................................................... cxxvii
Downloadable PeopleBook PDF Files.....................................................................................cxxvii
Common Help Documentation.................................................................................................cxxvii
Field and Control Definitions................................................................................................. cxxviii
Typographical Conventions..................................................................................................... cxxviii
ISO Country and Currency Codes............................................................................................ cxxix
Region and Industry Identifiers.................................................................................................cxxix
Translations and Embedded Help...............................................................................................cxxx
Using and Managing the PeopleSoft Online Help........................................................................... cxxx
PeopleTools Related Links................................................................................................................cxxx
Contact Us......................................................................................................................................... cxxx
Follow Us......................................................................................................................................... cxxxi
Chapter 1: Activity Guide Classes......................................................................................................... 133
Understanding the Activity Guide Classes.........................................................................................133
Importing Activity Guide Classes...................................................................................................... 133
Activity Guide Classes Reference...................................................................................................... 133
List Class.............................................................................................................................................134
List Class Methods............................................................................................................................. 134
createInstance................................................................................................................................134
getActionItems.............................................................................................................................. 136
GetContext.................................................................................................................................... 136
getMembers...................................................................................................................................137
GetPgltBtn.....................................................................................................................................137
getRootItems................................................................................................................................. 137
new................................................................................................................................................ 138
open...............................................................................................................................................139
save............................................................................................................................................... 139
SaveContext.................................................................................................................................. 140
saveMembers................................................................................................................................ 140
SavePgltBtn...................................................................................................................................141
List Class Properties........................................................................................................................... 141
AppClassID...................................................................................................................................141
AppClassMethod...........................................................................................................................142
DescrLong.....................................................................................................................................142
Field1............................................................................................................................................ 142
Field10.......................................................................................................................................... 143
Field2............................................................................................................................................ 143
Field3............................................................................................................................................ 143
Field4............................................................................................................................................ 143
Field5............................................................................................................................................ 144
Field6............................................................................................................................................ 144
Field7............................................................................................................................................ 144
Field8............................................................................................................................................ 144

Copyright © 1988, 2024, Oracle and/or its affiliates. iii

Contents

Field9............................................................................................................................................ 145
HomeUrl....................................................................................................................................... 145
isActive......................................................................................................................................... 145
IsTemplate.....................................................................................................................................145
Label............................................................................................................................................. 146
ListId............................................................................................................................................. 146
PackageRoot..................................................................................................................................146
ParentTemplate..............................................................................................................................147
pgltAppClass.................................................................................................................................147
pgltPackageRoot........................................................................................................................... 147
pgltProgressBarVisible..................................................................................................................148
pgltQualifyPath............................................................................................................................. 148
QualifyPath................................................................................................................................... 148
Status.............................................................................................................................................149
ActionItem Class.................................................................................................................................149
ActionItem Class Methods..................................................................................................................150
delete............................................................................................................................................. 150
getAssignments............................................................................................................................. 150
new................................................................................................................................................ 151
nextAction.....................................................................................................................................152
open...............................................................................................................................................152
prevAction.....................................................................................................................................153
save............................................................................................................................................... 153
saveAssignments...........................................................................................................................154
ActionItem Class Properties............................................................................................................... 155
AppClassID...................................................................................................................................155
AssignedToOprid.......................................................................................................................... 155
AssignType....................................................................................................................................155
CurrentStep................................................................................................................................... 156
DescrLong.....................................................................................................................................156
DueDate........................................................................................................................................ 156
DueTm.......................................................................................................................................... 156
EndDttm........................................................................................................................................ 157
Field1............................................................................................................................................ 157
Field10.......................................................................................................................................... 157
Field2............................................................................................................................................ 157
Field3............................................................................................................................................ 158
Field4............................................................................................................................................ 158
Field5............................................................................................................................................ 158
Field6............................................................................................................................................ 158
Field7............................................................................................................................................ 159
Field8............................................................................................................................................ 159
Field9............................................................................................................................................ 159
ItemId............................................................................................................................................ 159
Label............................................................................................................................................. 160
ListId............................................................................................................................................. 160
PackageRoot..................................................................................................................................160
ParentId......................................................................................................................................... 161
PercCompl.....................................................................................................................................161
Priority.......................................................................................................................................... 161
QualifyPath................................................................................................................................... 161

iv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Remarks........................................................................................................................................ 162
Required........................................................................................................................................ 162
Sequence....................................................................................................................................... 162
ServiceId....................................................................................................................................... 163
StartDt........................................................................................................................................... 163
StartTm......................................................................................................................................... 163
Status.............................................................................................................................................163
Summary....................................................................................................................................... 164
Type...............................................................................................................................................164
ActionItemAssignments Class............................................................................................................ 165
ActionItemAssignments Class Methods............................................................................................. 165
IsEqual.......................................................................................................................................... 165
ActionItemAssignments Class Properties...........................................................................................166
AssignType....................................................................................................................................166
AssignValue.................................................................................................................................. 166
Member Class......................................................................................................................................166
Member Class Methods...................................................................................................................... 167
IsEqual.......................................................................................................................................... 167
Member......................................................................................................................................... 167
Member Class Properties.................................................................................................................... 168
Name............................................................................................................................................. 168
PrivilegeSetID...............................................................................................................................168
Type...............................................................................................................................................169
ContextData Class...............................................................................................................................169
ContextData Class Methods................................................................................................................169
ContextData.................................................................................................................................. 170
IsEqual.......................................................................................................................................... 170
ContextData Class Properties............................................................................................................. 171
ctxKey........................................................................................................................................... 171
ctxVisible...................................................................................................................................... 171
fieldname.......................................................................................................................................171
keyLabel........................................................................................................................................172
keyValue........................................................................................................................................172
recname......................................................................................................................................... 172
Chapter 2: AESection Class....................................................................................................................173
Understanding the AESection Class...................................................................................................173
How an AESection is Accessed......................................................................................................... 174
AESection Example............................................................................................................................ 175
Data Type of an AESection Object.................................................................................................... 176
Scope of an AESection Object........................................................................................................... 176
AESection Class Built-in Function.....................................................................................................177
AESection Class Methods.................................................................................................................. 177
AddStep.........................................................................................................................................177
Close............................................................................................................................................. 178
Open.............................................................................................................................................. 178
Save...............................................................................................................................................180
SetSQL.......................................................................................................................................... 180
SetTemplate...................................................................................................................................181
AESection Class Property...................................................................................................................182
IsOpen........................................................................................................................................... 182
Chapter 3: Analytic Calculation Engine Classes..................................................................................183

Copyright © 1988, 2024, Oracle and/or its affiliates. v

Contents

Understanding the Analytic Calculation Engine Classes................................................................... 183

Using the Analytic Calculation Engine Classes with Application Engine...................................183
Running Synchronously...................................................................................................................... 184
Using Trees......................................................................................................................................... 184
Error Handling.................................................................................................................................... 185
Data Types for Analytic Calculation Engine Classes.........................................................................185
Scope of Analytic Calculation Engine Classes.................................................................................. 185
Analytic Calculation Engine Classes Built-in Functions................................................................... 186
AnalyticInstance Class Methods.........................................................................................................186
CheckAsyncStatus........................................................................................................................ 186
CheckStatus...................................................................................................................................187
Copy.............................................................................................................................................. 188
Delete............................................................................................................................................ 189
GetAnalyticModel.........................................................................................................................189
Load.............................................................................................................................................. 190
RunAsync......................................................................................................................................192
RunSync........................................................................................................................................ 192
Terminate...................................................................................................................................... 193
Unload...........................................................................................................................................193
AnalyticInstance Class Properties.......................................................................................................194
AnalyticType.................................................................................................................................194
ID.................................................................................................................................................. 194
Messages....................................................................................................................................... 194
AnalyticModel Class Methods............................................................................................................195
AddMember.................................................................................................................................. 195
AttachTree.....................................................................................................................................195
CalculateCube............................................................................................................................... 197
DetachTree.................................................................................................................................... 198
GetCubeCollection........................................................................................................................199
GetCellProperties.......................................................................................................................... 199
GetMembers..................................................................................................................................200
GetTree..........................................................................................................................................202
Recalculate.................................................................................................................................... 203
RenameMember............................................................................................................................ 203
AnalyticModel Class Property............................................................................................................204
Messages....................................................................................................................................... 204
CubeCollection Class.......................................................................................................................... 205
CubeCollection Class Methods...........................................................................................................205
CollapseNode................................................................................................................................ 205
DrillIntoNode................................................................................................................................ 206
DrillOutOfNode............................................................................................................................ 206
ExpandNode..................................................................................................................................207
GetData......................................................................................................................................... 208
GetDimFilter................................................................................................................................. 209
GetDimSort................................................................................................................................... 210
GetLayout......................................................................................................................................211
GetRowCount............................................................................................................................... 211
GetSlice.........................................................................................................................................212
SetData.......................................................................................................................................... 212
SetDimensionOrder.......................................................................................................................213
SetDimFilter..................................................................................................................................214

vi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

SetDimSort....................................................................................................................................214
SetSlice..........................................................................................................................................215
ShowHierarchy..............................................................................................................................216
UnsetDimFilter..............................................................................................................................217
UnsetDimSort............................................................................................................................... 218
CubeCollection Class Property........................................................................................................... 218
Messages....................................................................................................................................... 218
Chapter 4: Analytic Calculation Engine Metadata Classes................................................................ 221
Understanding the PeopleSoft Analytic Calculation Engine Metadata Classes................................. 221
Using the Analytic Calculation Engine Metadata Classes................................................................. 221
Inserting and Deleting Objects.....................................................................................................222
Building a Rule as an Object.......................................................................................................222
Error Handling.................................................................................................................................... 223
Data Types of the Analytic Calculation Engine Metadata Objects.................................................... 223
Scope of Analytic Calculation Engine Metadata Objects.................................................................. 223
How to Import the Analytic Calculation Engine Metadata Classes................................................... 223
How to Create an Analytic Calculation Engine Metadata Class Object............................................ 224
Analytic Calculation Engine Metadata Classes Constructor.............................................................. 225
AnalyticModelDefn...................................................................................................................... 225
AnalyticModelDefn Class................................................................................................................... 226
AnalyticModelDefn Class Methods....................................................................................................226
AddCube....................................................................................................................................... 226
AddCubeCollection.......................................................................................................................227
AddDimension.............................................................................................................................. 227
AddExplicitDimensionSet............................................................................................................ 228
AddOrganizer................................................................................................................................229
AddUserFunction.......................................................................................................................... 229
CopyCube..................................................................................................................................... 230
CopyCubeCollection.....................................................................................................................231
CopyDimension............................................................................................................................ 231
CopyExplicitDimensionSet...........................................................................................................232
CopyTo..........................................................................................................................................233
CopyUserFunction........................................................................................................................ 233
Create............................................................................................................................................ 234
Delete............................................................................................................................................ 235
DeleteCube....................................................................................................................................235
DeleteCubeCollection................................................................................................................... 236
DeleteDimension...........................................................................................................................237
DeleteExplicitDimensionSet.........................................................................................................238
DeleteOrganizer............................................................................................................................ 238
DeleteUserFunction...................................................................................................................... 239
Get.................................................................................................................................................240
GetCube........................................................................................................................................ 240
GetCubeCollection........................................................................................................................241
GetCubeCollectionNames.............................................................................................................242
GetCubeNames............................................................................................................................. 242
GetDimension............................................................................................................................... 243
GetDimensionNames.................................................................................................................... 244
GetExplicitDimensionSet..............................................................................................................244
GetExplicitDimensionSetNames.................................................................................................. 245
GetOrganizer................................................................................................................................. 245

Copyright © 1988, 2024, Oracle and/or its affiliates. vii

Contents

GetOrganizerNames......................................................................................................................246
GetUserFunction........................................................................................................................... 247
GetUserFunctionNames................................................................................................................ 247
Rename..........................................................................................................................................248
RenameCube................................................................................................................................. 249
RenameCubeCollection................................................................................................................ 249
RenameDimension........................................................................................................................ 250
RenameExplicitDimensionSet...................................................................................................... 251
RenameOrganizer..........................................................................................................................252
RenameUserFunction....................................................................................................................252
Save...............................................................................................................................................253
Validate..........................................................................................................................................254
AnalyticModelDefn Properties........................................................................................................... 254
CircularFormulaWarn................................................................................................................... 255
Description.................................................................................................................................... 255
IsValid........................................................................................................................................... 255
LongDescription............................................................................................................................255
MaxDelta.......................................................................................................................................255
MaxIterations................................................................................................................................ 256
Messages....................................................................................................................................... 256
Name............................................................................................................................................. 256
ResolveCircularDeps.................................................................................................................... 257
DimensionDefn Class..........................................................................................................................257
DimensionDefn Class Properties........................................................................................................ 257
AggregateSequence.......................................................................................................................257
AggregationUserFunction.............................................................................................................257
Comments..................................................................................................................................... 258
Name............................................................................................................................................. 258
TotalMemberName....................................................................................................................... 258
ExplicitDimensionSet Class................................................................................................................258
ExplicitDimensionSet Methods...........................................................................................................259
AttachDimension.......................................................................................................................... 259
DetachDimension..........................................................................................................................259
GetDimensionNames.................................................................................................................... 260
ExplicitDimensionSet Properties........................................................................................................ 260
Name............................................................................................................................................. 260
SequenceNumber.......................................................................................................................... 261
CubeDefn Class...................................................................................................................................261
CubeDefn Class Methods................................................................................................................... 261
AttachDimension.......................................................................................................................... 261
DetachDimension..........................................................................................................................262
GetCauses......................................................................................................................................262
GetCircularDeps............................................................................................................................263
GetDimensionAggregate...............................................................................................................264
GetEffects......................................................................................................................................265
GetDimensionNames.................................................................................................................... 265
GetRule......................................................................................................................................... 266
SetDimensionAggregate............................................................................................................... 266
SetRule.......................................................................................................................................... 267
UsesDimension............................................................................................................................. 268
CubeDefn Class Properties................................................................................................................. 268

viii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

CalcAggregates............................................................................................................................. 268
Comments..................................................................................................................................... 268
DimensionCount........................................................................................................................... 269
FormatType................................................................................................................................... 269
IsVirtual.........................................................................................................................................269
Name............................................................................................................................................. 269
ValueDimensionName.................................................................................................................. 270
CubeCollectionDefn Class.................................................................................................................. 270
CubeCollectionDefn Class Methods...................................................................................................270
AttachCube....................................................................................................................................270
DetachCube...................................................................................................................................271
GetAggregateMapping..................................................................................................................272
GetCubeNames............................................................................................................................. 272
GetDimensionNames.................................................................................................................... 273
GetDimSort................................................................................................................................... 273
GetFieldMapping.......................................................................................................................... 274
GetFilter........................................................................................................................................ 275
GetPersistAggregate......................................................................................................................276
SetAggregateMapping.................................................................................................................. 277
SetDimSort....................................................................................................................................277
SetFieldMapping...........................................................................................................................279
SetFilter.........................................................................................................................................279
SetPersistAggregate...................................................................................................................... 280
UsesCube...................................................................................................................................... 281
UsesDimension............................................................................................................................. 282
CubeCollectionDefn Class Properties.................................................................................................282
AggregateRecName...................................................................................................................... 282
Comments..................................................................................................................................... 282
CubeCount.................................................................................................................................... 283
DimensionCount........................................................................................................................... 283
Name............................................................................................................................................. 283
RecordName..................................................................................................................................283
UserFunctionDefn Class..................................................................................................................... 283
UserFunctionDefn Class Methods...................................................................................................... 284
GetRule......................................................................................................................................... 284
SetRule.......................................................................................................................................... 284
UserFunctionDefn Class Properties....................................................................................................285
Comments..................................................................................................................................... 285
Name............................................................................................................................................. 285
OrganizerDefn Class........................................................................................................................... 285
OrganizerDefn Class Methods............................................................................................................ 285
AttachPart......................................................................................................................................286
DetachPart.....................................................................................................................................286
GetPartNames............................................................................................................................... 287
UsesPart........................................................................................................................................ 288
OrganizerDefn Class Properties..........................................................................................................289
Comments..................................................................................................................................... 289
Name............................................................................................................................................. 289
RuleDefn Class....................................................................................................................................289
RuleDefn Class Methods.................................................................................................................... 289
AddRuleExpression...................................................................................................................... 289

Copyright © 1988, 2024, Oracle and/or its affiliates. ix

Contents

GenerateRule.................................................................................................................................290
RuleDefn Class Property.................................................................................................................... 291
RuleString..................................................................................................................................... 291
RuleExpressions Classes..................................................................................................................... 291
Using the Constants Class............................................................................................................292
Assignment Class................................................................................................................................ 292
Assignment Class Method.................................................................................................................. 292
GenerateRule.................................................................................................................................292
Assignment Class Properties.............................................................................................................. 293
Expression.....................................................................................................................................293
Variable......................................................................................................................................... 293
Comparison Class................................................................................................................................293
Comparison Class Method..................................................................................................................294
GenerateRule.................................................................................................................................294
Comparison Class Properties.............................................................................................................. 295
Operand1.......................................................................................................................................295
Operand2.......................................................................................................................................295
Type...............................................................................................................................................295
Constant Class.....................................................................................................................................296
Constant Class Method....................................................................................................................... 297
GenerateRule.................................................................................................................................297
Constant Class Properties................................................................................................................... 297
Type...............................................................................................................................................298
Value............................................................................................................................................. 298
Constants Class................................................................................................................................... 298
Cube Class...........................................................................................................................................298
Cube Class Methods........................................................................................................................... 299
AddIndex.......................................................................................................................................299
GenerateRule.................................................................................................................................299
GetIndexes.................................................................................................................................... 300
Cube Class Property........................................................................................................................... 300
Name............................................................................................................................................. 300
ExpressionBlock Class........................................................................................................................300
ExpressionBlock Methods.................................................................................................................. 301
AddRuleExpression...................................................................................................................... 301
GetRuleExpressions...................................................................................................................... 301
FunctionCall Class.............................................................................................................................. 302
FunctionCall Class Methods............................................................................................................... 306
AddArgument................................................................................................................................306
GenerateRule.................................................................................................................................306
GetArguments............................................................................................................................... 307
FunctionCall Class Properties.............................................................................................................307
Name............................................................................................................................................. 307
Type...............................................................................................................................................308
MemberReference Class..................................................................................................................... 308
MemberReference Class Method........................................................................................................308
GenerateRule.................................................................................................................................308
MemberReference Class Properties.................................................................................................... 309
Dimension..................................................................................................................................... 309
Member......................................................................................................................................... 309
Operation Class................................................................................................................................... 309

x Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Operation Class Method..................................................................................................................... 310

GenerateRule.................................................................................................................................310
Operation Class Properties..................................................................................................................311
Operand1.......................................................................................................................................311
Operand2.......................................................................................................................................311
Type...............................................................................................................................................311
Variable Class......................................................................................................................................312
Variable Class Method........................................................................................................................ 312
GenerateRule.................................................................................................................................312
Variable Class Properties.................................................................................................................... 313
Name............................................................................................................................................. 313
Type...............................................................................................................................................313
Analytic Model Metadata Classes Examples..................................................................................... 314
Creating an Analytic Model Code Example................................................................................ 314
Chapter 5: Analytic Grid Classes.......................................................................................................... 317
Understanding the Analytic Calculation Engine Classes................................................................... 317
Using the Analytic Grid in PeopleCode.............................................................................................317
Using Freeze Column Mode...............................................................................................................318
Error Handling.................................................................................................................................... 319
Data Types of the Analytic Grid Objects...........................................................................................319
Scope of Analytic Grid Objects......................................................................................................... 319
AnalyticGrid Class Reference.............................................................................................................320
AnalyticGrid Class Built-in Function.................................................................................................320
AnalyticGrid Class Methods...............................................................................................................320
GetColumn.................................................................................................................................... 320
GetCubeCollection........................................................................................................................321
LoadData.......................................................................................................................................321
SetAnalyticInstance...................................................................................................................... 322
SetLayout...................................................................................................................................... 323
AnalyticGrid Class Properties.............................................................................................................323
Inactive..........................................................................................................................................324
Label............................................................................................................................................. 324
ShowGridLines............................................................................................................................. 324
SlicerVisible.................................................................................................................................. 324
SummaryText................................................................................................................................ 325
Chapter 6: Analytic Type Classes.......................................................................................................... 327
Understanding the Analytic Calculation Engine Classes................................................................... 327
Using the Analytic Type Classes........................................................................................................327
Error Handling.................................................................................................................................... 328
Data Types of the Analytic Type Objects.......................................................................................... 328
Scope of Analytic Type Objects.........................................................................................................328
How to Import the Analytic Type Classes......................................................................................... 328
How to Create an Analytic Type Class Object.................................................................................. 329
Analytic Type Classes Constructor.....................................................................................................329
AnalyticTypeDefn......................................................................................................................... 329
AnalyticTypeDefn Class Methods...................................................................................................... 330
AddModel..................................................................................................................................... 330
AddRecord.................................................................................................................................... 331
Create............................................................................................................................................ 332
CopyTo..........................................................................................................................................332
Delete............................................................................................................................................ 333

Copyright © 1988, 2024, Oracle and/or its affiliates. xi

Contents

DeleteModel..................................................................................................................................333
DeleteRecord.................................................................................................................................334
Get.................................................................................................................................................335
GetModel...................................................................................................................................... 335
GetModelNames........................................................................................................................... 336
GetRecord..................................................................................................................................... 336
GetRecordNames.......................................................................................................................... 337
Rename..........................................................................................................................................337
Save...............................................................................................................................................338
AnalyticTypeDefn Class Properties.................................................................................................... 338
AppClassPath................................................................................................................................ 338
Comments..................................................................................................................................... 339
Description.................................................................................................................................... 339
Name............................................................................................................................................. 339
OwnerID....................................................................................................................................... 339
AnalyticTypeModelDefn Class Properties..........................................................................................339
Name............................................................................................................................................. 339
Type...............................................................................................................................................340
AnalyticTypeRecordDefn Class Methods...........................................................................................340
GetSelectedField........................................................................................................................... 340
SetSelectedField............................................................................................................................341
UnsetSelectedField........................................................................................................................341
AnalyticTypeRecordDefn Class Properties........................................................................................ 342
Callback........................................................................................................................................ 342
Description.................................................................................................................................... 342
Name............................................................................................................................................. 342
Readable........................................................................................................................................342
ReadOnce...................................................................................................................................... 343
ScenarioManaged..........................................................................................................................343
SyncOrder..................................................................................................................................... 343
Writeable....................................................................................................................................... 343
AnalyticType Classes Example...........................................................................................................343
Chapter 7: Application Classes.............................................................................................................. 345
Understanding Application Classes.................................................................................................... 345
When Would You Use Application Classes?...............................................................................345
Application Classes General Structure............................................................................................... 346
Class Name................................................................................................................................... 346
Class Extension.............................................................................................................................347
Declaration of Public External Interface......................................................................................348
Access Control and the Declaration of Protected Properties and Methods................................. 349
Declaration of Private Instance Variables and Methods.............................................................. 351
Definition of Methods.................................................................................................................. 352
Declaration of Abstract Methods and Properties......................................................................... 355
Interfaces.......................................................................................................................................356
Constructors.................................................................................................................................. 356
External Function Declarations.................................................................................................... 359
Naming Standards............................................................................................................................... 360
Naming Packages......................................................................................................................... 360
Naming Classes............................................................................................................................ 360
Naming Methods.......................................................................................................................... 360
Naming Properties........................................................................................................................ 360

xii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Import Declarations.............................................................................................................................361
Self-Reference..................................................................................................................................... 362
Using %This with Constructors................................................................................................... 363
Properties and Constants.....................................................................................................................364
Differentiating Between Properties and Methods........................................................................ 364
Overriding Properties................................................................................................................... 365
Using Get and Set with Properties...............................................................................................366
Using Read-Only Properties.........................................................................................................366
Using Methods and Properties for Collections............................................................................ 367
Declaring Constants......................................................................................................................367
Using Variables in Application Classes..............................................................................................367
Placement of Variable Declarations............................................................................................. 367
Declaring Private Instance Variables........................................................................................... 368
Global Variables........................................................................................................................... 368
Overriding Variables and Properties............................................................................................ 368
Superclass Reference.......................................................................................................................... 368
Downcasting........................................................................................................................................ 369
Exception Handling.............................................................................................................................370
Commenting and Documenting Application Classes......................................................................... 371
Understanding Comments and Documentation............................................................................371
Method Header Comments...........................................................................................................372
Class Header Comments.............................................................................................................. 372
Designing Base Classes...................................................................................................................... 373
Base Classes................................................................................................................................. 373
Abstract Base Classes...................................................................................................................373
Generic Base Classes................................................................................................................... 374
Utility Classes...............................................................................................................................374
Declaration of Application Classes.................................................................................................... 374
Declaring Application Classes..................................................................................................... 374
Importing Class Names................................................................................................................ 374
Referencing Superclasses............................................................................................................. 375
Declaring Private Methods...........................................................................................................375
Scope of an Application Class........................................................................................................... 375
Application Classes Built-in Functions and Language Constructs.....................................................375
class...............................................................................................................................................375
get..................................................................................................................................................377
import............................................................................................................................................ 378
interface.........................................................................................................................................379
method...........................................................................................................................................380
property......................................................................................................................................... 381
set.................................................................................................................................................. 381
Chapter 8: Application Data Set Classes.............................................................................................. 383
Understanding the Application Data Set Classes............................................................................... 383
Importing Application Data Set Classes............................................................................................ 384
AdsValidationBase Class.................................................................................................................... 384
AdsValidationBase Class Methods..................................................................................................... 385
AdsValidationBase........................................................................................................................ 385
DoADSValidations........................................................................................................................386
OnPreCopyCompare..................................................................................................................... 387
OnPreUpdate.................................................................................................................................388
OnPostCopy.................................................................................................................................. 389

Copyright © 1988, 2024, Oracle and/or its affiliates. xiii

Contents

ReportErrorModified.................................................................................................................... 392
Chapter 9: Application Services Framework Classes..........................................................................399
ServiceAPI Class.................................................................................................................................399
ServiceAPI Methods........................................................................................................................... 399
getInputParameter......................................................................................................................... 399
getInputRow..................................................................................................................................400
getLocationURL............................................................................................................................401
getOutputContentData.................................................................................................................. 401
getOutputParameter...................................................................................................................... 402
getOutputRow............................................................................................................................... 403
getRequestHeaderValue................................................................................................................ 403
getTemplateParameter...................................................................................................................404
InsertOutputRow...........................................................................................................................405
setInputParameter..........................................................................................................................405
setLocationTemplateParameter..................................................................................................... 406
setOutputParameter.......................................................................................................................407
setOverrideURL............................................................................................................................ 409
setResponseHeader....................................................................................................................... 409
ServiceAPI Properties......................................................................................................................... 410
HttpMethod................................................................................................................................... 410
HttpResponseCode........................................................................................................................410
InputRows..................................................................................................................................... 410
IsChatbot....................................................................................................................................... 411
OutputRows.................................................................................................................................. 411
OverrideResultStateDesc.............................................................................................................. 411
ResponseException....................................................................................................................... 411
ResponseFailed............................................................................................................................. 412
ResultState.................................................................................................................................... 412
RootResource................................................................................................................................ 412
ServiceID...................................................................................................................................... 412
URIIndex.......................................................................................................................................413
UserException...............................................................................................................................413
Chapter 10: API Repository................................................................................................................... 415
Understanding the PeopleSoft API Repository.................................................................................. 415
The PeopleSoft API Repository...................................................................................................415
Example of Accessing the Repository Using PeopleCode.......................................................... 415
Example of Accessing the Repository by Using Visual Basic.................................................... 418
Repository Properties.......................................................................................................................... 420
Bindings........................................................................................................................................ 420
Namespaces...................................................................................................................................420
Bindings Collection Properties........................................................................................................... 420
Count.............................................................................................................................................420
Bindings Collection Methods............................................................................................................. 420
Item............................................................................................................................................... 421
Bindings Properties............................................................................................................................. 421
Name............................................................................................................................................. 421
Bindings Methods............................................................................................................................... 421
Generate........................................................................................................................................ 422
Namespaces Collection Properties......................................................................................................422
Count.............................................................................................................................................422
Namespaces Collection Methods........................................................................................................422

xiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Item............................................................................................................................................... 422
ItemByName................................................................................................................................. 423
Namespaces Properties........................................................................................................................423
Classes...........................................................................................................................................424
Name............................................................................................................................................. 424
Namespaces Methods..........................................................................................................................424
CreateObject..................................................................................................................................424
ClassInfo Collection Properties.......................................................................................................... 424
Count.............................................................................................................................................425
ClassInfo Collection Methods............................................................................................................ 425
Item............................................................................................................................................... 425
ItemByName................................................................................................................................. 426
ClassInfo Properties............................................................................................................................ 426
Documentation.............................................................................................................................. 426
Methods.........................................................................................................................................427
Name............................................................................................................................................. 427
Properties...................................................................................................................................... 427
MethodInfo Collection Properties.......................................................................................................427
Count.............................................................................................................................................427
MethodInfo Collection Methods.........................................................................................................428
Item............................................................................................................................................... 428
ItemByName................................................................................................................................. 428
MethodInfo Properties........................................................................................................................ 429
Arguments.....................................................................................................................................429
Documentation.............................................................................................................................. 429
Name............................................................................................................................................. 430
Type...............................................................................................................................................430
PropertyInfo Collection Properties..................................................................................................... 430
Count.............................................................................................................................................430
PropertyInfo Collection Methods....................................................................................................... 431
Item............................................................................................................................................... 431
ItemByName................................................................................................................................. 431
PropertyInfo Properties....................................................................................................................... 432
Documentation.............................................................................................................................. 432
Name............................................................................................................................................. 432
Type...............................................................................................................................................432
Usage.............................................................................................................................................433
Chapter 11: Array Class......................................................................................................................... 435
Understanding Arrays......................................................................................................................... 435
Creating Arrays................................................................................................................................... 435
Populating an Array............................................................................................................................ 436
Removing Items From an Array.........................................................................................................437
Creating Empty Arrays....................................................................................................................... 438
Creating and Populating Multi-Dimensional Arrays..........................................................................438
Using Flattening and Promotion.........................................................................................................440
Declaring Array Objects..................................................................................................................... 441
Understanding the Scope of an Array Object.................................................................................... 441
Array Class Built-in Functions........................................................................................................... 441
Array Class Methods.......................................................................................................................... 441
Clone............................................................................................................................................. 442
Find............................................................................................................................................... 442

Copyright © 1988, 2024, Oracle and/or its affiliates. xv

Contents

Get.................................................................................................................................................443
Join................................................................................................................................................ 444
Next...............................................................................................................................................446
Pop................................................................................................................................................ 447
Push...............................................................................................................................................449
Replace..........................................................................................................................................450
Reverse..........................................................................................................................................452
Set................................................................................................................................................. 452
Shift...............................................................................................................................................453
Sort................................................................................................................................................ 454
Subarray........................................................................................................................................ 456
Substitute.......................................................................................................................................457
Unshift...........................................................................................................................................458
Array Class Properties........................................................................................................................ 459
Dimension..................................................................................................................................... 459
Len................................................................................................................................................ 459
Chapter 12: BannerTile Class................................................................................................................ 461
BannerTile Class................................................................................................................................. 461
BannerTile Class Methods.................................................................................................................. 461
ApplyVisuals.................................................................................................................................461
BannerTile.....................................................................................................................................462
ClearContextString........................................................................................................................462
DeleteContext................................................................................................................................463
DeleteContextAndUpdate............................................................................................................. 464
DeleteKey......................................................................................................................................464
GetBannerLabel............................................................................................................................ 465
GetContextString.......................................................................................................................... 466
GetGroupletURL...........................................................................................................................466
GetKeyValue................................................................................................................................. 467
IsKeyExist.....................................................................................................................................468
OverrideDefaultProperties............................................................................................................ 468
SetDefaultContext.........................................................................................................................469
SetKeyValue..................................................................................................................................470
UpdateContext.............................................................................................................................. 471
BannerTile Class Properties................................................................................................................471
AnnounceText............................................................................................................................... 471
HomepageId.................................................................................................................................. 472
HomepageName............................................................................................................................472
IsExpanded....................................................................................................................................473
IsPersistContext............................................................................................................................ 473
KeyVals......................................................................................................................................... 474
NodeName.................................................................................................................................... 474
PortalName....................................................................................................................................474
Chapter 13: BI Publisher Classes.......................................................................................................... 475
Understanding BI Publisher and the BI Publisher Classes................................................................ 475
BI Publisher Terms............................................................................................................................. 476
BI Publisher Flow Diagram................................................................................................................476
Error Handling.................................................................................................................................... 477
Data Type and Scope of BI Publisher Objects...................................................................................477
Instantiating BI Publisher Objects......................................................................................................478
Search Operator Values.......................................................................................................................478

xvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

BI Publisher Classes Reference..........................................................................................................479

BI Publisher Report Manager Definition Classes.............................................................................. 479
ReportDefn Class................................................................................................................................ 479
ReportDefn Class Constructor............................................................................................................ 480
ReportDefn....................................................................................................................................480
ReportDefn Class Methods.................................................................................................................480
Close............................................................................................................................................. 480
DisplayOutput............................................................................................................................... 481
EmailOutput.................................................................................................................................. 482
Get.................................................................................................................................................482
GetOutDestFormatString.............................................................................................................. 483
GetPSQueryPromptRecord........................................................................................................... 484
PrintOutput....................................................................................................................................484
ProcessReport................................................................................................................................485
Publish...........................................................................................................................................486
setPDFConversionFiles.................................................................................................................488
setPDFConversionPageNumbering.............................................................................................. 488
setPDFConversionTimeOut.......................................................................................................... 489
SetPrinterType...............................................................................................................................490
SetPSQueryPromptRecord............................................................................................................490
SetRuntimeDataXMLFile............................................................................................................. 491
SetRuntimeProperties....................................................................................................................492
ReportDefn Class Properties...............................................................................................................494
Description.................................................................................................................................... 494
DestinationPrinter......................................................................................................................... 494
FolderName...................................................................................................................................494
OutDestination.............................................................................................................................. 494
OutDestinationType...................................................................................................................... 495
ProcessInstance............................................................................................................................. 495
ReportFileName............................................................................................................................ 495
Status.............................................................................................................................................496
UseBurstValueAsOutputFileName............................................................................................... 496
BI Publisher Report Manager Search Classes....................................................................................496
Report Class........................................................................................................................................ 496
Report Class Constructor.................................................................................................................... 497
Report............................................................................................................................................497
Report Class Properties.......................................................................................................................498
contentId....................................................................................................................................... 498
CreatedDateTime.......................................................................................................................... 498
DatabaseName.............................................................................................................................. 499
Description.................................................................................................................................... 499
ExpireDate.................................................................................................................................... 499
FileURL........................................................................................................................................ 499
FolderName...................................................................................................................................499
ProcessInstanceID.........................................................................................................................500
ReportInstanceID.......................................................................................................................... 500
ReportName.................................................................................................................................. 500
ReportURL....................................................................................................................................500
ReportManager Class.......................................................................................................................... 500
ReportManager Class Constructor......................................................................................................501
ReportManager..............................................................................................................................501

Copyright © 1988, 2024, Oracle and/or its affiliates. xvii

Contents

ReportManager Class Methods...........................................................................................................501

AddSearchFieldCriteria................................................................................................................ 501
GetReportList................................................................................................................................502
SetBurstFieldCriteria.................................................................................................................... 503
SetCaseSensitive........................................................................................................................... 503
SetDateCriteria..............................................................................................................................504
SetFolderCriteria...........................................................................................................................505
SetProcessInstanceCriteria............................................................................................................505
SetReportIDCriteria...................................................................................................................... 506
SetUserIdCriteria.......................................................................................................................... 506
SearchAttribute Class..........................................................................................................................507
SearchAttribute Class Constructor......................................................................................................507
SearchAttribute............................................................................................................................. 507
SearchAttribute Class Properties........................................................................................................ 508
attrName........................................................................................................................................508
attrValue........................................................................................................................................ 508
compareOp.................................................................................................................................... 509
BI Publisher Engine Classes...............................................................................................................509
PageNumber Class.............................................................................................................................. 509
PageNumber Class Constructor.......................................................................................................... 509
PageNumber..................................................................................................................................509
PageNumber Class Properties.............................................................................................................510
BackgroundFile.............................................................................................................................510
FontName......................................................................................................................................510
FontSize........................................................................................................................................ 511
PositionX.......................................................................................................................................511
PositionY.......................................................................................................................................512
StartFromPageNum.......................................................................................................................512
StartNum....................................................................................................................................... 512
PDFMerger Class................................................................................................................................ 512
PDFMerger Class Constructor............................................................................................................513
PDFMerger....................................................................................................................................513
PDFMerger Class Methods.................................................................................................................513
isPDFValid.................................................................................................................................... 513
MergePDFs................................................................................................................................... 514
PDFMerger Class Properties...............................................................................................................515
ConfProp....................................................................................................................................... 516
Locale............................................................................................................................................516
PageNumber..................................................................................................................................516
Watermark..................................................................................................................................... 517
Properties Class...................................................................................................................................517
Properties Class Constructor...............................................................................................................517
Properties...................................................................................................................................... 518
Properties Class Methods....................................................................................................................518
GetProperty................................................................................................................................... 518
SetProperty....................................................................................................................................519
Watermark Class................................................................................................................................. 519
Watermark Class Constructor............................................................................................................. 520
Watermark..................................................................................................................................... 520
Watermark Class Properties................................................................................................................ 521
ImageFile...................................................................................................................................... 521

xviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

ImageFileLowerLeftX.................................................................................................................. 521
ImageFileLowerLeftY.................................................................................................................. 521
ImageFileUpperRightX.................................................................................................................522
ImageFileUpperRightY.................................................................................................................522
PageIndex......................................................................................................................................522
Text................................................................................................................................................522
TextAngle......................................................................................................................................522
TextFontName...............................................................................................................................523
TextFontSize................................................................................................................................. 523
TextStartPosX............................................................................................................................... 523
TextStartPosY............................................................................................................................... 523
Understanding the DigitalCertStore Class..........................................................................................523
DigitalCertStore Class Methods......................................................................................................... 524
DigitalCertStore............................................................................................................................ 524
ExtractCertificateByAuthorizedRole............................................................................................ 524
ExtractCertificateByAuthorizedUser............................................................................................ 525
ExtractCertificateByDigitalID...................................................................................................... 527
getDigitalCertFileNameByDigitalID............................................................................................ 528
getDigitalIdBySigner.................................................................................................................... 529
getEncPassword............................................................................................................................ 530
getListOfAuthorizedRoleNames...................................................................................................531
getListOfAuthorizedUsers............................................................................................................ 531
getListOfDigitalId.........................................................................................................................532
getListOfSigner.............................................................................................................................533
getSignerByDigitalId.................................................................................................................... 533
isDigitalCertValid..........................................................................................................................534
DigitalCertStore Class Properties....................................................................................................... 535
ErrorMessageDetail...................................................................................................................... 535
ErrorMessageSet........................................................................................................................... 535
Understanding the IPDFSignature Interface Class............................................................................. 535
IPDFSignature Class Methods............................................................................................................537
getErrorString................................................................................................................................537
getSignatureId............................................................................................................................... 538
IPDFSignature Class Properties..........................................................................................................540
KeyFieldNames.............................................................................................................................540
KeyFieldValues............................................................................................................................. 541
OperatorId..................................................................................................................................... 541
ProcessInstance............................................................................................................................. 541
ReportId........................................................................................................................................ 541
secStore......................................................................................................................................... 542
UseSameSignatureForBursting.....................................................................................................542
Understanding the BIP_EMAIL_DATA Interface Class....................................................................543
BIP_EMAIL_DATA Class Methods...................................................................................................544
BIP_EMAIL_DATA..................................................................................................................... 544
getEmailAddressArray..................................................................................................................545
getErrorString................................................................................................................................547
BIP_EMAIL_DATA Class Properties................................................................................................ 547
BurstFieldName............................................................................................................................ 548
BurstFieldValue.............................................................................................................................548
ReportName.................................................................................................................................. 548
BI Publisher Classes Example............................................................................................................548

Copyright © 1988, 2024, Oracle and/or its affiliates. xix

Contents

Generating and Publishing a Report............................................................................................ 548

Chapter 14: Business Interlink Class.................................................................................................... 551
Understanding Business Interlink Class............................................................................................. 551
Using the Interlink Object.................................................................................................................. 551
Deciding Which Methods to Use....................................................................................................... 552
Executing the Business Interlink Object......................................................................................552
Supporting Batch Input and Output............................................................................................. 552
Supporting Rowsets......................................................................................................................552
Using the Flat Table Methods......................................................................................................552
Supporting Dynamic Output........................................................................................................ 553
Using Hierarchical Data (BIDocs)............................................................................................... 553
Using the Incoming Business Interlink Methods and Properties....................................................... 557
Understanding the State of an Interlink Object..................................................................................557
Using Business Interlink with Application Engine............................................................................ 558
Using the Data Type of a Business Interlink Object..........................................................................558
Understanding the Scope of a Business Interlink Object...................................................................558
Business Interlink Class Built-in Functions....................................................................................... 558
Business Interlink Class Methods.......................................................................................................559
AddDoc......................................................................................................................................... 559
AddInputRow................................................................................................................................560
AddNextDoc................................................................................................................................. 561
AddValue.......................................................................................................................................563
BulkExecute.................................................................................................................................. 566
Clear.............................................................................................................................................. 570
Execute..........................................................................................................................................571
FetchIntoRecord............................................................................................................................573
FetchIntoRowset........................................................................................................................... 576
FetchNextRow.............................................................................................................................. 579
GetCount....................................................................................................................................... 580
GetDoc.......................................................................................................................................... 581
GetFieldCount...............................................................................................................................583
GetFieldType.................................................................................................................................584
GetFieldValue................................................................................................................................586
GetInputDocs................................................................................................................................ 587
GetNextDoc.................................................................................................................................. 587
GetOutputDocs..............................................................................................................................589
GetPreviousDoc............................................................................................................................ 590
GetStatus....................................................................................................................................... 592
GetValue........................................................................................................................................593
InputRowset.................................................................................................................................. 595
MoveFirst...................................................................................................................................... 597
MoveNext..................................................................................................................................... 598
MoveToDoc.................................................................................................................................. 599
ResetCursor...................................................................................................................................601
Incoming Business Interlink Methods................................................................................................ 601
AddAttribute................................................................................................................................. 601
AddComment................................................................................................................................ 602
AddProcessInstruction.................................................................................................................. 603
AddText.........................................................................................................................................604
CreateElement...............................................................................................................................605
GenXMLString............................................................................................................................. 606

xx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

GetAttributeName.........................................................................................................................607
GetAttributeValue......................................................................................................................... 608
GetNode........................................................................................................................................ 609
ParseXMLString........................................................................................................................... 610
Incoming Business Interlink Properties..............................................................................................611
AttributeCount.............................................................................................................................. 611
ChildNodeCount........................................................................................................................... 612
NodeName.................................................................................................................................... 613
NodeType...................................................................................................................................... 613
NodeValue.....................................................................................................................................614
Business Interlink Class Property.......................................................................................................615
StopAtError...................................................................................................................................615
Configuration Parameters....................................................................................................................615
Interlink Plug-in Configuration Parameters................................................................................. 615
URL Configuration Parameter..................................................................................................... 616
BIDocValidate Configuration Parameter......................................................................................616
Chapter 15: Charting Classes.................................................................................................................617
Understanding the Charting Classes...................................................................................................617
Chart Classes................................................................................................................................ 617
Gantt Class....................................................................................................................................618
Gauge Classes...............................................................................................................................618
OrgChart Class............................................................................................................................. 619
RatingBoxChart Class.................................................................................................................. 620
Spark Chart Class......................................................................................................................... 620
Creating PeopleSoft Charts.................................................................................................................621
Creating a Chart on a Page..........................................................................................................621
Creating a Chart Using an iScript................................................................................................623
Special Considerations for Charts...................................................................................................... 624
Component Processor Considerations..........................................................................................624
Translation Considerations........................................................................................................... 624
Text Considerations for the Chart Class...................................................................................... 624
Text Considerations for the Gantt Class...................................................................................... 627
Considerations for Using Mobile Devices...................................................................................627
Fluid Mode Considerations for Charts and Gauges.....................................................................628
Sizing a Chart or Gauge in Classic Mode................................................................................... 632
Styling PeopleSoft Charts............................................................................................................ 632
Accessibility Settings for Charts..................................................................................................635
Color Contrast Mode for Charts.................................................................................................. 637
Using the Chart Class......................................................................................................................... 638
Understanding Chart Class Terms................................................................................................638
Creating Charts Using the Chart Class........................................................................................ 639
Chart Class Chart Types...............................................................................................................640
Chart Class Design Guidelines.................................................................................................... 640
Creating and Using Data Series with Charts............................................................................... 657
Creating a Chart with Two Y-Axes............................................................................................. 659
Selecting and Highlighting Data Points.......................................................................................663
Using the ReferenceArea Class....................................................................................................663
Using the ReferenceLine Class.................................................................................................... 665
Using the Series Class..................................................................................................................667
Using the ToolTipLabel Class......................................................................................................669
Scope and Data Type of a Chart Object...................................................................................... 671

Copyright © 1988, 2024, Oracle and/or its affiliates. xxi

Contents

Error Handling..............................................................................................................................671
Using the Gauge Classes.................................................................................................................... 671
Understanding Gauge Terms........................................................................................................ 671
Gauge Types................................................................................................................................. 672
Creating Gauges Using the Gauge Classes..................................................................................672
Design Guidelines.........................................................................................................................673
Gauge Interactivity....................................................................................................................... 674
Using the Threshold Class........................................................................................................... 676
Using the Rating Gauge Classes..................................................................................................678
Scope and Data Type of Gauge Objects...................................................................................... 679
Error Handling..............................................................................................................................680
Properties of the Gauge Classes.................................................................................................. 680
Using the Spark Chart Classes........................................................................................................... 681
Creating Spark Charts.................................................................................................................. 683
Using the Gantt Class......................................................................................................................... 685
Understanding Gantt Chart Terms............................................................................................... 685
Using Gantt Charts in the PeopleSoft Pure Internet Architecture............................................... 686
Creating Gantt Charts Using the Gantt Class.............................................................................. 688
Specifying Time Line Axis Formats............................................................................................689
Working with Start and End Dates.............................................................................................. 691
Using Gantt Glyphs......................................................................................................................691
Scope and Data Type of a Gantt Object...................................................................................... 692
Error Handling..............................................................................................................................692
Using the OrgChart Class................................................................................................................... 693
Understanding Organization Chart Terms....................................................................................693
Using Organization Charts in the PeopleSoft Pure Internet Architecture....................................695
Creating Organization Charts Using the OrgChart Class............................................................ 698
Overview of Creating an Organization Chart.............................................................................. 698
Creating an Organization Chart................................................................................................... 699
Displaying Breadcrumbs (Optional)............................................................................................ 700
Defining Descriptors.....................................................................................................................701
Implementing Menus and Drop-Down Lists (Optional)..............................................................704
Configuring Related Action Menus............................................................................................. 706
Configuring the Node Record for Drop-Downs.......................................................................... 707
Configuring Drop-Downs.............................................................................................................707
Populating the Drop-Down Rowset............................................................................................. 708
Setting Drop-Down Styles........................................................................................................... 710
Designing Organization Chart Nodes.......................................................................................... 710
Implementing Node Views (Optional)......................................................................................... 716
Implementing Zoom Schemas (Optional).................................................................................... 718
Specifying Scroll Types............................................................................................................... 721
Configuring Connector Lines and Node Borders........................................................................ 723
Organization Chart Actions and Events.......................................................................................724
Organization Chart Subrecord Definitions...................................................................................725
Minimum Methods and Properties...............................................................................................737
Scope and Data Type of an OrgChart Object.............................................................................. 738
Using the RatingBoxChart Class........................................................................................................739
Understanding Rating Box Chart Terms......................................................................................739
Using Rating Box Charts in PeopleSoft Applications................................................................. 740
Creating Rating Box Charts Using the RatingBoxChart Class....................................................741
Rating Box Chart Subrecord Definition...................................................................................... 742

xxii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Minimum Methods....................................................................................................................... 743

Minimum Properties..................................................................................................................... 743
Using the QuadrantSchema Class................................................................................................ 744
Data Type of a RatingBoxChart Object.......................................................................................745
Scope of a RatingBoxChart Object..............................................................................................746
Charting Classes Reference................................................................................................................ 746
Charting Classes Built-in Functions................................................................................................... 747
Chart Class Methods...........................................................................................................................748
Reset..............................................................................................................................................748
SetColorArray............................................................................................................................... 748
SetData.......................................................................................................................................... 750
SetDataColor.................................................................................................................................752
SetDataHints................................................................................................................................. 752
SetDataLabel.................................................................................................................................755
SetDataLabelPosition....................................................................................................................759
SetDataLabelStyle.........................................................................................................................761
SetDataMarker.............................................................................................................................. 761
SetDataMarkerSize....................................................................................................................... 763
SetDataSeries................................................................................................................................ 763
SetDataURLs................................................................................................................................ 764
SetDataXAxis................................................................................................................................765
SetDataYAxis................................................................................................................................ 766
SetDataZAxis................................................................................................................................ 771
SetExplodedSectorsArray............................................................................................................. 773
SetFunnelDataActual.................................................................................................................... 774
SetFunnelDataTarget.....................................................................................................................775
SetGlyphArray.............................................................................................................................. 776
SetLegend......................................................................................................................................776
SetOLData.....................................................................................................................................777
SetOLDataSeries...........................................................................................................................778
SetOLDataXAxis.......................................................................................................................... 779
SetOLDataYAxis...........................................................................................................................779
SetReferenceArea..........................................................................................................................780
SetReferenceLine.......................................................................................................................... 780
SetSelectedData............................................................................................................................ 781
SetSeries........................................................................................................................................782
SetSeriesLabels............................................................................................................................. 782
SetSvgGradientColor1.................................................................................................................. 783
SetSvgGradientColor2.................................................................................................................. 785
SetSvgGradientColor3.................................................................................................................. 786
SetSvgGradientColor4.................................................................................................................. 787
SetSvgGradientOffset1................................................................................................................. 788
SetSvgGradientOffset2................................................................................................................. 789
SetSvgGradientOffset3................................................................................................................. 790
SetSvgGradientOffset4................................................................................................................. 791
SetToolTipLabels.......................................................................................................................... 792
SetXAxisLabels............................................................................................................................ 793
SetYAxisColumnType...................................................................................................................793
SetYAxisLabels.............................................................................................................................794
Chart Class Properties.........................................................................................................................795
AdditionalStyleSuffix................................................................................................................... 795

Copyright © 1988, 2024, Oracle and/or its affiliates. xxiii

Contents

AnimationDuration....................................................................................................................... 795
AnimationType..............................................................................................................................796
AspectRatio...................................................................................................................................796
AspectRatioPortrait.......................................................................................................................796
ChartURL......................................................................................................................................797
DataSelectionMode.......................................................................................................................797
DataStartRow................................................................................................................................ 798
DataWidth..................................................................................................................................... 798
FooterAlignment........................................................................................................................... 799
FooterStyle.................................................................................................................................... 799
FootNote....................................................................................................................................... 800
FunnelOrientation......................................................................................................................... 800
FunnelPercentMeasure..................................................................................................................800
HasLegend.................................................................................................................................... 801
HasXAxis...................................................................................................................................... 801
HasYAxis...................................................................................................................................... 802
Height............................................................................................................................................802
HideShowBehavior....................................................................................................................... 803
ImageMap..................................................................................................................................... 803
IsChartDrillable.............................................................................................................................803
IsColorContrastMode....................................................................................................................804
IsDrillable......................................................................................................................................804
IsLineChartLineSmoothing...........................................................................................................805
IsPlainImage..................................................................................................................................805
IsSplitDualY................................................................................................................................. 806
IsTrueXY.......................................................................................................................................806
IsXAxisInteger.............................................................................................................................. 806
IsYAxisInteger.............................................................................................................................. 806
IsY2AxisInteger............................................................................................................................ 807
LegendPosition..............................................................................................................................807
LineChartDataGlyphSize.............................................................................................................. 807
MainTitle.......................................................................................................................................808
MinHeight..................................................................................................................................... 808
OLType..........................................................................................................................................808
PieCenterLabelStyle......................................................................................................................809
PieChartCenterLabel.....................................................................................................................809
ShowCrossHair............................................................................................................................. 809
SubTitle......................................................................................................................................... 810
SubTitleAlignment........................................................................................................................810
SubTitleStyle.................................................................................................................................810
TitleAlignment.............................................................................................................................. 810
TitleStyle....................................................................................................................................... 811
Type...............................................................................................................................................811
Width.............................................................................................................................................813
XAxisCrossPoint...........................................................................................................................814
XAxisLabelOrient.........................................................................................................................814
XAxisMax.....................................................................................................................................814
XAxisMin..................................................................................................................................... 814
XAxisPrecision............................................................................................................................. 814
XAxisTitle.....................................................................................................................................815
XAxisTitleOrient...........................................................................................................................815

xxiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Y2AxisMax...................................................................................................................................815
Y2AxisMin................................................................................................................................... 815
Y2AxisPrecision........................................................................................................................... 815
Y2AxisTitle...................................................................................................................................816
Y2AxisTitleOrient.........................................................................................................................816
YAxisCrossPoint........................................................................................................................... 816
YAxisLabelOrient......................................................................................................................... 816
YAxisMax..................................................................................................................................... 817
YAxisMin...................................................................................................................................... 817
YAxisPrecision..............................................................................................................................817
YAxisTicks....................................................................................................................................817
YAxisTitle..................................................................................................................................... 818
YAxisTitleOrient........................................................................................................................... 818
ChartClientState Class Methods......................................................................................................... 818
ChartClientState............................................................................................................................ 818
ChartClientState Class Properties....................................................................................................... 819
aSelections.................................................................................................................................... 819
nChartRow.................................................................................................................................... 821
nType.............................................................................................................................................821
ReferenceArea Class Properties..........................................................................................................822
Association....................................................................................................................................822
Description.................................................................................................................................... 822
IsDisplayedTextInLegend............................................................................................................. 823
LineType....................................................................................................................................... 823
ReferenceAreaColor......................................................................................................................823
ReferenceAreaLocation................................................................................................................ 825
ReferenceAreaValues.................................................................................................................... 825
ReferenceAreaValueSet................................................................................................................ 825
ShortText.......................................................................................................................................826
ReferenceLine Class Properties.......................................................................................................... 826
Association....................................................................................................................................826
Description.................................................................................................................................... 826
IsDisplayedTextInLegend............................................................................................................. 827
LineType....................................................................................................................................... 827
ReferenceLineColor...................................................................................................................... 828
ReferenceLineLocation.................................................................................................................829
ReferenceLineValue...................................................................................................................... 829
ReferenceLineValueSet.................................................................................................................830
ShortText.......................................................................................................................................830
Series Class Properties........................................................................................................................830
Name............................................................................................................................................. 830
Type...............................................................................................................................................831
ToolTipLabel Class Properties............................................................................................................831
ToolTipLabelType.........................................................................................................................831
ToolTipLabelValue........................................................................................................................832
DialGauge Class Methods.................................................................................................................. 832
Refresh.......................................................................................................................................... 832
SetThreshold................................................................................................................................. 833
DialGauge Class Properties................................................................................................................ 833
AdditionalStyleSuffix................................................................................................................... 833
AnimationDuration....................................................................................................................... 833

Copyright © 1988, 2024, Oracle and/or its affiliates. xxv

Contents

AnimationType..............................................................................................................................833
BottomLabel..................................................................................................................................833
BottomLabelPosition.................................................................................................................... 833
GaugeDecimalDigit...................................................................................................................... 834
GaugeMaximum............................................................................................................................834
GaugeMinimum............................................................................................................................ 834
GaugeURL.................................................................................................................................... 834
Height............................................................................................................................................834
IsDrillable......................................................................................................................................834
LegendPosition..............................................................................................................................834
MajorTickIncrement..................................................................................................................... 835
MetricLabelPosition......................................................................................................................835
MetricLabelType........................................................................................................................... 835
MinorTickIncrement..................................................................................................................... 835
TickLabelPosition......................................................................................................................... 835
TopLabel....................................................................................................................................... 835
TopLabelPosition.......................................................................................................................... 835
Type...............................................................................................................................................836
Width.............................................................................................................................................836
LEDGauge Class Methods..................................................................................................................836
Refresh.......................................................................................................................................... 836
SetThreshold................................................................................................................................. 836
LEDGauge Class Properties............................................................................................................... 836
AdditionalStyleSuffix................................................................................................................... 836
AnimationDuration....................................................................................................................... 837
AnimationType..............................................................................................................................837
AspectRatio...................................................................................................................................837
BottomLabel..................................................................................................................................837
BottomLabelPosition.................................................................................................................... 838
GaugeDecimalDigit...................................................................................................................... 838
GaugeURL.................................................................................................................................... 838
Height............................................................................................................................................838
IsDrillable......................................................................................................................................838
LegendPosition..............................................................................................................................839
MetricLabelPosition......................................................................................................................839
MetricLabelType........................................................................................................................... 839
TopLabel....................................................................................................................................... 839
TopLabelPosition.......................................................................................................................... 839
Type...............................................................................................................................................840
Width.............................................................................................................................................841
RatingGaugeChart Class Methods......................................................................................................841
SetRatingGaugeThresholds...........................................................................................................841
RatingGaugeChart Class Properties....................................................................................................842
AspectRatio...................................................................................................................................842
ChangedState................................................................................................................................ 842
HoverState.....................................................................................................................................843
Max............................................................................................................................................... 843
Min................................................................................................................................................ 843
ReadOnly...................................................................................................................................... 844
SelectedState................................................................................................................................. 844
Step............................................................................................................................................... 844

xxvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Title............................................................................................................................................... 844
UnselectedState.............................................................................................................................845
Width.............................................................................................................................................845
RatingGaugeState Class Properties.....................................................................................................845
BorderColor.................................................................................................................................. 845
Color............................................................................................................................................. 847
Shape.............................................................................................................................................848
GaugeThreshold Class Properties....................................................................................................... 848
BorderColor.................................................................................................................................. 849
Color............................................................................................................................................. 850
Description.................................................................................................................................... 851
MaxValue...................................................................................................................................... 851
StatusMeterGauge Class Methods...................................................................................................... 851
Refresh.......................................................................................................................................... 852
SetThreshold................................................................................................................................. 852
StatusMeterGauge Class Properties.................................................................................................... 852
AdditionalStyleSuffix................................................................................................................... 852
AnimationDuration....................................................................................................................... 852
AnimationType..............................................................................................................................852
AspectRatio...................................................................................................................................852
BottomLabel..................................................................................................................................853
BottomLabelPosition.................................................................................................................... 853
GaugeDecimalDigit...................................................................................................................... 853
GaugeMaximum............................................................................................................................853
GaugeMinimum............................................................................................................................ 854
GaugeURL.................................................................................................................................... 854
Height............................................................................................................................................854
IsDrillable......................................................................................................................................854
LegendPosition..............................................................................................................................855
MajorTickIncrement..................................................................................................................... 855
MetricLabelPosition......................................................................................................................855
MetricLabelType........................................................................................................................... 855
MinorTickIncrement..................................................................................................................... 855
TopLabel....................................................................................................................................... 856
TopLabelPosition.......................................................................................................................... 856
Type...............................................................................................................................................856
Width.............................................................................................................................................859
Threshold Class Properties................................................................................................................. 859
Colors............................................................................................................................................ 859
Descriptions.................................................................................................................................. 861
Id................................................................................................................................................... 861
Values............................................................................................................................................ 861
SparkChart Class Methods..................................................................................................................862
SetSparkChartItems...................................................................................................................... 862
SparkChart Class Properties............................................................................................................... 863
AnimationDuration....................................................................................................................... 863
AnimationType..............................................................................................................................863
AspectRatio...................................................................................................................................863
barGapRatio.................................................................................................................................. 864
Color............................................................................................................................................. 865
IsDrillable......................................................................................................................................866

Copyright © 1988, 2024, Oracle and/or its affiliates. xxvii

Contents

LineStyle....................................................................................................................................... 866
LineType....................................................................................................................................... 867
LineWidth..................................................................................................................................... 868
SparkChartURL............................................................................................................................ 868
Title............................................................................................................................................... 868
Type...............................................................................................................................................869
Width.............................................................................................................................................869
SparkChartItem Class Properties........................................................................................................ 870
BorderColor.................................................................................................................................. 870
Color............................................................................................................................................. 871
FloatValue..................................................................................................................................... 872
MarkerDisplayed...........................................................................................................................873
MarkerShape................................................................................................................................. 873
Value............................................................................................................................................. 874
Gantt Class Methods...........................................................................................................................874
Refresh.......................................................................................................................................... 874
Reset..............................................................................................................................................875
SetActualEndDate.........................................................................................................................876
SetActualStartDate........................................................................................................................876
SetActualTaskBarColor................................................................................................................ 877
SetChartArea.................................................................................................................................878
SetDayFormat............................................................................................................................... 878
SetHourFormat..............................................................................................................................879
SetMinuteFormat.......................................................................................................................... 880
SetMonthFormat........................................................................................................................... 880
SetPlannedEndDate.......................................................................................................................881
SetPlannedStartDate......................................................................................................................882
SetPlannedTaskBarColor.............................................................................................................. 882
SetSecondFormat.......................................................................................................................... 883
SetTableXScrollbar....................................................................................................................... 883
SetTaskAppData............................................................................................................................883
SetTaskAppDataTitles...................................................................................................................884
SetTaskBarURL............................................................................................................................ 885
SetTaskData.................................................................................................................................. 886
SetTaskDependencyChildID......................................................................................................... 886
SetTaskDependencyData.............................................................................................................. 887
SetTaskDependencyParentID........................................................................................................888
SetTaskDependencyType.............................................................................................................. 888
SetTaskDependencyURL.............................................................................................................. 890
SetTaskDrill.................................................................................................................................. 890
SetTaskExpanded.......................................................................................................................... 891
SetTaskID......................................................................................................................................891
SetTaskLabel................................................................................................................................. 892
SetTaskLevel................................................................................................................................. 893
SetTaskMilestone.......................................................................................................................... 894
SetTaskName................................................................................................................................ 895
SetTaskProgress............................................................................................................................ 895
SetTaskProgressBarColor............................................................................................................. 896
SetWBSNumbering.......................................................................................................................897
SetYearFormat...............................................................................................................................897
Gantt Class Properties.........................................................................................................................898

xxviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

AdditionalStyleSuffix................................................................................................................... 898
AxisEndDateTime.........................................................................................................................898
AxisStartDateTime........................................................................................................................899
DataStartRow................................................................................................................................ 899
DataWidth..................................................................................................................................... 899
GridLines...................................................................................................................................... 899
GridLineType................................................................................................................................ 900
Height............................................................................................................................................900
ImageMap..................................................................................................................................... 900
InteractiveEnd............................................................................................................................... 901
InteractiveMove............................................................................................................................ 901
InteractiveProgress........................................................................................................................901
InteractiveStart.............................................................................................................................. 901
IsDrillable......................................................................................................................................902
IsPlainImage..................................................................................................................................902
PixelsPerRow................................................................................................................................ 902
RevertToPre850............................................................................................................................ 903
ShowTaskLabels........................................................................................................................... 903
Style.............................................................................................................................................. 903
StyleSheet......................................................................................................................................903
TaskDependencyLineType............................................................................................................903
TaskMilestoneGlyph..................................................................................................................... 904
TaskTitle........................................................................................................................................904
Width.............................................................................................................................................905
OrgChart Class Methods.....................................................................................................................905
SetCrumbData...............................................................................................................................905
SetCrumbRecord...........................................................................................................................905
SetDropdownData.........................................................................................................................906
SetDropdownRecord.....................................................................................................................907
SetIMData..................................................................................................................................... 907
SetIMRecord................................................................................................................................. 907
SetLegend......................................................................................................................................907
SetLegendImg............................................................................................................................... 908
SetNodeData................................................................................................................................. 909
SetNodeDisplayDataRecord......................................................................................................... 909
SetNodeDisplayData.....................................................................................................................910
SetNodeRecord............................................................................................................................. 910
SetNodeViewEntries..................................................................................................................... 911
SetNodeViewText......................................................................................................................... 912
SetPopUpNodeData...................................................................................................................... 912
SetPopUpNodeRecord.................................................................................................................. 913
SetSchemaLevels.......................................................................................................................... 914
OrgChart Class Properties...................................................................................................................914
CenterFocusNode..........................................................................................................................915
ChartCurrentSchemaLevel............................................................................................................915
ChartScrollType............................................................................................................................ 916
Collapsed_Msg............................................................................................................................. 916
CollapsedImage.............................................................................................................................916
CollapseMainIconSpace................................................................................................................917
CrumbDescrStyle.......................................................................................................................... 917
CrumbMaxDisplayLength............................................................................................................ 917

Copyright © 1988, 2024, Oracle and/or its affiliates. xxix

Contents

CrumbSeparatorImage.................................................................................................................. 918
DefaultImage.................................................................................................................................918
Direction........................................................................................................................................918
DropDownBoxStyle......................................................................................................................919
Expanded_Msg............................................................................................................................. 919
ExpandedImage.............................................................................................................................919
FocusNodeStyle............................................................................................................................ 920
HasLegend.................................................................................................................................... 920
Height............................................................................................................................................920
ImageHeight..................................................................................................................................920
ImageLocation.............................................................................................................................. 921
ImageMouseoverMagnificationFactor..........................................................................................921
IMPresence....................................................................................................................................921
IMRefreshInterval.........................................................................................................................922
InitialView.....................................................................................................................................922
LegendPosition..............................................................................................................................922
LegendStyle.................................................................................................................................. 922
LegendTopSpace........................................................................................................................... 923
MainTitle.......................................................................................................................................923
MainTitleStyle...............................................................................................................................923
MaxDropdownDisplayItem.......................................................................................................... 923
MaxPopupDisplayNode................................................................................................................ 924
NodeDescr1Style.......................................................................................................................... 924
NodeDescr2Style.......................................................................................................................... 924
NodeDescr3Style.......................................................................................................................... 925
NodeDescr4Style.......................................................................................................................... 925
NodeDescr5Style.......................................................................................................................... 925
NodeDescr6Style.......................................................................................................................... 926
NodeDescr7Style.......................................................................................................................... 926
NodeMaxDisplayDescLength.......................................................................................................926
NodeProportion.............................................................................................................................927
OptimizeHorizontalSpace............................................................................................................. 927
OptimizeVerticalSpace..................................................................................................................928
PopupHeaderStyle.........................................................................................................................928
PopupNodeDescr1Style................................................................................................................ 928
PopupNodeDescr2Style................................................................................................................ 929
PopupNodeDescr3Style................................................................................................................ 929
PopupNodeDescr4Style................................................................................................................ 929
PopupNodeDescr5Style................................................................................................................ 930
PopupNodeDescr6Style................................................................................................................ 930
PopupNodeDescr7Style................................................................................................................ 930
PopupNodeDescr8Style................................................................................................................ 931
Style.............................................................................................................................................. 931
SuppressPeopleCodeOnNode....................................................................................................... 931
SuppressPeopleCodeOnImage...................................................................................................... 931
UnlinkCrumbDescrStyle...............................................................................................................932
VerticalSpace.................................................................................................................................932
Width.............................................................................................................................................932
SchemaLevel Class Properties............................................................................................................932
ID.................................................................................................................................................. 933
ImageHeight..................................................................................................................................933

xxx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

RatingBoxChart Class Methods..........................................................................................................933

SetLegend......................................................................................................................................933
SetLegendImg............................................................................................................................... 934
SetQuadrantSchemas.................................................................................................................... 934
SetRBNodeData............................................................................................................................ 935
SetRBNodeRecord........................................................................................................................ 936
SetXAxisLabels............................................................................................................................ 936
SetYAxisLabels.............................................................................................................................937
RatingBoxChart Class Properties....................................................................................................... 937
BoxMaxDisplayItems................................................................................................................... 937
DraggedNodeStyle........................................................................................................................ 938
EnableRelatedActions...................................................................................................................938
GridLineType................................................................................................................................ 939
HasLegend.................................................................................................................................... 939
Height............................................................................................................................................939
IconOnlySelectedQuadrantStyle...................................................................................................940
IsDragable..................................................................................................................................... 940
LegendPosition..............................................................................................................................940
MainTitle.......................................................................................................................................941
MainTitleStyle...............................................................................................................................941
NDMaxDisplayDescLength..........................................................................................................941
PopUpHeaderStyle........................................................................................................................942
PopUpHeight.................................................................................................................................942
PopUpStyle................................................................................................................................... 942
PopUpWidth..................................................................................................................................943
SelectedQuadrantStyle.................................................................................................................. 943
ShowAxisLabels........................................................................................................................... 943
ShowNodeDescription.................................................................................................................. 944
Style.............................................................................................................................................. 944
ViewAllStyle.................................................................................................................................944
Width.............................................................................................................................................945
XAxisBoxNum............................................................................................................................. 945
XAxisLabelStyle...........................................................................................................................945
XAxisTitle.....................................................................................................................................946
XAxisTitleStyle.............................................................................................................................946
YAxisBoxNum.............................................................................................................................. 946
YAxisLabelStyle........................................................................................................................... 946
YAxisTitle..................................................................................................................................... 947
YAxisTitleStyle............................................................................................................................. 947
QuadrantSchema Class Properties...................................................................................................... 947
LabelPosition................................................................................................................................ 947
LabelStyle..................................................................................................................................... 948
LabelText...................................................................................................................................... 948
XRating......................................................................................................................................... 948
YRating......................................................................................................................................... 949
Timeline Class Methods..................................................................................................................... 949
SetData.......................................................................................................................................... 949
SetDataSeries................................................................................................................................ 950
SetDataItemStart........................................................................................................................... 950
SetDataItemDescription................................................................................................................ 951
SetDataItemTitle........................................................................................................................... 951

Copyright © 1988, 2024, Oracle and/or its affiliates. xxxi

Contents

SetSeriesEmptyText...................................................................................................................... 952
SetSeriesLabels............................................................................................................................. 953
Timeline Class Properties................................................................................................................... 953
AspectRatio...................................................................................................................................953
End................................................................................................................................................ 954
Height............................................................................................................................................954
MajorAxisScale.............................................................................................................................954
MinorAxisScale............................................................................................................................ 955
MinorAxisZoomOrder.................................................................................................................. 955
Orientation.................................................................................................................................... 956
Start............................................................................................................................................... 956
TimelineEmptyText.......................................................................................................................956
TimelineLabel............................................................................................................................... 957
Width.............................................................................................................................................957
Charting Examples.............................................................................................................................. 957
Creating a Chart Using the Chart Class.......................................................................................957
Creating a Gantt Chart................................................................................................................. 978
Creating an Organization Chart................................................................................................... 982
Creating a Rating Box Chart....................................................................................................... 986
Creating a Chart Using an iScript................................................................................................988
Creating a Timeline Chart............................................................................................................990
Desupported Chart Class Methods..................................................................................................... 992
Refresh.......................................................................................................................................... 992
SetDataAnnotations...................................................................................................................... 993
SetDataGlyphScale....................................................................................................................... 994
SetOLDataAnnotations................................................................................................................. 994
SetOLDataGlyphScale.................................................................................................................. 995
Desupported Chart Class Properties................................................................................................... 995
GridLines...................................................................................................................................... 995
GridLineType................................................................................................................................ 995
HighlightSelectedDataPoint..........................................................................................................995
LegendStyle.................................................................................................................................. 996
LineType....................................................................................................................................... 996
MainTitleOrient.............................................................................................................................996
MainTitleStyle...............................................................................................................................996
OLLineType.................................................................................................................................. 996
RevertToPre850............................................................................................................................ 996
RotationAngle............................................................................................................................... 997
SetChartURL.................................................................................................................................997
Style.............................................................................................................................................. 997
StyleSheet......................................................................................................................................997
XAxisCross................................................................................................................................... 997
XAxisScaleResolution.................................................................................................................. 998
XAxisStyle.................................................................................................................................... 998
XAxisTitleStyle.............................................................................................................................998
XRotationAngle............................................................................................................................ 998
YAxisScaleResolution...................................................................................................................998
YAxisStyle.................................................................................................................................... 998
YAxisTitleStyle............................................................................................................................. 998
YRotationAngle............................................................................................................................ 999
ZRotationAngle.............................................................................................................................999

xxxii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Chapter 16: Component Interface Classes..........................................................................................1001

Understanding Component Interface Class...................................................................................... 1001
Life Cycle of a Component Interface...............................................................................................1002
Setting Component Interface Keys............................................................................................ 1003
Standard and User-Defined Component Interface Methods...................................................... 1004
Accessing Component Interface Standard Properties................................................................ 1005
Accessing User-Defined Component Interface Properties.........................................................1006
Data Type of a Component Interface Object................................................................................... 1006
Scope of a Component Interface Object.......................................................................................... 1007
Implementing a Component Interface.............................................................................................. 1007
Component Interface Methods and Timeouts...................................................................................1008
Traversing a Component Interface and Using Data Collections...................................................... 1008
Working With Effective-Dated Data.................................................................................................1010
How a Developer Uses GetEffectiveItem..................................................................................1010
Reusing Existing Code......................................................................................................................1011
Differences in Search Dialog Processing...................................................................................1011
Differences in PeopleCode Event and Function Behavior.........................................................1011
Using %Menu Conditions.......................................................................................................... 1012
Session Class Methods......................................................................................................................1012
FindCompIntfcs.......................................................................................................................... 1012
GetCompIntfc..............................................................................................................................1013
ValidateCompIntfc...................................................................................................................... 1013
Component Interface Collection Methods........................................................................................1014
First............................................................................................................................................. 1015
Item............................................................................................................................................. 1015
Next.............................................................................................................................................1015
Component Interface Collection Property........................................................................................ 1016
Count...........................................................................................................................................1016
Component Interface Class Methods................................................................................................1016
Cancel..........................................................................................................................................1016
CopyRowset................................................................................................................................ 1017
CopyRowsetDelta....................................................................................................................... 1019
CopySetupRowset.......................................................................................................................1021
CopySetupRowsetDelta.............................................................................................................. 1023
Create.......................................................................................................................................... 1025
Find............................................................................................................................................. 1026
Get...............................................................................................................................................1026
GetPropertyByName...................................................................................................................1027
Save.............................................................................................................................................1028
SetPropertyByName....................................................................................................................1029
Component Interface Class Properties..............................................................................................1030
ComponentName........................................................................................................................ 1030
CreateKeyInfoCollection............................................................................................................ 1030
EditHistoryItems......................................................................................................................... 1031
FindKeyInfoCollection............................................................................................................... 1031
GetDummyRows.........................................................................................................................1031
GetHistoryItems.......................................................................................................................... 1032
GetKeyInfoCollection.................................................................................................................1032
InteractiveMode.......................................................................................................................... 1033
PropertyInfoCollection................................................................................................................1033
StopOnFirstError.........................................................................................................................1033

Copyright © 1988, 2024, Oracle and/or its affiliates. xxxiii

Contents

Data Collection Methods.................................................................................................................. 1034

CurrentItem................................................................................................................................. 1034
DeleteItem...................................................................................................................................1034
GetEffectiveItem......................................................................................................................... 1036
GetEffectiveItemNum................................................................................................................. 1036
InsertItem.................................................................................................................................... 1037
Item............................................................................................................................................. 1038
ItemByKeys................................................................................................................................ 1038
Data Collection Properties................................................................................................................ 1040
Count...........................................................................................................................................1040
CurrentItemNumber.................................................................................................................... 1040
Data Item Class Property..................................................................................................................1040
ItemNum..................................................................................................................................... 1041
Accessing the Structure of a Component Interface..........................................................................1041
CompIntfPropInfoCollection Collection.................................................................................... 1041
CompIntfPropInfoCollection Collection Methods............................................................................1044
First............................................................................................................................................. 1044
Item............................................................................................................................................. 1044
Next.............................................................................................................................................1045
CompIntfPropInfoCollection Collection Properties......................................................................... 1045
Count...........................................................................................................................................1045
CompIntfPropInfoCollection Object Properties............................................................................... 1045
Format......................................................................................................................................... 1045
IsCollection................................................................................................................................. 1046
IsReadOnly................................................................................................................................. 1047
Key.............................................................................................................................................. 1047
LabelLong................................................................................................................................... 1047
LabelShort...................................................................................................................................1047
Length......................................................................................................................................... 1047
Name........................................................................................................................................... 1048
Prompt.........................................................................................................................................1048
PropertyInfoCollection................................................................................................................1048
Required...................................................................................................................................... 1049
Type.............................................................................................................................................1049
Xlat..............................................................................................................................................1049
YesNo..........................................................................................................................................1050
Component Interface Examples........................................................................................................1050
Create a New Instance of Data Example...................................................................................1050
Getting an Existing Instance of Data Example..........................................................................1052
Retrieving a List of Instance of Data Example......................................................................... 1055
Inserting Effective-Dated Data Example................................................................................... 1056
Inserting Effective-Dated Data Example Using Visual Basic....................................................1058
Inserting or Deleting a Row of Data Example.......................................................................... 1059
Chapter 17: Connected Query Classes................................................................................................ 1065
Understanding the Connected Query Classes...................................................................................1065
Importing Connected Query Classes................................................................................................ 1065
CONQRSMGR Class........................................................................................................................1066
CONQRSMGR Class Constructor....................................................................................................1066
CONQRSMGR........................................................................................................................... 1066
CONQRSMGR Class Methods........................................................................................................ 1066
CleanOutputFile.......................................................................................................................... 1066

xxxiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Close........................................................................................................................................... 1067
CopyDefn.................................................................................................................................... 1067
DeleteDefn.................................................................................................................................. 1068
ExistsByName.............................................................................................................................1068
GetSampleXMLString................................................................................................................ 1069
Open............................................................................................................................................ 1069
ResetQueriesPrompt....................................................................................................................1070
Run.............................................................................................................................................. 1070
RunToWindow............................................................................................................................ 1072
RunToXMLFormattedString.......................................................................................................1072
Save.............................................................................................................................................1073
SaveRunControlParms................................................................................................................ 1073
SetRunControlData..................................................................................................................... 1074
Validate........................................................................................................................................1075
ValidateIfFieldsMapped.............................................................................................................. 1075
ValidateRunControlParms...........................................................................................................1076
CONQRSMGR Class Properties...................................................................................................... 1076
Const........................................................................................................................................... 1076
Description.................................................................................................................................. 1077
Details......................................................................................................................................... 1077
ErrString......................................................................................................................................1077
ExecutionLog.............................................................................................................................. 1077
IgnoreRelFldOutput.................................................................................................................... 1077
IsChanged................................................................................................................................... 1078
IsDebugMode..............................................................................................................................1078
IsInit............................................................................................................................................ 1078
IsPublic....................................................................................................................................... 1079
LastUpdatedBy............................................................................................................................1079
LastUpdateDTTM.......................................................................................................................1079
MaxRowsPerQuery.....................................................................................................................1079
Name........................................................................................................................................... 1079
ObjectRowset.............................................................................................................................. 1079
OprID.......................................................................................................................................... 1080
OutProcessFileName...................................................................................................................1080
PropertyArray............................................................................................................................. 1080
QueriesPromptsArray..................................................................................................................1082
QueryArray................................................................................................................................. 1082
RegisteredBy...............................................................................................................................1082
RegisteredDTTM........................................................................................................................ 1083
RunCntlId....................................................................................................................................1083
RunControlParArray................................................................................................................... 1083
RunMode.....................................................................................................................................1083
SchedInfo.................................................................................................................................... 1085
SchedRequestType...................................................................................................................... 1086
SecProfile.................................................................................................................................... 1086
ShowFormattedXML.................................................................................................................. 1086
Status...........................................................................................................................................1087
XMLDataFileName.................................................................................................................... 1087
XMLDataFullName.................................................................................................................... 1087
CONQRSPROPERTY Class.............................................................................................................1087
CONQRSPROPERTY Class Properties........................................................................................... 1088

Copyright © 1988, 2024, Oracle and/or its affiliates. xxxv

Contents

PROPDEFAULT......................................................................................................................... 1088
PROPNAME...............................................................................................................................1088
PROPVALUE..............................................................................................................................1088
PROPVALUEARRAY................................................................................................................ 1088
PROPVALUEARRAYDESC......................................................................................................1089
CONQRS_CONST Class..................................................................................................................1089
CONQRS_CONST Class Properties................................................................................................ 1089
InitExisting..................................................................................................................................1089
InitNew....................................................................................................................................... 1089
MsgSet........................................................................................................................................ 1090
RunCntlId_Auto..........................................................................................................................1090
RunMode_Prev........................................................................................................................... 1090
RunMode_Prev_DefRowNumber...............................................................................................1091
RunMode_Sample.......................................................................................................................1091
RunMode_Sched_File.................................................................................................................1091
RunMode_Sched_Web................................................................................................................1092
RunMode_Window..................................................................................................................... 1092
RunMode_XMLFormattedString................................................................................................1092
SchedRequest_CQR....................................................................................................................1093
SchedRequest_XMLP.................................................................................................................1093
Stat_Active..................................................................................................................................1093
Stat_InActive.............................................................................................................................. 1093
Stat_InProgress........................................................................................................................... 1094
QUERYITEMPROMPT Class..........................................................................................................1094
QUERYITEMPROMPT Class Properties........................................................................................ 1094
QueryName................................................................................................................................. 1094
QueryPromptRecord................................................................................................................... 1094
SCHED_INFO Class.........................................................................................................................1095
SCHED_INFO Class Properties....................................................................................................... 1095
AE_ID......................................................................................................................................... 1095
DIRLOCATION..........................................................................................................................1095
OPRID.........................................................................................................................................1096
OUTDESTTYPE........................................................................................................................ 1096
PRCSFILENAME.......................................................................................................................1096
PROCESS_INSTANCE..............................................................................................................1096
RUN_CNTL_ID......................................................................................................................... 1097
SEC_PROFILE Class........................................................................................................................1097
SEC_PROFILE Class Constructor................................................................................................... 1097
SEC_PROFILE........................................................................................................................... 1097
SEC_PROFILE Class Properties...................................................................................................... 1097
CanCreatePublic..........................................................................................................................1098
CanModify.................................................................................................................................. 1098
CanRunQuery............................................................................................................................. 1098
UTILITY Class................................................................................................................................. 1098
UTILITY Class Constructor............................................................................................................. 1098
UTILITY.....................................................................................................................................1098
UTILITY Class Methods.................................................................................................................. 1099
CheckQryForTreePrompt............................................................................................................1099
CheckQrySecurity.......................................................................................................................1099
GetQueryScopeByName.............................................................................................................1100
ValidateObjectID.........................................................................................................................1101

xxxvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Connected Query Classes Examples................................................................................................ 1101

Running a Connected Query in Scheduled Mode......................................................................1101
Running a Connected Query in Preview Mode or Background Mode...................................... 1103
Iterating Through a Connected Query Opened for Editing....................................................... 1104
Chapter 18: ContentAuthorizorBase Class......................................................................................... 1107
Understanding the ContentAuthorizorBase Class............................................................................ 1107
ContentAuthorizorBase Class Methods............................................................................................ 1107
Authorize.....................................................................................................................................1107
SetResponse................................................................................................................................ 1108
ContentAuthorizorBase Class Properties..........................................................................................1109
ALLOW_DIRECTORY..............................................................................................................1109
ALLOW_SUBDIR......................................................................................................................1110
DENY......................................................................................................................................... 1110
Chapter 19: Crypt Class....................................................................................................................... 1111
Understanding the Crypt Class......................................................................................................... 1111
Creating a Crypt Object....................................................................................................................1111
Declaring Crypt Objects................................................................................................................... 1111
Scope of a Crypt Object................................................................................................................... 1111
Crypt Class Methods.........................................................................................................................1111
FirstStep...................................................................................................................................... 1112
GoToStep.................................................................................................................................... 1112
LoadLibrary................................................................................................................................ 1113
NextStep......................................................................................................................................1113
Open............................................................................................................................................ 1114
SetParameter............................................................................................................................... 1115
UpdateData..................................................................................................................................1115
Crypt Class Properties...................................................................................................................... 1116
AuthTag.......................................................................................................................................1116
Result.......................................................................................................................................... 1116
Verified........................................................................................................................................1117
Crypt Class Example........................................................................................................................ 1117
Chapter 20: Document Classes.............................................................................................................1119
Understanding the Document Classes.............................................................................................. 1119
Data Type and Scope of the Document Classes...............................................................................1119
Document Classes Built-in Functions.............................................................................................. 1119
Document Class................................................................................................................................ 1120
Document Class Methods................................................................................................................. 1120
GenJsonString............................................................................................................................. 1120
GenXmlString............................................................................................................................. 1121
GetDocumentKey........................................................................................................................1121
GetElement..................................................................................................................................1122
GetRowset...................................................................................................................................1123
GetSchema.................................................................................................................................. 1123
ParseJsonString........................................................................................................................... 1124
ParseXmlFromFile...................................................................................................................... 1125
ParseXmlFromURL.................................................................................................................... 1125
ParseXmlString........................................................................................................................... 1126
UpdateFromRowset.................................................................................................................... 1127
ValidateData................................................................................................................................ 1127
Document Class Properties............................................................................................................... 1128
DocumentElement.......................................................................................................................1128

Copyright © 1988, 2024, Oracle and/or its affiliates. xxxvii

Contents

DocumentKey Class..........................................................................................................................1128
DocumentKey Class Methods...........................................................................................................1128
SetDocumentKey........................................................................................................................ 1128
DocumentKey Class Properties........................................................................................................ 1129
DocumentName.......................................................................................................................... 1129
GetDocumentName.....................................................................................................................1130
GetVersion...................................................................................................................................1130
PackageName..............................................................................................................................1130
Version........................................................................................................................................ 1130
Primitive Class.................................................................................................................................. 1131
Primitive Class Methods...................................................................................................................1131
GetEnumName............................................................................................................................1131
GetParent.....................................................................................................................................1131
GetPath........................................................................................................................................1132
Primitive Class Properties.................................................................................................................1132
ElementType............................................................................................................................... 1133
EnumCount................................................................................................................................. 1133
IsChanged................................................................................................................................... 1133
IsInitialized..................................................................................................................................1133
IsRequired................................................................................................................................... 1134
MaxDefinedDecimalLength........................................................................................................1134
MaxDefinedLength..................................................................................................................... 1134
Name........................................................................................................................................... 1134
OrigValue.................................................................................................................................... 1134
PrimitiveSubType........................................................................................................................1135
PrimitiveType..............................................................................................................................1136
SequenceNumber........................................................................................................................ 1137
Value........................................................................................................................................... 1137
Compound Class............................................................................................................................... 1137
Compound Class Methods................................................................................................................ 1137
Clear............................................................................................................................................ 1137
GetParent.....................................................................................................................................1138
GetPath........................................................................................................................................1139
GetPropertyByIndex................................................................................................................... 1139
GetPropertyByName...................................................................................................................1140
GetUniqueKey............................................................................................................................ 1140
Compound Class Properties..............................................................................................................1141
ElementType............................................................................................................................... 1141
IsChanged................................................................................................................................... 1141
IsInitialized..................................................................................................................................1141
IsRequired................................................................................................................................... 1141
Name........................................................................................................................................... 1142
PropertyCount............................................................................................................................. 1142
SequenceNumber........................................................................................................................ 1142
Collection Class................................................................................................................................ 1142
Collection Class Methods................................................................................................................. 1142
AppendItem.................................................................................................................................1142
CreateItem...................................................................................................................................1143
DeleteItem...................................................................................................................................1144
GetItem........................................................................................................................................1144
GetParent.....................................................................................................................................1145

xxxviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

GetPath........................................................................................................................................1145
InsertItem.................................................................................................................................... 1146
Collection Class Properties............................................................................................................... 1147
CollectionElementType...............................................................................................................1147
Count...........................................................................................................................................1147
DefinedMaxOccurs..................................................................................................................... 1147
DefinedMinOccurs......................................................................................................................1148
ElementType............................................................................................................................... 1148
IsChanged................................................................................................................................... 1148
IsInitialized..................................................................................................................................1148
IsRequired................................................................................................................................... 1148
Name........................................................................................................................................... 1148
SequenceNumber........................................................................................................................ 1149
Chapter 21: Drop Zone Configuration Classes.................................................................................. 1151
Understanding the Drop Zone Configuration Classes......................................................................1151
DZComponentConfig Class........................................................................................................1151
DZContent Class.........................................................................................................................1151
DZConfig Class.......................................................................................................................... 1152
DZPage Class............................................................................................................................. 1152
DZComponentConfig Methods.........................................................................................................1152
AddConfig...................................................................................................................................1152
DZComponentConfig..................................................................................................................1153
GetConfigurationsForComponent...............................................................................................1154
GetConfigurationsForPage..........................................................................................................1155
GetConfigurationsForPagefield.................................................................................................. 1156
GetConfigurationsForSubpage....................................................................................................1157
RemoveAllConfigForComponent...............................................................................................1158
DZComponentConfig Properties.......................................................................................................1158
arrDZInfo.................................................................................................................................... 1158
DZConfig Methods........................................................................................................................... 1159
GetSubpageName........................................................................................................................1159
RemoveDZConfiguration............................................................................................................1160
Save.............................................................................................................................................1160
SetSubpageName........................................................................................................................ 1161
DZConfig Properties......................................................................................................................... 1161
IsERCConfigured........................................................................................................................1162
PageFldDescr.............................................................................................................................. 1162
PageFldId.................................................................................................................................... 1163
PageFldName.............................................................................................................................. 1163
PageName................................................................................................................................... 1164
TabOrder..................................................................................................................................... 1164
DZContent Methods..........................................................................................................................1164
DZContent...................................................................................................................................1164
GetConfiguration........................................................................................................................ 1165
DZPage Methods...............................................................................................................................1166
DZPage....................................................................................................................................... 1166
GetConfigurationFromPageField................................................................................................1166
GetConfigurationFromPageName.............................................................................................. 1167
Chapter 22: Exception Class.................................................................................................................1169
Understanding Exception Class........................................................................................................ 1169
How Exceptions Are Thrown........................................................................................................... 1169

Copyright © 1988, 2024, Oracle and/or its affiliates. xxxix

Contents

When to Use Exceptions.................................................................................................................. 1169

Try-Catch Blocks.............................................................................................................................. 1171
Data Type for Exception Class Objects........................................................................................... 1172
Scope of Exception Class Objects....................................................................................................1172
Exception Class Built-in Functions.................................................................................................. 1172
Exception Class Methods..................................................................................................................1172
GetSubstitution............................................................................................................................1172
Output......................................................................................................................................... 1173
SetSubstitution............................................................................................................................ 1174
ToString.......................................................................................................................................1175
Exception Class Properties............................................................................................................... 1175
Context........................................................................................................................................ 1175
DefaultText..................................................................................................................................1176
MessageNumber..........................................................................................................................1176
MessageSetNumber.................................................................................................................... 1176
MessageSeverity......................................................................................................................... 1176
StackTrace...................................................................................................................................1177
SubstitutionCount....................................................................................................................... 1177
Chapter 23: Feed Classes...................................................................................................................... 1179
Understanding the Feed Classes....................................................................................................... 1179
Importing Feed Classes.....................................................................................................................1181
Feed Class......................................................................................................................................... 1181
Feed Class Constructor..................................................................................................................... 1181
Feed.............................................................................................................................................1181
Feed Class Methods.......................................................................................................................... 1182
delete........................................................................................................................................... 1182
equals.......................................................................................................................................... 1183
execute........................................................................................................................................ 1183
getAttribute................................................................................................................................. 1184
load..............................................................................................................................................1185
loadFromTemplate...................................................................................................................... 1186
PopulateDSParamsWithDefaults................................................................................................ 1187
populatePrefData.........................................................................................................................1187
publishToSites.............................................................................................................................1188
resetFeedAttributes..................................................................................................................... 1189
resetFeedSecurities......................................................................................................................1189
save............................................................................................................................................. 1190
saveAs......................................................................................................................................... 1191
saveAsTemplate.......................................................................................................................... 1192
setAttribute..................................................................................................................................1192
setDataSourceById......................................................................................................................1193
unpublishFromSites.................................................................................................................... 1194
Feed Class Properties........................................................................................................................1195
Authorized...................................................................................................................................1195
CategoryID..................................................................................................................................1195
CreateDTTM...............................................................................................................................1195
CreateNode..................................................................................................................................1196
CreateOprID................................................................................................................................1196
CreatePortal.................................................................................................................................1196
DataSource.................................................................................................................................. 1196
DataTypeID.................................................................................................................................1196

xl Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Description.................................................................................................................................. 1197
FeedAttributes.............................................................................................................................1197
FeedAuthorizationOprID............................................................................................................ 1197
FeedAuthorizationOprPWD........................................................................................................1197
FeedAuthorizationType...............................................................................................................1197
FeedCacheTime...........................................................................................................................1198
FeedCacheType........................................................................................................................... 1198
FeedContentUrl...........................................................................................................................1198
FeedFactory.................................................................................................................................1198
FeedFormat................................................................................................................................. 1199
FeedSecurities............................................................................................................................. 1199
FeedSecurityType........................................................................................................................1199
FeedTemplate.............................................................................................................................. 1199
FeedUrl....................................................................................................................................... 1200
HasAdminParams........................................................................................................................1200
HasUserParams........................................................................................................................... 1200
IBOperationName....................................................................................................................... 1200
ID................................................................................................................................................ 1200
LastPubDTTM............................................................................................................................ 1201
LastUpdDTTM............................................................................................................................1201
LastUpdOprID............................................................................................................................ 1201
NameSpaceID............................................................................................................................. 1201
ObjectType.................................................................................................................................. 1201
OperatingMode........................................................................................................................... 1202
OwnerID..................................................................................................................................... 1202
PublishedInSites..........................................................................................................................1202
Title............................................................................................................................................. 1203
Utility.......................................................................................................................................... 1203
FeedFactory Class............................................................................................................................. 1203
FeedFactory Class Constructor......................................................................................................... 1204
FeedFactory.................................................................................................................................1204
FeedFactory Class Methods..............................................................................................................1204
convertFeedLinksToHoverMenu................................................................................................ 1204
convertFeedLinksToOPML........................................................................................................ 1205
createFeed................................................................................................................................... 1206
deleteFeed................................................................................................................................... 1206
genFeedUrl..................................................................................................................................1207
genUniqueFeedId........................................................................................................................ 1208
getAllPagedFeedLinks................................................................................................................ 1208
getCategory................................................................................................................................. 1210
getDataSource............................................................................................................................. 1210
getFeed........................................................................................................................................ 1211
getFeedDoc................................................................................................................................. 1213
getFeedLink................................................................................................................................ 1213
getFeedLinks...............................................................................................................................1214
getFeedTemplates........................................................................................................................1215
getRelatedFeedsHoverMenu.......................................................................................................1215
getRelativePageLinkForFeed......................................................................................................1216
FeedFactory Class Properties............................................................................................................1218
DataSources................................................................................................................................ 1218
Feeds........................................................................................................................................... 1218

Copyright © 1988, 2024, Oracle and/or its affiliates. xli

Contents

Utility.......................................................................................................................................... 1218
DataSource Class.............................................................................................................................. 1219
DataSource Class Constructor.......................................................................................................... 1219
DataSource.................................................................................................................................. 1219
DataSource Class Methods............................................................................................................... 1220
addParameter...............................................................................................................................1220
equals.......................................................................................................................................... 1221
getAttributeById......................................................................................................................... 1221
getContentUrl..............................................................................................................................1222
getDataSecurity...........................................................................................................................1223
getParameterById........................................................................................................................1223
getParameterDetail......................................................................................................................1224
getSettingById............................................................................................................................ 1225
getSettingDetail...........................................................................................................................1225
isCurrentUserAdmin................................................................................................................... 1226
isCurrentUserAuthorized............................................................................................................ 1226
onDelete...................................................................................................................................... 1227
onSave.........................................................................................................................................1227
resetParameters........................................................................................................................... 1228
DataSource Class Properties............................................................................................................. 1228
AdminPersonalizationPage......................................................................................................... 1229
AllowCustomParameters............................................................................................................ 1229
AllowRealTimeFeedSecurity...................................................................................................... 1229
DataSourceType.......................................................................................................................... 1229
DefaultFeedAttributes.................................................................................................................1229
DefaultIBOperationName........................................................................................................... 1230
Description.................................................................................................................................. 1230
HasParameters.............................................................................................................................1230
HasSettings................................................................................................................................. 1230
IBOperations............................................................................................................................... 1230
ID................................................................................................................................................ 1230
LongDescription..........................................................................................................................1231
ObjectType.................................................................................................................................. 1231
Parameters...................................................................................................................................1231
ParametersCompleted................................................................................................................. 1231
Parent.......................................................................................................................................... 1231
PortalSpecificPersonalization..................................................................................................... 1232
Settings........................................................................................................................................1232
SettingsCompleted...................................................................................................................... 1232
UserPersonalizationPage.............................................................................................................1232
Utility.......................................................................................................................................... 1232
DataSourceParameter Class.............................................................................................................. 1233
DataSourceParameter Class Constructor.......................................................................................... 1233
DataSourceParameter..................................................................................................................1233
DataSourceParameter Class Methods............................................................................................... 1233
addUserValue.............................................................................................................................. 1233
clone............................................................................................................................................ 1234
equals.......................................................................................................................................... 1234
resetUserValues...........................................................................................................................1235
setRangeFromFieldTranslates.....................................................................................................1235
validateValue...............................................................................................................................1236

xlii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

DataSourceParameter Class Properties.............................................................................................1237

AllowChangesToRequired.......................................................................................................... 1237
DefaultValue................................................................................................................................1237
DefaultValueForDisplay..............................................................................................................1237
Description.................................................................................................................................. 1237
EditType...................................................................................................................................... 1237
EvaluatedValue............................................................................................................................1238
FieldType.................................................................................................................................... 1238
ID................................................................................................................................................ 1239
Name........................................................................................................................................... 1239
ObjectType.................................................................................................................................. 1239
Parent.......................................................................................................................................... 1239
PromptTable................................................................................................................................ 1240
Range.......................................................................................................................................... 1240
Required...................................................................................................................................... 1240
SkipValidityChecks.....................................................................................................................1240
UsageType...................................................................................................................................1240
UserValues.................................................................................................................................. 1241
Utility.......................................................................................................................................... 1241
Value........................................................................................................................................... 1242
ValueForDisplay..........................................................................................................................1242
DataSourceParameterValue Class..................................................................................................... 1242
DataSourceParameterValue Class Constructor................................................................................. 1242
DataSourceParameterValue.........................................................................................................1242
DataSourceParameterValue Class Methods...................................................................................... 1243
clone............................................................................................................................................ 1243
equals.......................................................................................................................................... 1243
DataSourceParameterValue Class Properties....................................................................................1244
Description.................................................................................................................................. 1244
ID................................................................................................................................................ 1244
Name........................................................................................................................................... 1244
ObjectType.................................................................................................................................. 1244
OrderNumber.............................................................................................................................. 1244
Parent.......................................................................................................................................... 1245
Value........................................................................................................................................... 1245
DataSourceSetting Class................................................................................................................... 1245
DataSourceSetting Class Constructor............................................................................................... 1245
DataSourceSetting.......................................................................................................................1245
DataSourceSetting Class Methods....................................................................................................1246
clone............................................................................................................................................ 1246
equals.......................................................................................................................................... 1246
setRangeFromFieldTranslates.....................................................................................................1247
DataSourceSetting Class Properties..................................................................................................1247
DefaultValue................................................................................................................................1247
DisplayOnly................................................................................................................................ 1248
EditType...................................................................................................................................... 1248
Enabled....................................................................................................................................... 1248
FieldType.................................................................................................................................... 1248
ID................................................................................................................................................ 1249
LongName...................................................................................................................................1249
Name........................................................................................................................................... 1249

Copyright © 1988, 2024, Oracle and/or its affiliates. xliii

Contents

ObjectType.................................................................................................................................. 1250
Parent.......................................................................................................................................... 1250
PromptTable................................................................................................................................ 1250
Range.......................................................................................................................................... 1250
RefreshOnChange....................................................................................................................... 1250
RelatedFieldValue....................................................................................................................... 1251
Required...................................................................................................................................... 1251
ShowRelatedField....................................................................................................................... 1251
Utility.......................................................................................................................................... 1251
Value........................................................................................................................................... 1252
Visible......................................................................................................................................... 1252
Utility Class.......................................................................................................................................1252
Utility Class Constructor.................................................................................................................. 1252
Utility.......................................................................................................................................... 1252
Utility Class Methods....................................................................................................................... 1253
dateStringToUserPref..................................................................................................................1253
datetimeToString......................................................................................................................... 1253
dateToString................................................................................................................................ 1254
decodeXML................................................................................................................................ 1254
encodeXML................................................................................................................................ 1255
evaluateSysVar............................................................................................................................ 1256
genNameSpaceID........................................................................................................................1257
getExceptionText........................................................................................................................ 1257
getFeedDoc................................................................................................................................. 1258
getFeedMimeType...................................................................................................................... 1259
getFieldTranslates....................................................................................................................... 1260
getNodeValue.............................................................................................................................. 1260
getUserDateFormat..................................................................................................................... 1261
getUserDatetimeFormat.............................................................................................................. 1261
getUserInfo................................................................................................................................. 1262
httpStringToDatetime..................................................................................................................1262
join.............................................................................................................................................. 1263
join2D......................................................................................................................................... 1263
setMessageHeadersAndMimeType.............................................................................................1264
setNodeValue.............................................................................................................................. 1265
showException............................................................................................................................ 1266
showInvalidValueException........................................................................................................1266
split..............................................................................................................................................1267
split2D.........................................................................................................................................1268
stringToDate................................................................................................................................1269
stringToDatetime.........................................................................................................................1269
validateSysVar.............................................................................................................................1269
viewStringAsAttachment............................................................................................................ 1270
Utility Class Properties..................................................................................................................... 1271
ATTACHMENT_URL................................................................................................................1271
AUTHTYPE_PERM...................................................................................................................1271
AUTHTYPE_ROLE................................................................................................................... 1271
DSPARAMETER_INCREMENTAL......................................................................................... 1272
DSPARAMETER_MAXROW................................................................................................... 1272
DSPARAMETER_SF_MAXMINUTES.................................................................................... 1272
DSPARAMETER_SF_PAGING................................................................................................ 1273

xliv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

EDITTYPE_NOTABLEEDIT.................................................................................................... 1273
EDITTYPE_PROMPTTABLE................................................................................................... 1273
EDITTYPE_TRANSLATETABLE............................................................................................ 1273
EDITTYPE_YESNO.................................................................................................................. 1273
FEEDATTRIBUTE_AUTHOR.................................................................................................. 1274
FEEDATTRIBUTE_CLOUD..................................................................................................... 1274
FEEDATTRIBUTE_COMPLETE..............................................................................................1274
FEEDATTRIBUTE_CONTRIBUTOR...................................................................................... 1274
FEEDATTRIBUTE_COPYRIGHT............................................................................................ 1274
FEEDATTRIBUTE_EXPIRES...................................................................................................1275
FEEDATTRIBUTE_ICONURL................................................................................................. 1275
FEEDATTRIBUTE_LOGOURL................................................................................................1275
FEEDATTRIBUTE_MANAGINGEDITOR.............................................................................. 1275
FEEDATTRIBUTE_MAXAGE................................................................................................. 1275
FEEDATTRIBUTE_PERSINSTRUCTION...............................................................................1275
FEEDATTRIBUTE_RATING.................................................................................................... 1276
FEEDATTRIBUTE_SKIPDAYS................................................................................................1276
FEEDATTRIBUTE_SKIPHOURS.............................................................................................1276
FEEDATTRIBUTE_TEXTINPUT.............................................................................................1276
FEEDATTRIBUTE_TTL............................................................................................................1276
FEEDATTRIBUTE_WEBMASTER..........................................................................................1277
FEEDATTRIBUTE_XSL........................................................................................................... 1277
FEEDAUTHTYPE_ALL............................................................................................................1277
FEEDAUTHTYPE_ANONYMOUS..........................................................................................1277
FEEDAUTHTYPE_DEFAULT.................................................................................................. 1277
FEEDCACHETYPE_NONE...................................................................................................... 1277
FEEDCACHETYPE_PRIVATE................................................................................................. 1278
FEEDCACHETYPE_PUBLIC...................................................................................................1278
FEEDCACHETYPE_ROLE.......................................................................................................1278
FEEDFORMAT_ATOM10......................................................................................................... 1278
FEEDSECUTYPE_PUBLIC...................................................................................................... 1278
FEEDSECUTYPE_REALTIME.................................................................................................1278
FEEDSECUTYPE_SELECTED................................................................................................ 1279
FEEDTEMPLATE_NO.............................................................................................................. 1279
FEEDTEMPLATE_YES.............................................................................................................1279
FEEDTYPE_DYNAMIC............................................................................................................1279
FEEDTYPE_PREPUBLISHED................................................................................................. 1279
FIELDTYPE_CHARACTER..................................................................................................... 1280
FIELDTYPE_DATE................................................................................................................... 1280
FIELDTYPE_DATETIME......................................................................................................... 1280
FIELDTYPE_LONGCHARACTER.......................................................................................... 1280
FIELDTYPE_NUMBER............................................................................................................ 1280
FIELDTYPE_SIGNEDNUMBER..............................................................................................1280
FIELDTYPE_TIME....................................................................................................................1281
IBSOTYPE_ASYNC.................................................................................................................. 1281
IBSOTYPE_SYNC.....................................................................................................................1281
IBSOTYPE_UNKNOWN.......................................................................................................... 1281
ICONURL_FEED_A.................................................................................................................. 1281
ICONURL_FEED_IA.................................................................................................................1282
INCREMENTALOPTION_NO..................................................................................................1282
INCREMENTALOPTION_YES................................................................................................ 1282

Copyright © 1988, 2024, Oracle and/or its affiliates. xlv

Contents

LINKTYPE_FIRST.................................................................................................................... 1282
LINKTYPE_LAST..................................................................................................................... 1283
LINKTYPE_NEXT.................................................................................................................... 1283
LINKTYPE_PREVIOUS............................................................................................................1283
MIMETYPE_ATOM.................................................................................................................. 1283
MIMETYPE_OPML...................................................................................................................1284
MIMETYPE_XML.....................................................................................................................1284
OPERATINGMODE_AUTHORIZATION................................................................................ 1284
OPERATINGMODE_DEFAULT............................................................................................... 1284
OPERATINGMODE_DELETION.............................................................................................1284
OPERATINGMODE_EXECUTION..........................................................................................1285
OPERATINGMODE_EXECUTION_NOENTRY.....................................................................1285
QUERYPARAMETER_CHILDFEEDID...................................................................................1285
QUERYPARAMETER_DATATYPEID..................................................................................... 1285
QUERYPARAMETER_DEFLOCALNODE............................................................................. 1285
QUERYPARAMETER_DSSCOUNT........................................................................................ 1286
QUERYPARAMETER_DSSNAME.......................................................................................... 1286
QUERYPARAMETER_DSSVALUE.........................................................................................1286
QUERYPARAMETER_FEEDFORMAT................................................................................... 1286
QUERYPARAMETER_FEEDID............................................................................................... 1286
QUERYPARAMETER_FEEDLIST...........................................................................................1286
QUERYPARAMETER_FEEDTYPE......................................................................................... 1287
QUERYPARAMETER_IBTRANSID........................................................................................1287
QUERYPARAMETER_IFMODIFIEDSINCE...........................................................................1287
QUERYPARAMETER_IFNONEMATCH.................................................................................1287
QUERYPARAMETER_KEYWORD.........................................................................................1287
QUERYPARAMETER_LANGUAGE....................................................................................... 1287
QUERYPARAMETER_NODENAME...................................................................................... 1288
QUERYPARAMETER_PAGENUM..........................................................................................1288
QUERYPARAMETER_PORTALNAME.................................................................................. 1288
QUERYPARAMETER_PTPPB_SEARCH_MODE..................................................................1288
QUERYPARAMETER_PTPPB_SEARCH_TEXT................................................................... 1288
RequestInfo................................................................................................................................. 1288
SF_MAXMINUTES_ALLMSGS.............................................................................................. 1289
SF_MAXROWOPTION_ALLMSGS........................................................................................ 1289
SF_MAXROWOPTION_LATESTMSG....................................................................................1289
SF_PAGINGOPTION_NOPAGING.......................................................................................... 1290
SF_PAGINGOPTION_SEGMENTED.......................................................................................1290
SYSVAR_INVALID................................................................................................................... 1290
USAGETYPE_ADMINSPECIFIED.......................................................................................... 1291
USAGETYPE_FIXED............................................................................................................... 1291
USAGETYPE_INTERNAL....................................................................................................... 1291
USAGETYPE_NOTUSED.........................................................................................................1291
USAGETYPE_SYSVAR............................................................................................................ 1291
USAGETYPE_USERSPECIFIED............................................................................................. 1291
XMLCHILDELEMENTS_CLOUD...........................................................................................1292
XMLCHILDELEMENTS_PERSON......................................................................................... 1292
XMLCHILDELEMENTS_TEXTINPUT...................................................................................1292
XMLELEMENT_DAY...............................................................................................................1292
XMLELEMENT_DESCRIPTION............................................................................................. 1293
XMLELEMENT_DOMAIN.......................................................................................................1293

xlvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

XMLELEMENT_EMAIL.......................................................................................................... 1293
XMLELEMENT_HOUR............................................................................................................1293
XMLELEMENT_LINK..............................................................................................................1293
XMLELEMENT_NAME........................................................................................................... 1293
XMLELEMENT_PATH............................................................................................................. 1294
XMLELEMENT_PORT............................................................................................................. 1294
XMLELEMENT_PROTOCOL.................................................................................................. 1294
XMLELEMENT_REGISTERPROCEDURE............................................................................ 1294
XMLELEMENT_TITLE............................................................................................................ 1294
FeedDoc Class...................................................................................................................................1294
FeedDoc Class Constructor.............................................................................................................. 1295
FeedDoc...................................................................................................................................... 1295
FeedDoc Class Methods................................................................................................................... 1295
addCategory................................................................................................................................ 1295
addEntry...................................................................................................................................... 1296
datetimeToString......................................................................................................................... 1297
deleteCategory............................................................................................................................ 1298
deleteEntry.................................................................................................................................. 1298
equals.......................................................................................................................................... 1299
getEntry.......................................................................................................................................1299
resetEntries..................................................................................................................................1300
stringToDatetime.........................................................................................................................1300
FeedDoc Class Properties................................................................................................................. 1301
AllowMoreEntries.......................................................................................................................1301
ApplicationRelease..................................................................................................................... 1301
Categories....................................................................................................................................1301
ContentUrl...................................................................................................................................1302
Copyright.................................................................................................................................... 1302
Description.................................................................................................................................. 1302
Entries......................................................................................................................................... 1303
Expires........................................................................................................................................ 1303
FeedFormat................................................................................................................................. 1303
FeedUrl....................................................................................................................................... 1303
FirstUrl........................................................................................................................................ 1304
Generator.....................................................................................................................................1304
ID................................................................................................................................................ 1304
LastUrl........................................................................................................................................ 1305
Logo............................................................................................................................................ 1305
MaxAge.......................................................................................................................................1305
MaxEntries.................................................................................................................................. 1305
NextUrl....................................................................................................................................... 1306
ObjectType.................................................................................................................................. 1306
PreviousUrl................................................................................................................................. 1306
RootElement................................................................................................................................1307
Title............................................................................................................................................. 1307
Updated....................................................................................................................................... 1307
FeedEntry Class................................................................................................................................ 1307
FeedEntry Class Constructor............................................................................................................ 1308
FeedEntry.................................................................................................................................... 1308
FeedEntry Class Methods................................................................................................................. 1308
addCategory................................................................................................................................ 1308

Copyright © 1988, 2024, Oracle and/or its affiliates. xlvii

Contents

addContributor............................................................................................................................ 1309
addEnclosure...............................................................................................................................1310
delete........................................................................................................................................... 1310
deleteCategory............................................................................................................................ 1311
deleteContributor........................................................................................................................ 1312
deleteEnclosure........................................................................................................................... 1312
equals.......................................................................................................................................... 1313
FeedEntry Class Properties............................................................................................................... 1313
Author......................................................................................................................................... 1313
Categories....................................................................................................................................1314
Comments................................................................................................................................... 1314
ContentUrl...................................................................................................................................1314
Contributors................................................................................................................................ 1314
Copyright.................................................................................................................................... 1315
Description.................................................................................................................................. 1315
Enclosures................................................................................................................................... 1315
Expires........................................................................................................................................ 1315
FeedDoc...................................................................................................................................... 1316
FullContent................................................................................................................................. 1316
GUID...........................................................................................................................................1316
ID................................................................................................................................................ 1317
MaxAge.......................................................................................................................................1317
ObjectType.................................................................................................................................. 1317
Published.....................................................................................................................................1317
Title............................................................................................................................................. 1318
Updated....................................................................................................................................... 1318
Additional Feed Examples................................................................................................................1318
Implementing a Real-Time Feed Request Handler....................................................................1318
Chapter 24: Field Class......................................................................................................................... 1323
Understanding the Field Class..........................................................................................................1323
Considerations Using User Interface Properties........................................................................ 1323
Shortcut Considerations.................................................................................................................... 1323
Data Type for a Field Object............................................................................................................1324
Scope of a Field Object.................................................................................................................... 1324
Field Class Built-in Functions.......................................................................................................... 1324
Field Class Methods......................................................................................................................... 1324
AddDropDownItem.................................................................................................................... 1324
AddFFClass.................................................................................................................................1326
ClearDropDownList....................................................................................................................1326
CopyDisplayMask.......................................................................................................................1327
GetAuxFlag.................................................................................................................................1328
GetBaseName..............................................................................................................................1329
GetDNDField.............................................................................................................................. 1329
GetDNDRow...............................................................................................................................1330
GetDNDRowset.......................................................................................................................... 1331
GetDNDTargetField....................................................................................................................1331
GetDNDTargetRow.....................................................................................................................1332
GetDNDTargetRowset................................................................................................................ 1333
GetLongLabel............................................................................................................................. 1333
GetRelated...................................................................................................................................1334
GetShortLabel............................................................................................................................. 1335

xlviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

ReplaceFFClass...........................................................................................................................1336
SearchClear................................................................................................................................. 1337
SetCursorPos...............................................................................................................................1338
SetDefault....................................................................................................................................1339
SetDisplayMask.......................................................................................................................... 1340
SetGroupletActionUrl................................................................................................................. 1342
SetGroupletDisplayIn..................................................................................................................1343
SetGroupletEventMsg.................................................................................................................1344
SetGroupletID............................................................................................................................. 1344
SetGroupletImage....................................................................................................................... 1345
SetGroupletImageUrl.................................................................................................................. 1346
SetGroupletMOptions................................................................................................................. 1347
SetGroupletTargetID................................................................................................................... 1347
SetGroupletTimer........................................................................................................................1348
SetGroupletType......................................................................................................................... 1349
SetGroupletUrl............................................................................................................................ 1351
SetImageUrl................................................................................................................................ 1351
UnSetDisplayMask..................................................................................................................... 1352
Field Class Properties....................................................................................................................... 1353
AriaAttributes..............................................................................................................................1353
AriaWrapperAttributes................................................................................................................1353
DataAreaCollapsed..................................................................................................................... 1354
DecimalPosition.......................................................................................................................... 1354
DisplayFormat.............................................................................................................................1355
DisplayOnly................................................................................................................................ 1356
DisplayZero.................................................................................................................................1356
DisplayZeroChanged.................................................................................................................. 1357
Draggable.................................................................................................................................... 1357
Droppable....................................................................................................................................1358
EditError..................................................................................................................................... 1358
Enabled....................................................................................................................................... 1359
ErrorDisplay................................................................................................................................1359
FieldLength................................................................................................................................. 1359
ForceUpdateOnce........................................................................................................................1360
FormatLength..............................................................................................................................1360
FormattedValue........................................................................................................................... 1360
FreeFormStyleName................................................................................................................... 1361
HoverText....................................................................................................................................1362
HtmlAttributes............................................................................................................................ 1362
HtmlInputType............................................................................................................................ 1363
IsAltKey...................................................................................................................................... 1363
IsAuditFieldAdd......................................................................................................................... 1364
IsAuditFieldChg..........................................................................................................................1364
IsAuditFieldDel...........................................................................................................................1364
IsAutoUpdate.............................................................................................................................. 1364
IsChanged................................................................................................................................... 1364
IsDateRangeEdit......................................................................................................................... 1365
IsDescKey................................................................................................................................... 1365
IsDuplKey................................................................................................................................... 1365
IsEditTable.................................................................................................................................. 1365
IsEditXlat.................................................................................................................................... 1365

Copyright © 1988, 2024, Oracle and/or its affiliates. xlix

Contents

IsFromSearchField...................................................................................................................... 1366
IsGroupletAsLink........................................................................................................................1366
IsHyperlink................................................................................................................................. 1366
IsInBuf........................................................................................................................................ 1367
IsKey........................................................................................................................................... 1367
IsListItem.................................................................................................................................... 1367
IsNotUsed................................................................................................................................... 1368
IsRequired................................................................................................................................... 1368
IsRichTextEnabled...................................................................................................................... 1368
IsSearchItem................................................................................................................................1368
IsSystem...................................................................................................................................... 1368
IsThroughSearchField.................................................................................................................1369
IsUseDefaultLabel...................................................................................................................... 1369
IsYesNo....................................................................................................................................... 1369
JavaScriptEvents......................................................................................................................... 1369
Label........................................................................................................................................... 1370
LabelImage..................................................................................................................................1371
LabelStyle................................................................................................................................... 1371
LongTranslateValue.................................................................................................................... 1372
MessageNumber..........................................................................................................................1372
MessageSetNumber.................................................................................................................... 1373
MouseOverMsgNum...................................................................................................................1373
MouseOverMsgSet..................................................................................................................... 1374
Name........................................................................................................................................... 1374
OriginalValue.............................................................................................................................. 1375
ParentRecord...............................................................................................................................1375
PlaceholderText...........................................................................................................................1375
PromptTableName...................................................................................................................... 1376
SearchDefault..............................................................................................................................1376
SearchEdit................................................................................................................................... 1376
SetComponentChanged...............................................................................................................1377
ShortTranslateValue.................................................................................................................... 1378
ShowRequiredFieldCue.............................................................................................................. 1378
SmartZero....................................................................................................................................1379
SqlText........................................................................................................................................ 1379
StoredFormat...............................................................................................................................1380
Style............................................................................................................................................ 1380
Type.............................................................................................................................................1381
Value........................................................................................................................................... 1382
Visible......................................................................................................................................... 1383
Chapter 25: File Class........................................................................................................................... 1385
Understanding File Layout............................................................................................................... 1385
Data Type of a File Object............................................................................................................... 1385
Scope of a File Object......................................................................................................................1385
File Security Considerations............................................................................................................. 1386
File Access Interruption Recovery................................................................................................... 1386
Plain Text Files................................................................................................................................. 1387
Automatic PeopleCode Generation...................................................................................................1388
End Of Line Considerations............................................................................................................. 1389
File Layout Error Processing............................................................................................................1389
Working With Relative Paths........................................................................................................... 1390

l Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

File Class Built-in Functions............................................................................................................ 1391

File Class Methods........................................................................................................................... 1391
Close........................................................................................................................................... 1391
CreateRowset.............................................................................................................................. 1392
Delete.......................................................................................................................................... 1393
GenerateHttpURL....................................................................................................................... 1394
GetBase64StringFromBinary......................................................................................................1395
GetPosition..................................................................................................................................1395
GetString..................................................................................................................................... 1396
Open............................................................................................................................................ 1398
ReadFileStream...........................................................................................................................1403
ReadLine..................................................................................................................................... 1404
ReadRowset................................................................................................................................ 1405
SetFileId...................................................................................................................................... 1407
SetFileLayout.............................................................................................................................. 1409
SetPosition.................................................................................................................................. 1410
SetRecTerminator........................................................................................................................1411
WriteBase64StringToBinary....................................................................................................... 1412
WriteLine.................................................................................................................................... 1413
WriteRaw.................................................................................................................................... 1415
WriteRecord................................................................................................................................ 1415
WriteRowset................................................................................................................................1417
WriteString..................................................................................................................................1419
File Class Properties......................................................................................................................... 1420
CurrentRecord.............................................................................................................................1420
IgnoreInvalidId............................................................................................................................1421
IsError......................................................................................................................................... 1421
IsNewFileId.................................................................................................................................1422
IsOpen......................................................................................................................................... 1422
Name........................................................................................................................................... 1423
TerminateLines............................................................................................................................1423
UseSpaceForNull........................................................................................................................ 1424
ZeroExtend..................................................................................................................................1426
File Layout Examples....................................................................................................................... 1427
WriteRecord Example.................................................................................................................1428
ReadRecord Example................................................................................................................. 1430
WriteRowset Example................................................................................................................ 1431
ReadRowset Example.................................................................................................................1434
File Rowset Considerations........................................................................................................1434
Application Engine Example......................................................................................................1435
Multiple File Layouts........................................................................................................................1437
Reading Multiple File Layouts.................................................................................................. 1438
Writing Multiple File Layouts................................................................................................... 1440
Chapter 26: Fluid Page Utilities Classes............................................................................................. 1443
Understanding the Fluid Page Utilities Classes............................................................................... 1443
Banner Class......................................................................................................................................1443
Banner Class Methods...................................................................................................................... 1444
ClearConfirmation...................................................................................................................... 1444
GetFixedPageTitleField.............................................................................................................. 1445
GetPageTitleField....................................................................................................................... 1445
SetConfirmationMessage............................................................................................................ 1446

Copyright © 1988, 2024, Oracle and/or its affiliates. li

Contents

SetContextMenuLabel................................................................................................................ 1446
SetFixedPageTitle....................................................................................................................... 1447
SetPageTitle................................................................................................................................ 1448
SetVisibilityActionList................................................................................................................1448
SetVisibilityAddto.......................................................................................................................1449
SetVisibilityContextMenu...........................................................................................................1450
SetVisibilityHelp.........................................................................................................................1450
SetVisibilityHome.......................................................................................................................1451
SetVisibilityMyPreferences........................................................................................................ 1452
SetVisibilityNavbar.....................................................................................................................1453
SetVisibilityNewWindow........................................................................................................... 1454
SetVisibilityNotifications............................................................................................................1454
SetVisibilityNotify...................................................................................................................... 1455
SetVisibilityQAB........................................................................................................................ 1456
SetVisibilitySearch......................................................................................................................1457
SetVisibilitySignout.................................................................................................................... 1458
Banner Class Properties.................................................................................................................... 1458
isGuidedDisplay..........................................................................................................................1459
DynamicScreenReader Class Properties...........................................................................................1459
SuppressCommonActionItem..................................................................................................... 1459
PanelController Class........................................................................................................................1460
Understanding Panel Modes.......................................................................................................1460
PanelController Class Methods.........................................................................................................1460
GetSide1Mode............................................................................................................................ 1460
GetSide1Panel.............................................................................................................................1461
GetSide2Mode............................................................................................................................ 1462
GetSide2Panel.............................................................................................................................1463
Initialize...................................................................................................................................... 1463
IsSide1Collapsible...................................................................................................................... 1464
IsSide1CollisionInterPage...........................................................................................................1465
IsSide1CollisionIntraPage...........................................................................................................1465
IsSide1Enabled............................................................................................................................1466
IsSide1Fixed............................................................................................................................... 1466
IsSide1FullWidth........................................................................................................................ 1467
IsSide1HasCollision....................................................................................................................1468
IsSide1Hidden.............................................................................................................................1468
IsSide1Open................................................................................................................................ 1469
IsSide1Overlay............................................................................................................................1470
IsSide2Collapsible...................................................................................................................... 1470
IsSide2Enabled............................................................................................................................1471
IsSide2Fixed............................................................................................................................... 1471
IsSide2FullWidth........................................................................................................................ 1472
IsSide2Hidden.............................................................................................................................1473
IsSide2Open................................................................................................................................ 1473
IsSide2Overlay............................................................................................................................1474
Refresh........................................................................................................................................ 1475
SetSide1FullWidth...................................................................................................................... 1475
SetSide1Hidden...........................................................................................................................1476
SetSide1ModeCollapsible...........................................................................................................1477
SetSide1ModeFixed.................................................................................................................... 1478
SetSide1ModeOverlay................................................................................................................ 1478

lii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

SetSide1OpenState......................................................................................................................1479
SetSide1OverrideMediaQueries..................................................................................................1480
SetSide2FullWidth...................................................................................................................... 1481
SetSide2Hidden...........................................................................................................................1481
SetSide2ModeCollapsible...........................................................................................................1482
SetSide2ModeFixed.................................................................................................................... 1483
SetSide2ModeOverlay................................................................................................................ 1483
SetSide2OpenState......................................................................................................................1484
SetSide2OverrideMediaQueries..................................................................................................1485
UpdatePanel................................................................................................................................ 1486
UseForceOpenModeSide1.......................................................................................................... 1486
UseForceOpenModeSide2.......................................................................................................... 1487
UsePersistentOpenModeSide1....................................................................................................1488
UsePersistentOpenModeSide2....................................................................................................1489
PanelController Class Properties...................................................................................................... 1490
AutoUpdate................................................................................................................................. 1490
InDefaultMode............................................................................................................................ 1491
Utils Class......................................................................................................................................... 1491
Confirmation Message Methods................................................................................................ 1491
Toggle Button Methods.............................................................................................................. 1491
Viewport Methods...................................................................................................................... 1492
Miscellaneous Methods.............................................................................................................. 1492
Utils Class Methods.......................................................................................................................... 1492
AnnounceText............................................................................................................................. 1492
ClearConfirmationMessage........................................................................................................ 1493
CloseConfirmationMessage........................................................................................................ 1493
GetButtonState............................................................................................................................ 1494
GetDefaultViewport.................................................................................................................... 1495
SetButtonState.............................................................................................................................1496
SetConfirmationMessage............................................................................................................ 1496
SetCustomViewport.................................................................................................................... 1497
SetDefaultViewport.....................................................................................................................1498
SetFavIcon.................................................................................................................................. 1498
ToggleButtonState.......................................................................................................................1499
Chapter 27: GlobalEventMapping Class.............................................................................................1501
Understanding the GlobalEventMapping Class................................................................................1501
GlobalEventMapping Class Methods............................................................................................... 1501
CreateGlobalEventMappingConfig............................................................................................ 1501
DeleteGlobalEventMappingConfig............................................................................................ 1502
Chapter 28: Grid Classes...................................................................................................................... 1505
Understanding Grid and GridColumn Classes................................................................................. 1505
Shortcut Considerations.................................................................................................................... 1505
The Grid Class in PeopleCode......................................................................................................... 1506
Data Type for a Grid or Grid Column Object..................................................................................1507
Scope of a Grid or Grid Column Object..........................................................................................1507
Grid Class Built-in Function............................................................................................................ 1507
Grid Class Methods.......................................................................................................................... 1507
EnableColumns........................................................................................................................... 1507
GetColumn.................................................................................................................................. 1508
LabelColumns............................................................................................................................. 1510
SetProperties............................................................................................................................... 1511

Copyright © 1988, 2024, Oracle and/or its affiliates. liii

Contents

SetRowHeader............................................................................................................................ 1512
ShowColumns............................................................................................................................. 1513
Grid Class Properties........................................................................................................................ 1514
FreeFormStyleName................................................................................................................... 1514
gridcolumn.................................................................................................................................. 1514
Label........................................................................................................................................... 1515
Layout......................................................................................................................................... 1515
PersistMenuOption......................................................................................................................1516
RowHighlight..............................................................................................................................1517
Selector........................................................................................................................................1517
SummaryText.............................................................................................................................. 1519
GridColumn Class.............................................................................................................................1520
GridColumn Class Properties........................................................................................................... 1520
Enabled....................................................................................................................................... 1520
IncludeLabelsInGridCells........................................................................................................... 1521
IsUserHidden.............................................................................................................................. 1521
Label........................................................................................................................................... 1522
Name........................................................................................................................................... 1522
RowHeader..................................................................................................................................1523
Visible......................................................................................................................................... 1523
Chapter 29: Internet Script Classes (iScript)..................................................................................... 1525
Understanding Internet Script Classes..............................................................................................1525
URL vs. URI.....................................................................................................................................1526
Web Libraries.................................................................................................................................... 1526
iScript Security..................................................................................................................................1528
When to Use an iScript.................................................................................................................... 1528
Style Sheets and Styles.............................................................................................................. 1529
Other Considerations.................................................................................................................. 1529
Details of an iScript URL.................................................................................................................1530
The Generate Functions.................................................................................................................... 1530
Error Handling.................................................................................................................................. 1532
Scope of the Internet Script Classes.................................................................................................1532
Data Types of the iScript Classes.....................................................................................................1533
Internet Script Classes...................................................................................................................... 1533
Request Class..............................................................................................................................1533
Response..................................................................................................................................... 1534
Cookies....................................................................................................................................... 1534
Internet Script Classes Built-in Functions........................................................................................1534
Request Class Methods.....................................................................................................................1535
FormFactor..................................................................................................................................1535
GetContentBody..........................................................................................................................1536
GetCookieNames........................................................................................................................ 1537
GetCookieValue.......................................................................................................................... 1537
GetDeviceInfo.............................................................................................................................1537
GetHeader................................................................................................................................... 1540
GetHeaderNames........................................................................................................................ 1540
GetHelpURL............................................................................................................................... 1540
GetParameter...............................................................................................................................1541
GetParameterNames....................................................................................................................1541
GetParameterValues.................................................................................................................... 1541
Request Class Properties...................................................................................................................1541

liv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

AuthTokenDomain......................................................................................................................1542
AuthType.....................................................................................................................................1542
BrowserDeviceFormFactor.........................................................................................................1542
BrowserDeviceType....................................................................................................................1543
BrowserFluidCapable..................................................................................................................1544
BrowserPlatform......................................................................................................................... 1544
BrowserPlatformClass................................................................................................................ 1544
BrowserType............................................................................................................................... 1545
BrowserTypeClass...................................................................................................................... 1545
BrowserVersion...........................................................................................................................1545
ByPassSignOn.............................................................................................................................1546
ContentURI................................................................................................................................. 1546
ExpireMeta..................................................................................................................................1546
ExtraLarge...................................................................................................................................1547
FullURI....................................................................................................................................... 1547
HTTPMethod.............................................................................................................................. 1547
Large........................................................................................................................................... 1548
LogoutURL................................................................................................................................. 1548
Medium....................................................................................................................................... 1548
PathInfo.......................................................................................................................................1549
Protocol....................................................................................................................................... 1549
QueryString.................................................................................................................................1549
RelativeURL............................................................................................................................... 1550
RemoteAddr................................................................................................................................ 1550
RemoteHost.................................................................................................................................1550
RequestURI.................................................................................................................................1550
RemoteUser.................................................................................................................................1551
Scheme........................................................................................................................................ 1551
ServerName.................................................................................................................................1552
ServerPort................................................................................................................................... 1552
ServletPath.................................................................................................................................. 1552
Small........................................................................................................................................... 1553
Timeout....................................................................................................................................... 1553
Response Class..................................................................................................................................1553
Response Class Methods.................................................................................................................. 1553
Clear............................................................................................................................................ 1553
CreateCookie...............................................................................................................................1554
GetCookie................................................................................................................................... 1554
GetCookieNames........................................................................................................................ 1554
GetHeader................................................................................................................................... 1555
GetHeaderNames........................................................................................................................ 1555
GetImageURL.............................................................................................................................1555
GetJavaScriptURL...................................................................................................................... 1556
GetStyleSheetURL......................................................................................................................1556
RedirectURL............................................................................................................................... 1557
SetContentType...........................................................................................................................1558
SetHeader.................................................................................................................................... 1558
UseSimpleURL........................................................................................................................... 1559
Write............................................................................................................................................1559
WriteLine.................................................................................................................................... 1560
Response Class Properties................................................................................................................ 1560

Copyright © 1988, 2024, Oracle and/or its affiliates. lv

Contents

Charset........................................................................................................................................ 1561
DefaultStyleSheetName.............................................................................................................. 1561
Cookie Class......................................................................................................................................1561
Cookie Class Properties.................................................................................................................... 1561
Domain........................................................................................................................................1561
MaxAge.......................................................................................................................................1562
Name........................................................................................................................................... 1562
Path............................................................................................................................................. 1562
Secure..........................................................................................................................................1562
Value........................................................................................................................................... 1563
Chapter 30: Java Class..........................................................................................................................1565
Understanding Java Class................................................................................................................. 1565
Supported Versions of Java.............................................................................................................. 1565
Java Packages and Classes Delivered with PeopleTools..................................................................1565
System Setup for Java Classes......................................................................................................... 1566
From PeopleCode to Java.................................................................................................................1567
State Management Concerns...................................................................................................... 1567
CreateJavaObject Example.........................................................................................................1568
CreateJavaArray Example.......................................................................................................... 1569
GetJavaClass Example............................................................................................................... 1569
From Java to PeopleCode.................................................................................................................1569
SysVar Java Class.......................................................................................................................1570
SysCon Java Class......................................................................................................................1570
Func Java Class.......................................................................................................................... 1570
Name Java Class........................................................................................................................ 1570
Accessing PeopleCode Objects.................................................................................................. 1571
Using Application Classes From Java to PeopleCode...............................................................1572
PeopleCode and Java Data Types Mapping..................................................................................... 1573
Considerations When Using the PeopleCode Java Functions.......................................................... 1574
Copying Arrays of Data Between PeopleCode and Java................................................................. 1575
Considerations Working with the Java Garbage Collector...............................................................1575
Error Handling and the PeopleCode Java Functions........................................................................1576
The Java Debugging Environment................................................................................................... 1576
Data Type of a Java Object.............................................................................................................. 1577
Scope of a Java Object..................................................................................................................... 1577
PeopleCode Java Built-in Functions.................................................................................................1577
Chapter 31: JSON Classes.................................................................................................................... 1579
Understanding JSON Classes........................................................................................................... 1579
JsonObject Class............................................................................................................................... 1579
JsonObject Class Methods................................................................................................................ 1579
AddJsonArray............................................................................................................................. 1579
AddJsonObject............................................................................................................................ 1580
AddProperty................................................................................................................................ 1581
GetAsString.................................................................................................................................1581
GetBoolean..................................................................................................................................1582
GetBooleanProperty....................................................................................................................1582
GetChildCount............................................................................................................................ 1583
GetDate....................................................................................................................................... 1583
GetDateTime............................................................................................................................... 1584
GetFloat.......................................................................................................................................1585
GetInteger....................................................................................................................................1585

lvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

GetJsonArray.............................................................................................................................. 1586
GetJsonNode............................................................................................................................... 1586
GetJsonObject............................................................................................................................. 1587
GetNumber..................................................................................................................................1587
GetPropertyNameAt....................................................................................................................1588
GetString..................................................................................................................................... 1588
GetTime.......................................................................................................................................1589
IsExist......................................................................................................................................... 1590
IsJsonArray................................................................................................................................. 1590
IsJsonObject................................................................................................................................ 1591
IsNullProperty.............................................................................................................................1591
ToString.......................................................................................................................................1592
JsonObject Class Properties..............................................................................................................1592
ChildCount.................................................................................................................................. 1593
JsonValue Class.................................................................................................................................1593
JsonValue Class Methods..................................................................................................................1593
GetBoolean..................................................................................................................................1593
GetDate....................................................................................................................................... 1594
GetDateTime............................................................................................................................... 1594
GetInteger....................................................................................................................................1595
GetNumber..................................................................................................................................1595
GetString..................................................................................................................................... 1596
GetTime.......................................................................................................................................1596
GetValue......................................................................................................................................1597
IsNull...........................................................................................................................................1597
SetBoolean.................................................................................................................................. 1598
SetDate........................................................................................................................................ 1598
SetDateTime................................................................................................................................1599
SetFalse....................................................................................................................................... 1599
SetInteger.................................................................................................................................... 1600
SetNull........................................................................................................................................ 1600
SetNumber.................................................................................................................................. 1601
SetString......................................................................................................................................1601
SetTrue........................................................................................................................................ 1602
ToString.......................................................................................................................................1602
JsonValue Class Properties............................................................................................................... 1603
ValueType....................................................................................................................................1603
JsonArray Class.................................................................................................................................1603
JsonArray Class Methods................................................................................................................. 1603
AddElement................................................................................................................................ 1603
AddJsonArrayElement................................................................................................................ 1604
AddJsonObjectElement............................................................................................................. 1605
AddNullElement......................................................................................................................... 1605
GetAsString.................................................................................................................................1606
GetBoolean..................................................................................................................................1606
GetDate....................................................................................................................................... 1607
GetDateTime............................................................................................................................... 1607
GetFloat.......................................................................................................................................1608
GetInteger....................................................................................................................................1608
GetJsonArray.............................................................................................................................. 1609
GetJsonNode............................................................................................................................... 1610

Copyright © 1988, 2024, Oracle and/or its affiliates. lvii

Contents

GetJsonObject............................................................................................................................. 1610
GetNumber..................................................................................................................................1611
GetString..................................................................................................................................... 1611
GetTime.......................................................................................................................................1612
GetType.......................................................................................................................................1612
IsNull...........................................................................................................................................1613
Length......................................................................................................................................... 1613
Pop.............................................................................................................................................. 1614
Remove....................................................................................................................................... 1614
ToString.......................................................................................................................................1615
JsonArray Class Properties............................................................................................................... 1615
Size..............................................................................................................................................1616
JsonNode Class................................................................................................................................. 1616
JsonNode Class Methods.................................................................................................................. 1616
GetBoolean..................................................................................................................................1616
GetFloat.......................................................................................................................................1617
GetInteger....................................................................................................................................1617
GetJsonArray............................................................................................................................. 1618
GetJsonObject............................................................................................................................1618
GetJsonValue...............................................................................................................................1619
GetNodeType.............................................................................................................................. 1619
GetNumber..................................................................................................................................1620
GetParentNode............................................................................................................................ 1620
GetString..................................................................................................................................... 1621
GetValueType..............................................................................................................................1621
IsJsonArray................................................................................................................................. 1622
IsJsonObject................................................................................................................................ 1623
IsJsonValue................................................................................................................................. 1623
IsNull...........................................................................................................................................1624
SetBoolean.................................................................................................................................. 1624
SetDate........................................................................................................................................ 1625
SetDateTime................................................................................................................................1625
SetFalse....................................................................................................................................... 1626
SetFloat....................................................................................................................................... 1626
SetInteger.................................................................................................................................... 1627
SetJsonArray............................................................................................................................... 1627
SetJsonObject..............................................................................................................................1628
SetJsonValue............................................................................................................................... 1628
SetNodeName............................................................................................................................. 1629
SetNull........................................................................................................................................ 1630
SetNumber.................................................................................................................................. 1630
SetString......................................................................................................................................1631
SetTime....................................................................................................................................... 1631
SetTrue........................................................................................................................................ 1632
ToString.......................................................................................................................................1632
JsonNode Class Properties................................................................................................................1633
NodeType.................................................................................................................................... 1633
ValueType....................................................................................................................................1633
JsonBuilder Class.............................................................................................................................. 1633
JsonBuilder Class Methods...............................................................................................................1633
AddElement................................................................................................................................ 1634

lviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

AddNullElement......................................................................................................................... 1634
AddNullProperty.........................................................................................................................1635
AddProperty................................................................................................................................ 1635
EndArray.....................................................................................................................................1636
EndObject....................................................................................................................................1636
GetBuildMode.............................................................................................................................1637
GetRootNode.............................................................................................................................. 1638
StartArray....................................................................................................................................1638
StartArrayReturnsTrue................................................................................................................1639
StartObject.................................................................................................................................. 1639
StartObjectReturnsTrue...............................................................................................................1640
ToString.......................................................................................................................................1640
JsonBuilder Class Properties............................................................................................................ 1641
BuildMode.................................................................................................................................. 1641
JsonParser Class................................................................................................................................ 1641
JsonParser Class Methods.................................................................................................................1641
GetRootObject............................................................................................................................ 1641
Parse............................................................................................................................................ 1642
ToString.......................................................................................................................................1642
Chapter 32: Mail Classes...................................................................................................................... 1645
Understanding PeopleSoft MultiChannel Framework Mail Classes................................................ 1645
PeopleSoft MultiChannel Framework Mail Classes.................................................................. 1645
Scope of the Mail Classes..........................................................................................................1645
Data Types of the Mail Classes................................................................................................. 1646
Importing Mail Classes.....................................................................................................................1646
Creating a Mail Object..................................................................................................................... 1647
Using the Mail Classes..................................................................................................................... 1647
Life Cycle of an Outbound Email............................................................................................. 1647
Delivery Status Notification and Return Receipts..................................................................... 1648
Priority........................................................................................................................................ 1648
MCFBodyPart and MCFEmail Considerations..........................................................................1649
Retrieving Email From a Mail Server With the MCFGetMail Class............................................... 1651
Structure of Rowset Used for Email Information......................................................................1651
Error Messages Returned by MCFGetMail Class Methods.......................................................1657
Mail Classes Constructors................................................................................................................ 1659
MCFBodyPart............................................................................................................................. 1659
MCFGetMail...............................................................................................................................1659
MCFOutboundEmail...................................................................................................................1659
MCFMailStore............................................................................................................................ 1659
SMTPSession.............................................................................................................................. 1659
MCFBodyPart Class..........................................................................................................................1659
MCFBodyPart Class Methods.......................................................................................................... 1660
AddHeader.................................................................................................................................. 1660
GetHeader................................................................................................................................... 1661
GetHeaderCount..........................................................................................................................1662
GetHeaderName..........................................................................................................................1662
GetHeaderNames........................................................................................................................ 1663
GetHeaderValues.........................................................................................................................1663
GetUnparsedHeaders.................................................................................................................. 1664
SetAttachmentContent................................................................................................................ 1665
MCFBodyPart Class Properties........................................................................................................ 1666

Copyright © 1988, 2024, Oracle and/or its affiliates. lix

Contents

AttachmentURL.......................................................................................................................... 1666
Charset........................................................................................................................................ 1667
ContentType................................................................................................................................ 1667
Description.................................................................................................................................. 1667
Disposition.................................................................................................................................. 1667
Filename......................................................................................................................................1668
FilePath....................................................................................................................................... 1668
FilePathType............................................................................................................................... 1668
IsAttachment............................................................................................................................... 1669
MultiPart..................................................................................................................................... 1669
Text..............................................................................................................................................1669
MCFEmail Class............................................................................................................................... 1670
MCFEmail Class Properties..............................................................................................................1670
BCC.............................................................................................................................................1670
BounceTo.................................................................................................................................... 1670
CC............................................................................................................................................... 1671
From............................................................................................................................................ 1671
Importance.................................................................................................................................. 1671
Priority........................................................................................................................................ 1672
Recipients....................................................................................................................................1672
RefIDs......................................................................................................................................... 1672
ReplyIDs..................................................................................................................................... 1672
ReplyTo.......................................................................................................................................1673
Sender......................................................................................................................................... 1673
Sensitivity................................................................................................................................... 1673
Subject.........................................................................................................................................1673
Text..............................................................................................................................................1674
MCFGetMail Class Methods............................................................................................................ 1674
CreateQuarantineFolder.............................................................................................................. 1674
GetCount..................................................................................................................................... 1674
GetEmailCount............................................................................................................................1675
ReadAllEmailHeadersWithAttach.............................................................................................. 1676
ReadEmails................................................................................................................................. 1677
ReadEmailsWithAttach...............................................................................................................1678
ReadEmailsWithUID.................................................................................................................. 1679
ReadEmailWithAttach................................................................................................................ 1679
ReadHeaders............................................................................................................................... 1680
RemoveEmail..............................................................................................................................1681
RemoveEmails............................................................................................................................ 1682
SetMCFEmail..............................................................................................................................1683
MCFGetMail Class Properties..........................................................................................................1684
AttachmentRoot.......................................................................................................................... 1684
ContentTypes.............................................................................................................................. 1685
ErrorCount.................................................................................................................................. 1685
IBNode........................................................................................................................................ 1685
MailServer...................................................................................................................................1686
Password..................................................................................................................................... 1686
QuarantineCount......................................................................................................................... 1686
QuarantineFolder........................................................................................................................ 1687
Status...........................................................................................................................................1687
UserID.........................................................................................................................................1688

lx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

MCFInboundEmail Class..................................................................................................................1688
MCFInboundEmail Class Methods...................................................................................................1688
DumpToFile................................................................................................................................ 1688
GetAttachments...........................................................................................................................1689
GetFrom...................................................................................................................................... 1690
GetParts.......................................................................................................................................1690
GetSender....................................................................................................................................1691
ReadFromDatabase..................................................................................................................... 1691
SaveToDatabase.......................................................................................................................... 1692
MCFInboundEmail Class Properties................................................................................................ 1692
AttachList....................................................................................................................................1692
AttachSizes..................................................................................................................................1693
DttmReceived..............................................................................................................................1693
DttmSaved...................................................................................................................................1693
DttmSent..................................................................................................................................... 1694
IBNode........................................................................................................................................ 1694
Language.....................................................................................................................................1694
MessageID.................................................................................................................................. 1694
NotifyCC.....................................................................................................................................1695
NotifyTo...................................................................................................................................... 1695
OffsetReceived............................................................................................................................1695
OffsetSent....................................................................................................................................1695
Server.......................................................................................................................................... 1696
Size..............................................................................................................................................1696
Status...........................................................................................................................................1696
UID............................................................................................................................................. 1696
User............................................................................................................................................. 1696
MCFMailStore Class.........................................................................................................................1696
MCFMailStore Import Statements....................................................................................................1697
MCFMailStore Methods................................................................................................................... 1697
AuthorizeEmailAttach................................................................................................................ 1697
DeleteEmail.................................................................................................................................1698
RetrieveEmail..............................................................................................................................1699
StoreEmail...................................................................................................................................1699
MCFMailUtil Class...........................................................................................................................1701
MCFMailUtil Class Methods............................................................................................................1701
DecodeText................................................................................................................................. 1701
DecodeWord................................................................................................................................1702
EncodeText..................................................................................................................................1703
EncodeWord................................................................................................................................1705
GetErrorMsgParam..................................................................................................................... 1706
IsDomainNameValid...................................................................................................................1707
IsEmailServerAvailable...............................................................................................................1708
ParseRichTextHtml..................................................................................................................... 1709
ValidateAddress.......................................................................................................................... 1710
MCFMailUtil Class Properties......................................................................................................... 1711
badaddresses................................................................................................................................1712
ErrorDescription..........................................................................................................................1712
ErrorDetails.................................................................................................................................1712
ErrorMsgParamsCount................................................................................................................1713
imagesLocation........................................................................................................................... 1713

Copyright © 1988, 2024, Oracle and/or its affiliates. lxi

Contents

MessageNumber..........................................................................................................................1713
MessageSetNumber.................................................................................................................... 1714
MCFMultiPart Class......................................................................................................................... 1714
MCFMultiPart Class Methods.......................................................................................................... 1714
AddBodyPart...............................................................................................................................1714
GetBodyPart................................................................................................................................1715
GetContentType.......................................................................................................................... 1715
GetCount..................................................................................................................................... 1715
MCFMultiPart Class Property.......................................................................................................... 1716
SubType...................................................................................................................................... 1716
MCFOutboundEmail Class............................................................................................................... 1716
MCFOutboundEmail Class Methods................................................................................................ 1716
AddAttachment........................................................................................................................... 1717
AddHeader.................................................................................................................................. 1718
AddImportedAttachment............................................................................................................ 1719
GetErrorMsgParam..................................................................................................................... 1720
GetHeader................................................................................................................................... 1721
GetHeaderCount..........................................................................................................................1721
GetHeaderName..........................................................................................................................1722
GetHeaderNames........................................................................................................................ 1722
GetHeaderValues.........................................................................................................................1723
Send.............................................................................................................................................1724
SetSMTPParam...........................................................................................................................1725
MCFOutboundEmail Class Properties..............................................................................................1726
BackupSMTPPort....................................................................................................................... 1726
BackupSMTPServer....................................................................................................................1726
BackupSMTPSSLClientCertAlias.............................................................................................. 1726
BackupSMTPSSLPort................................................................................................................ 1726
BackupSMTPUserName.............................................................................................................1727
BackupSMTPUserPassword....................................................................................................... 1727
BackupSMTPUseSSL.................................................................................................................1727
BCC.............................................................................................................................................1727
BounceTo.................................................................................................................................... 1728
CC............................................................................................................................................... 1728
Charset........................................................................................................................................ 1728
ContentLanguage........................................................................................................................ 1728
ContentType................................................................................................................................ 1729
DefaultCharSet............................................................................................................................1729
Description.................................................................................................................................. 1729
Disposition.................................................................................................................................. 1729
ErrorDescription..........................................................................................................................1730
ErrorDetails.................................................................................................................................1730
ErrorMsgParamsCount................................................................................................................1730
Filename......................................................................................................................................1731
FilePath....................................................................................................................................... 1731
FilePathType............................................................................................................................... 1731
From............................................................................................................................................ 1732
Importance.................................................................................................................................. 1732
InvalidAddresses.........................................................................................................................1733
IsAuthenticationReqd..................................................................................................................1733
IsOkToSendPartial...................................................................................................................... 1733

lxii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

IsReturnReceiptReqd.................................................................................................................. 1734
MessageNumber..........................................................................................................................1734
MessageSetNumber.................................................................................................................... 1734
MultiPart..................................................................................................................................... 1734
Priority........................................................................................................................................ 1735
Recipients....................................................................................................................................1735
RefIDs......................................................................................................................................... 1736
ReplyIDs..................................................................................................................................... 1736
ReplyTo.......................................................................................................................................1736
ResultOfSend.............................................................................................................................. 1736
Sender......................................................................................................................................... 1737
Sensitivity................................................................................................................................... 1737
SMTPPort................................................................................................................................... 1737
SMTPServer................................................................................................................................1738
SMTPSSLClientCertAlias.......................................................................................................... 1738
SMTPSSLPort.............................................................................................................................1738
SMTPUserName......................................................................................................................... 1738
SMTPUserPassword................................................................................................................... 1739
SMTPUseSSL............................................................................................................................. 1739
StatusNotifyOptions....................................................................................................................1739
StatusNotifyReturn......................................................................................................................1740
Subject.........................................................................................................................................1740
Text..............................................................................................................................................1740
TimeToWaitForResult................................................................................................................. 1741
UsedDefaultConfig..................................................................................................................... 1741
UsedPrimaryServer..................................................................................................................... 1741
ValidSentAddresses.....................................................................................................................1741
ValidUnsentAddresses................................................................................................................ 1742
SMTPSession Class.......................................................................................................................... 1742
SMTPSession Class Methods........................................................................................................... 1742
Send.............................................................................................................................................1742
SendAll....................................................................................................................................... 1743
SetSMTPParam...........................................................................................................................1744
SMTPSession Class Properties......................................................................................................... 1745
BackupPort..................................................................................................................................1745
BackupServer.............................................................................................................................. 1745
BackupSSLClientCertAlias........................................................................................................ 1745
BackupSSLPort...........................................................................................................................1746
BackupUserName....................................................................................................................... 1746
BackupUserPassword..................................................................................................................1746
BackupUseSSL........................................................................................................................... 1746
IsAuthenticationReqd..................................................................................................................1747
Port.............................................................................................................................................. 1747
Server.......................................................................................................................................... 1747
SSLClientCertAlias.....................................................................................................................1748
SSLPort....................................................................................................................................... 1748
UsedDefaultConfig..................................................................................................................... 1748
UsedPrimaryServer..................................................................................................................... 1748
UserName....................................................................................................................................1749
UserPassword..............................................................................................................................1749
UseSSL....................................................................................................................................... 1749

Copyright © 1988, 2024, Oracle and/or its affiliates. lxiii

Contents

Mail Classes Examples..................................................................................................................... 1750

Creating a Text Email................................................................................................................ 1750
Creating Email and Overriding SMTP Settings........................................................................ 1751
Creating an HTML Email.......................................................................................................... 1752
Creating a Multipart Email with Text and HTML Parts............................................................1752
Creating an HTML Email with Images..................................................................................... 1753
Creating an Email from Rich Text Editor Output..................................................................... 1754
Creating an Email with Attachments......................................................................................... 1761
Creating Email Attachments by Specifying URLs.................................................................... 1762
Creating and Sending Multiple Email Messages....................................................................... 1763
Sending an Email With Authentication..................................................................................... 1763
Using an SSL Connection to Send Email..................................................................................1764
Chapter 33: Managed Object Classes..................................................................................................1765
Understanding the Managed Object Classes.................................................................................... 1765
Considerations When Using Definitions Created Through the Managed Object Classes..........1765
Managed Object Classes Built-in Functions.................................................................................... 1767
FieldDefn Class.................................................................................................................................1767
FieldDefn Class Methods..................................................................................................................1768
Save.............................................................................................................................................1768
SaveAs........................................................................................................................................ 1769
SetLabel...................................................................................................................................... 1770
SetTranslateValue........................................................................................................................1771
Validate........................................................................................................................................1772
FieldDefn Class Properties............................................................................................................... 1773
DecimalPositions........................................................................................................................ 1773
DefaultCentury............................................................................................................................1773
Description.................................................................................................................................. 1774
FormatType................................................................................................................................. 1774
IntegerPositions...........................................................................................................................1775
Length......................................................................................................................................... 1775
MaximumLength.........................................................................................................................1776
Messages..................................................................................................................................... 1776
Name........................................................................................................................................... 1777
ObjectOwnerId............................................................................................................................1777
RawBinary.................................................................................................................................. 1777
RuntimeDefn...............................................................................................................................1778
TimeFormat.................................................................................................................................1778
Type.............................................................................................................................................1778
RecordDefn Class..............................................................................................................................1779
RecordDefn Class Methods.............................................................................................................. 1779
AddField..................................................................................................................................... 1780
Build............................................................................................................................................1780
GetField.......................................................................................................................................1781
RemoveField............................................................................................................................... 1782
Save.............................................................................................................................................1783
SaveAsView................................................................................................................................ 1784
Validate........................................................................................................................................1785
RecordDefn Class Properties............................................................................................................ 1786
BuildSequenceNumber............................................................................................................... 1786
Description.................................................................................................................................. 1786
FieldCount...................................................................................................................................1786

lxiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Messages..................................................................................................................................... 1787
Name........................................................................................................................................... 1787
ObjectOwnerId............................................................................................................................1787
QuerySecurityRecord..................................................................................................................1788
RelatedLanguageRecord............................................................................................................. 1788
RuntimeDefn...............................................................................................................................1788
SetControlField........................................................................................................................... 1788
SQL............................................................................................................................................. 1788
Type.............................................................................................................................................1789
RecordFieldDefn Class..................................................................................................................... 1789
RecordFieldDefn Class Methods...................................................................................................... 1790
RecordFieldDefn Class Properties....................................................................................................1790
AllowSearchEventsForPromptDialogs....................................................................................... 1790
AlternateSearchKey.................................................................................................................... 1790
DescendingKey........................................................................................................................... 1790
DuplicateOrderKey..................................................................................................................... 1791
Key.............................................................................................................................................. 1791
ListBoxItem................................................................................................................................ 1791
Name........................................................................................................................................... 1792
Number....................................................................................................................................... 1792
RecordFieldLabelID....................................................................................................................1792
Required...................................................................................................................................... 1792
SearchEdit................................................................................................................................... 1792
SearchKey................................................................................................................................... 1793
TableEditPromptTable.................................................................................................................1793
TableEditSetControlField............................................................................................................1794
TableEditType............................................................................................................................. 1794
Type.............................................................................................................................................1794
Message Catalog Component Interface............................................................................................ 1795
Message Catalog Methods................................................................................................................ 1795
AddMessage................................................................................................................................1795
DeleteMessage............................................................................................................................ 1797
Message Catalog Properties..............................................................................................................1797
DESCR (Message Set)............................................................................................................... 1798
DESCRSHORT (Message Set).................................................................................................. 1798
MESSAGE_SET_NBR (Message Set)...................................................................................... 1798
DESCRLONG (Message Catalog Entry)...................................................................................1798
MESSAGE_NBR (Message Catalog Entry).............................................................................. 1798
MESSAGE_SET_NBR (Message Catalog Entry)..................................................................... 1799
MESSAGE_TEXT (Message Catalog Entry)............................................................................ 1799
MSG_SEVERITY (Message Catalog Entry).............................................................................1799
Chapter 34: MCF IM Classes...............................................................................................................1801
MCFIMInfo Class Methods..............................................................................................................1801
AddUser...................................................................................................................................... 1801
CheckAll..................................................................................................................................... 1801
GetAdditionalUserInfo................................................................................................................1801
GetErrorImageName...................................................................................................................1801
GetOffLineImageName.............................................................................................................. 1801
GetOnlineImageName................................................................................................................ 1801
GetUnknownImageName............................................................................................................1801
GetLaunchURL...........................................................................................................................1802

Copyright © 1988, 2024, Oracle and/or its affiliates. lxv

Contents

GetStatus..................................................................................................................................... 1802
RemoveUser................................................................................................................................1802
MCFIMSingleButton Class Methods............................................................................................... 1802
generateHTML............................................................................................................................1802
generateJavaScript...................................................................................................................... 1802
insertXMPPServerUserData....................................................................................................... 1802
MCFIMSingleButton.................................................................................................................. 1802
updateXMPPServerUserData......................................................................................................1802
MCFIMSingleButton Class Properties............................................................................................. 1803
hideDelay.................................................................................................................................... 1803
Chapter 35: Message Classes................................................................................................................ 1805
Understanding Message Classes....................................................................................................... 1805
Messages, Service Operations and Handlers............................................................................. 1805
Integration Broker Application Classes..................................................................................... 1806
Data Types of Message Objects....................................................................................................... 1807
Scope of Message Objects................................................................................................................1807
Message Object Population.............................................................................................................. 1807
Considerations When Populating a Rowset From a Message................................................... 1809
Considerations for Publishing and Subscribing to Partial Records........................................... 1810
Considerations When Subscribing to Character Fields..............................................................1810
Message Segments............................................................................................................................ 1810
Content-Based Routing..................................................................................................................... 1813
Error Handling.................................................................................................................................. 1814
Message Classes Reference.............................................................................................................. 1815
Message Class Built-In Functions.................................................................................................... 1815
Message Class Methods....................................................................................................................1816
Clone........................................................................................................................................... 1816
CopyPartRowset..........................................................................................................................1817
CopyRowset................................................................................................................................ 1818
CopyRowsetDelta....................................................................................................................... 1819
CopyRowsetDeltaOriginal.......................................................................................................... 1821
CreateNextSegment.................................................................................................................... 1824
DeleteSegment............................................................................................................................ 1825
ExecuteEdits................................................................................................................................1826
FirstCorrelation........................................................................................................................... 1828
GenXMLPartString.....................................................................................................................1829
GenXMLString........................................................................................................................... 1830
GetContentString........................................................................................................................ 1830
GetDocument.............................................................................................................................. 1831
GetPartAliasName...................................................................................................................... 1832
GetPartName...............................................................................................................................1832
GetPartRowset............................................................................................................................ 1833
GetPartVersion............................................................................................................................ 1834
GetPartXMLDoc.........................................................................................................................1834
GetQueryString........................................................................................................................... 1835
GetRowset...................................................................................................................................1836
GetSegment.................................................................................................................................1837
GetURIDocument....................................................................................................................... 1837
GetURIResource......................................................................................................................... 1838
GetXmlDoc................................................................................................................................. 1839
InBoundPublish...........................................................................................................................1839

lxvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

LoadXMLPartString................................................................................................................... 1840
LoadXMLString..........................................................................................................................1841
OverrideRESTBaseURL.............................................................................................................1841
OverrideURIResource.................................................................................................................1842
Publish.........................................................................................................................................1843
SegmentRestart........................................................................................................................... 1845
SetContentString......................................................................................................................... 1845
SetEditTable................................................................................................................................ 1846
SetQueryString............................................................................................................................1848
SetRESTCache............................................................................................................................1849
SetStatus......................................................................................................................................1849
SetXmlDoc..................................................................................................................................1851
SyncRequest................................................................................................................................1852
Update......................................................................................................................................... 1853
UpdateSegment........................................................................................................................... 1854
Message Class Properties..................................................................................................................1854
ActionName................................................................................................................................ 1855
AliasName...................................................................................................................................1855
ChannelName..............................................................................................................................1855
Cookies....................................................................................................................................... 1856
CurrentSegment.......................................................................................................................... 1857
DefaultMessageVersion.............................................................................................................. 1857
DoNotPubToNodeName............................................................................................................. 1857
GUID...........................................................................................................................................1858
HTTPMethod.............................................................................................................................. 1858
HTTPResponseCode...................................................................................................................1859
IBException................................................................................................................................ 1859
IBInfo.......................................................................................................................................... 1860
InitializeConversationId..............................................................................................................1860
IsActive....................................................................................................................................... 1860
IsBulkLoadTruncation................................................................................................................ 1861
IsDelta......................................................................................................................................... 1861
IsEditError...................................................................................................................................1862
IsLocal.........................................................................................................................................1863
IsOperationActive....................................................................................................................... 1863
IsParts..........................................................................................................................................1863
IsPartsStructured......................................................................................................................... 1864
IsRequest.....................................................................................................................................1864
IsSourceNodeExternal................................................................................................................ 1864
IsStructure................................................................................................................................... 1864
MessageDetail.............................................................................................................................1865
Name........................................................................................................................................... 1865
NRId............................................................................................................................................1865
OperationName........................................................................................................................... 1865
OperationVersion........................................................................................................................ 1866
ParentTransactionId.................................................................................................................... 1866
PartCount.................................................................................................................................... 1866
PubID.......................................................................................................................................... 1866
PubNodeName............................................................................................................................ 1867
QueueName.................................................................................................................................1867
QueueSeqId.................................................................................................................................1867

Copyright © 1988, 2024, Oracle and/or its affiliates. lxvii

Contents

ResponseStatus............................................................................................................................1868
SegmentContentTransfer.............................................................................................................1868
SegmentContentType.................................................................................................................. 1869
SegmentCount.............................................................................................................................1869
SegmentsByDatabase..................................................................................................................1869
Size..............................................................................................................................................1870
SubName.....................................................................................................................................1871
SubQueueName.......................................................................................................................... 1871
SubscriptionProcessId.................................................................................................................1871
TransactionId...............................................................................................................................1872
URIResourceIndex......................................................................................................................1873
Version........................................................................................................................................ 1873
IntBroker Class..................................................................................................................................1873
IntBroker Class Methods.................................................................................................................. 1873
Cancel..........................................................................................................................................1874
ConnectorRequest....................................................................................................................... 1875
ConnectorRequestUrl..................................................................................................................1876
DefaultLocalNode.......................................................................................................................1877
DefaultPortalName......................................................................................................................1878
DeleteLayoutCache.....................................................................................................................1879
DeleteOrphanedSegments...........................................................................................................1879
DeleteRESTCache...................................................................................................................... 1880
EscapeControlCodes................................................................................................................... 1881
GenLayoutDoc............................................................................................................................ 1881
GenLayoutHTML....................................................................................................................... 1882
GetArchData............................................................................................................................... 1884
GetArchIBInfoData.....................................................................................................................1884
GetContentURI........................................................................................................................... 1885
GetDocSchema............................................................................................................................1885
GetIBInfoData.............................................................................................................................1886
GetIBTransactionIDforAE..........................................................................................................1887
GetImageURL.............................................................................................................................1888
GetMessage.................................................................................................................................1888
GetMessageErrors.......................................................................................................................1889
GetMsgSchema........................................................................................................................... 1890
GetPortalURI.............................................................................................................................. 1891
GetSyncIBInfoData.....................................................................................................................1891
GetSyncLogData.........................................................................................................................1892
GetURL.......................................................................................................................................1893
InBoundPublish...........................................................................................................................1895
IsOperationActive....................................................................................................................... 1896
MAPLogout................................................................................................................................ 1896
MAPSessionTimeout.................................................................................................................. 1897
MAPTimeout...............................................................................................................................1897
MsgSchemaExists....................................................................................................................... 1898
Publish.........................................................................................................................................1899
Resubmit..................................................................................................................................... 1900
SetMessageError......................................................................................................................... 1901
SetStatus......................................................................................................................................1903
SwitchAsyncEventUserContext..................................................................................................1904
SyncRequest................................................................................................................................1904

lxviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Update......................................................................................................................................... 1906
UpdateCSSMetadata................................................................................................................... 1906
UpdateDocument........................................................................................................................ 1907
UpdateJSMetadata...................................................................................................................... 1908
UpdateXmlDoc........................................................................................................................... 1908
IBInfo Class...................................................................................................................................... 1909
IBInfo Class Methods....................................................................................................................... 1909
AddAEAttribute.......................................................................................................................... 1909
AddAttachment........................................................................................................................... 1911
AddAttribute............................................................................................................................... 1912
AddContainerAttribute................................................................................................................1913
ClearAEAttributes.......................................................................................................................1914
ClearAttachments........................................................................................................................1914
ClearAttributes............................................................................................................................ 1915
ClearContainerAttributes............................................................................................................ 1915
DeleteAEAttribute...................................................................................................................... 1916
DeleteAttachment........................................................................................................................1916
DeleteAttribute............................................................................................................................1917
DeleteContainerAttribute............................................................................................................ 1918
GetAEAttributeName..................................................................................................................1918
GetAEAttributeValue.................................................................................................................. 1919
GetAttachmentContentID........................................................................................................... 1920
GetAttachmentProperty.............................................................................................................. 1920
GetAttributeName.......................................................................................................................1922
GetAttributeValue....................................................................................................................... 1923
GetContainerAttributeName....................................................................................................... 1924
GetContainerAttributeValue........................................................................................................1924
GetNumberofAEAttributes......................................................................................................... 1925
GetNumberOfAttributes..............................................................................................................1925
GetNumberOfContainerAttributes..............................................................................................1926
GetTransactionIDforAE..............................................................................................................1927
InsertAEResponseAttributes.......................................................................................................1927
LoadConnectorProp.................................................................................................................... 1928
LoadConnectorPropFromNode...................................................................................................1929
LoadConnectorPropFromRouting...............................................................................................1929
LoadConnectorPropFromTrx......................................................................................................1930
LoadRESTHeaders......................................................................................................................1930
SetAttachmentProperty............................................................................................................... 1931
IBInfo Class Properties.....................................................................................................................1933
AppServerDomain...................................................................................................................... 1933
CompressionOverride................................................................................................................. 1933
ConnectorOverride......................................................................................................................1934
ConversationID........................................................................................................................... 1934
DeliveryMode............................................................................................................................. 1935
DestinationNode..........................................................................................................................1935
ExternalMessageID.....................................................................................................................1935
ExternalOperationName..............................................................................................................1936
ExternalUserName...................................................................................................................... 1936
ExternalUserPassword................................................................................................................ 1936
FinalDestinationNode................................................................................................................. 1936
FuturePublicationDateTime........................................................................................................ 1936

Copyright © 1988, 2024, Oracle and/or its affiliates. lxix

Contents

HTTPSessionId........................................................................................................................... 1937
IBConnectorInfo......................................................................................................................... 1937
InReplyToID............................................................................................................................... 1937
MessageChannel......................................................................................................................... 1937
MessageName............................................................................................................................. 1938
MessageQueue............................................................................................................................ 1938
MessageType...............................................................................................................................1938
MessageVersion.......................................................................................................................... 1939
NodeDN...................................................................................................................................... 1939
NonRepudiationID...................................................................................................................... 1939
NumberOfAttachments............................................................................................................... 1939
OperationType.............................................................................................................................1939
OperationVersion........................................................................................................................ 1940
OrigNode.....................................................................................................................................1940
OrigProcess................................................................................................................................. 1940
OrigTimeStamp...........................................................................................................................1940
OrigUser......................................................................................................................................1941
PublicationID.............................................................................................................................. 1941
RequestingNodeName................................................................................................................ 1941
RequestingNodeDescription....................................................................................................... 1941
ResponseAsAttachment.............................................................................................................. 1941
SegmentsUnOrder.......................................................................................................................1941
SourceNode.................................................................................................................................1942
SyncServiceTimeout................................................................................................................... 1942
TransactionID..............................................................................................................................1943
UserName....................................................................................................................................1943
VisitedNodes............................................................................................................................... 1943
WSA_Action...............................................................................................................................1943
WSA_FaultTo............................................................................................................................. 1943
WSA_MessageID........................................................................................................................1944
WSA_ReplyTo............................................................................................................................ 1944
WSA_To......................................................................................................................................1944
IBConnectorInfo Collection..............................................................................................................1944
IBConnectorInfo Collection Methods...............................................................................................1944
AddConnectorProperties.............................................................................................................1945
AddQueryStringArg....................................................................................................................1946
ClearConnectorProperties........................................................................................................... 1946
ClearQueryStringArgs................................................................................................................ 1947
DeleteConnectorProperties......................................................................................................... 1947
DeleteQueryStringArg................................................................................................................ 1948
GetConnectorPropertiesName.................................................................................................... 1948
GetConnectorPropertiesType...................................................................................................... 1949
GetConnectorPropertiesValue.....................................................................................................1950
GetNumberOfConnectorProperties.............................................................................................1950
GetNumberOfQueryStringArgs.................................................................................................. 1950
GetQueryStringArgName........................................................................................................... 1951
GetQueryStringArgValue............................................................................................................1951
IBConnectorInfo Collection Properties............................................................................................ 1952
ConnectorClassName..................................................................................................................1952
ConnectorName.......................................................................................................................... 1952
Cookies....................................................................................................................................... 1952

lxx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

PathInfo.......................................................................................................................................1953
RemoteFrameworkURL..............................................................................................................1953
Chapter 36: Optimization PeopleCode................................................................................................ 1955
Using Optimization PeopleCode on the Application Server............................................................ 1955
Using Optimization PeopleCode in an Application Engine Program.............................................. 1955
Performing Optimization in PeopleCode..........................................................................................1956
Creating New Analytic Instances...............................................................................................1956
Loading Analytic Instances Into an Analytic Server................................................................. 1957
Running Optimization Transactions...........................................................................................1957
Invoking the Optimization PeopleCode Plug-In........................................................................ 1958
Shutting Down Optimization Engines....................................................................................... 1959
Deleting Existing Analytic Instances......................................................................................... 1959
Programming for Database Updates.......................................................................................... 1960
Using Lights-Out Mode with Optimization..................................................................................... 1960
Understanding Lights-out Mode................................................................................................ 1960
Creating a Request Message...................................................................................................... 1962
Creating a Response Message....................................................................................................1967
Editing the Request PeopleCode................................................................................................1968
Editing the Response PeopleCode............................................................................................. 1971
Optimization Built-in Functions....................................................................................................... 1973
CreateOptEngine.........................................................................................................................1973
CreateOptInterface...................................................................................................................... 1975
DeleteOptProbInst.......................................................................................................................1976
GetOptEngine..............................................................................................................................1977
GetOptProbInstList..................................................................................................................... 1978
InsertOptProbInst........................................................................................................................ 1980
IsValidOptProbInst......................................................................................................................1981
OptEngine Class Methods................................................................................................................ 1982
CheckOptEngineStatus............................................................................................................... 1982
FillRowset................................................................................................................................... 1984
GetDate....................................................................................................................................... 1986
GetDateArray.............................................................................................................................. 1986
GetDateTime............................................................................................................................... 1987
GetDateTimeArray......................................................................................................................1988
GetNumber..................................................................................................................................1989
GetNumberArray........................................................................................................................ 1991
GetString..................................................................................................................................... 1991
GetStringArray............................................................................................................................1992
GetTime.......................................................................................................................................1994
GetTimeArray............................................................................................................................. 1994
GetTraceLevel.............................................................................................................................1995
RunAsynch..................................................................................................................................1997
RunSynch.................................................................................................................................... 1998
SetTraceLevel............................................................................................................................. 2000
ShutDown................................................................................................................................... 2002
OptEngine Class Properties.............................................................................................................. 2003
DetailMsgs.................................................................................................................................. 2003
DetailedStatus............................................................................................................................. 2004
OptBase Application Class............................................................................................................... 2005
OptBase Class Methods.................................................................................................................... 2006
GetParmDate...............................................................................................................................2006

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxi

Contents

GetParmDateArray......................................................................................................................2007
GetParmDateTime.......................................................................................................................2007
GetParmDateTimeArray............................................................................................................. 2008
GetParmNumber......................................................................................................................... 2009
GetParmNumberArray................................................................................................................ 2009
GetParmInt.................................................................................................................................. 2010
GetParmIntArray.........................................................................................................................2010
GetParmString.............................................................................................................................2011
GetParmStringArray................................................................................................................... 2011
GetParmTime.............................................................................................................................. 2012
GetParmTimeArray.....................................................................................................................2013
Init............................................................................................................................................... 2013
OptDeleteCallback...................................................................................................................... 2014
OptInsertCallback....................................................................................................................... 2014
OptPostUpdateCallback.............................................................................................................. 2015
OptPreUpdateCallback................................................................................................................2016
OptRefreshCallback.................................................................................................................... 2017
SetOutputParmDate.................................................................................................................... 2017
SetOutputParmDateArray........................................................................................................... 2018
SetOutputParmDateTime............................................................................................................ 2018
SetOutputParmDateTimeArray...................................................................................................2019
SetOutputParmNumber...............................................................................................................2020
SetOutputParmNumberArray......................................................................................................2020
SetOutputParmInt........................................................................................................................2021
SetOutputParmIntArray.............................................................................................................. 2021
SetOutputParmString.................................................................................................................. 2022
SetOutputParmStringArray.........................................................................................................2022
SetOutputParmTime....................................................................................................................2023
SetOutputParmTimeArray.......................................................................................................... 2024
OptInterface Class Methods..............................................................................................................2024
ActivateModel.............................................................................................................................2024
ActivateObjective........................................................................................................................2025
DeactivateModel......................................................................................................................... 2026
DumpMsgToLog.........................................................................................................................2027
FindRowNum..............................................................................................................................2028
GetSolution................................................................................................................................. 2029
GetSolutionDetail........................................................................................................................2030
IsModelActive.............................................................................................................................2032
RestoreBounds............................................................................................................................ 2032
SetVariableBounds...................................................................................................................... 2033
SetVariableType.......................................................................................................................... 2035
Solve........................................................................................................................................... 2036
Chapter 37: Page Class......................................................................................................................... 2039
Understanding Page Class................................................................................................................ 2039
Shortcut Considerations.................................................................................................................... 2039
Data Type of a Page Object............................................................................................................. 2039
Scope of a Page Object.................................................................................................................... 2039
Page Class Built-in Function............................................................................................................ 2040
Page Class Properties........................................................................................................................2040
CopyURLLink............................................................................................................................ 2040
CustomizePageLink.................................................................................................................... 2040

lxxii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

DisplayOnly................................................................................................................................ 2041
HelpLink..................................................................................................................................... 2041
Name........................................................................................................................................... 2041
NewWindowLink........................................................................................................................2042
Visible......................................................................................................................................... 2042
Chapter 38: PeopleSoft Search Framework Classes.......................................................................... 2045
Understanding the PeopleSoft Search Framework Classes.............................................................. 2045
Instantiating a SearchQuery Object.................................................................................................. 2045
Importing PeopleSoft Search Framework Classes.....................................................................2046
Performing a Simple Search............................................................................................................. 2046
PeopleSoft Search Framework Classes Reference........................................................................... 2048
PeopleSoft Search Framework Classes Built-in Functions.............................................................. 2049
AddConfiguration Class....................................................................................................................2049
AddConfiguration Class Methods.....................................................................................................2049
AddConfiguration....................................................................................................................... 2049
GetAddPageInstructionsInfo.......................................................................................................2050
GetAddPageTitleInfo.................................................................................................................. 2050
GetAddSearchRecord..................................................................................................................2051
GetConfiguredAppClass............................................................................................................. 2051
GetConfiguredAppClassMethod.................................................................................................2052
GetConfiguredApppackage.........................................................................................................2052
GetConfiguredClassPath.............................................................................................................2053
GetCriteriaFields.........................................................................................................................2053
GetPageLinksList........................................................................................................................2054
AssociatedFacet Class....................................................................................................................... 2054
AssociatedFacet Class Methods........................................................................................................2054
getAssociatedFacetValue............................................................................................................ 2054
DashboardFilters Class......................................................................................................................2055
DashboardFilters Class Methods...................................................................................................... 2055
GetDashboardFilter.....................................................................................................................2055
FacetFilter Class................................................................................................................................2057
FacetFilter Class Methods................................................................................................................ 2057
clearFacetSorting........................................................................................................................ 2057
FacetFilter................................................................................................................................... 2058
getFacetSortings..........................................................................................................................2059
getFacetValuesSortType..............................................................................................................2059
hasCustomFacetSorting.............................................................................................................. 2060
sortFacetValuesAlphabetically....................................................................................................2060
sortFacetValuesByDocumentCount............................................................................................ 2061
sortFacetValuesByType...............................................................................................................2061
sortFacetValuesNumerically....................................................................................................... 2062
FacetFilter Class Properties.............................................................................................................. 2063
AssociationValue.........................................................................................................................2063
FacetLabel...................................................................................................................................2063
FacetName.................................................................................................................................. 2063
Path............................................................................................................................................. 2063
FacetNode Class................................................................................................................................2064
FacetNode Class Methods................................................................................................................ 2064
addChild...................................................................................................................................... 2064
FacetNode................................................................................................................................... 2065
getChildNodes.............................................................................................................................2065

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxiii

Contents

FacetNode Class Properties.............................................................................................................. 2066

DisplayValue............................................................................................................................... 2066
DocumentCount.......................................................................................................................... 2066
FacetValue...................................................................................................................................2066
HasChildren................................................................................................................................ 2067
FilterValues Class..............................................................................................................................2067
FilterValues Class Methods.............................................................................................................. 2067
DynamicTimeRangeAbsolute..................................................................................................... 2067
DynamicTimeRangeRelative...................................................................................................... 2068
Equals..........................................................................................................................................2069
EqualsDateTime..........................................................................................................................2069
Exists...........................................................................................................................................2070
FilterValues................................................................................................................................. 2070
InBetweenDateTime................................................................................................................... 2071
Key.............................................................................................................................................. 2072
NotEquals....................................................................................................................................2072
NotEqualsDateTime....................................................................................................................2073
NotExists.....................................................................................................................................2074
NotInBetweenDateTime............................................................................................................. 2074
Value........................................................................................................................................... 2075
Values.......................................................................................................................................... 2076
PTRTI Class...................................................................................................................................... 2076
PTRTI Class Methods.......................................................................................................................2077
PostProcess................................................................................................................................. 2077
Process........................................................................................................................................ 2078
SearchAttribute Class........................................................................................................................2080
SearchAttribute Class Methods.........................................................................................................2080
SearchAttribute........................................................................................................................... 2080
SearchAttribute Class Properties...................................................................................................... 2081
Display........................................................................................................................................ 2081
Name........................................................................................................................................... 2081
Type.............................................................................................................................................2081
SearchbarContext Class.................................................................................................................... 2082
SearchbarContext Class Methods..................................................................................................... 2082
SearchbarContext........................................................................................................................ 2082
SearchbarContext Class Properties................................................................................................... 2083
ArrCustomSearchCategory......................................................................................................... 2083
CustomSearchCategory...............................................................................................................2083
IsComponentOrGenericURL...................................................................................................... 2083
IsIncludeHiddenCref...................................................................................................................2083
Placeholder..................................................................................................................................2084
ShowCategoryDropDown...........................................................................................................2084
ShowGlobalSearchButton...........................................................................................................2084
ShowGridIcons........................................................................................................................... 2084
SearchCategory Class........................................................................................................................2084
SearchCategory Class Methods........................................................................................................ 2085
GetAllAttributes..........................................................................................................................2085
GetConfiguredFilterAttributes.................................................................................................... 2085
GetFacetFilters............................................................................................................................ 2086
GetLastIndexedDateTime........................................................................................................... 2086
GetNonConfiguredFilterAttributes............................................................................................. 2087

lxxiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

GetRequestedAttributes.............................................................................................................. 2087
GetRequestedFields.................................................................................................................... 2088
SearchCategory........................................................................................................................... 2088
SearchCategory Class Properties...................................................................................................... 2089
DataSourceNames.......................................................................................................................2089
Displayname................................................................................................................................2089
Duplicates....................................................................................................................................2090
IsDeployed.................................................................................................................................. 2090
Name........................................................................................................................................... 2090
ServiceName............................................................................................................................... 2090
SearchConfiguration Class................................................................................................................2091
SearchConfiguration Class Methods.................................................................................................2091
CollapseSearchCriteriaAfterSrch................................................................................................2091
GetConfigSrchId......................................................................................................................... 2091
GetConfiguredImageRecord....................................................................................................... 2092
GetConfiguredImageRecordField...............................................................................................2092
GetConfiguredSearchType..........................................................................................................2093
GetCriteriaFields.........................................................................................................................2093
GetDefaultSrchLookup............................................................................................................... 2095
GetDefaultSrchLookupForSFF...................................................................................................2095
GetESCriteriaFields.................................................................................................................... 2096
GetMaxSrchResults.................................................................................................................... 2096
GetPageLinksList........................................................................................................................2097
GetRecentSearchesCount............................................................................................................2097
GetRecentSearchesNamingFormat............................................................................................. 2097
GetResultFields...........................................................................................................................2098
GetSavedSearchesCount............................................................................................................. 2098
GetSavedSearchesNamingFormat.............................................................................................. 2099
GetSearchCriteriaDisplayPattern................................................................................................ 2099
GetSearchDefinition....................................................................................................................2100
GetSearchPageInstructionsInfo...................................................................................................2100
GetSearchPageTitleInfo.............................................................................................................. 2101
GetSearchRecord........................................................................................................................ 2101
GetSrchLookupType................................................................................................................... 2102
IsAutoSearchEnabled..................................................................................................................2102
IsSearchPrimaryAction............................................................................................................... 2103
SearchConfiguration................................................................................................................... 2103
ShowRelatedActions...................................................................................................................2104
SearchFactory Class.......................................................................................................................... 2104
SearchFactory Class Methods...........................................................................................................2104
CreateQueryService.................................................................................................................... 2104
SearchFactory..............................................................................................................................2105
SearchFactory Class Properties.........................................................................................................2106
DEFAULTSERVICE...................................................................................................................2106
SearchField Class.............................................................................................................................. 2106
SearchField Class Methods...............................................................................................................2106
getAsDate....................................................................................................................................2106
getAsDateTime........................................................................................................................... 2107
getAsInteger................................................................................................................................ 2107
getAsNumber.............................................................................................................................. 2108
SearchField Class Properties.............................................................................................................2108

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxv

Contents

Name........................................................................................................................................... 2109
Type.............................................................................................................................................2109
Value........................................................................................................................................... 2109
SearchFieldCollection Class............................................................................................................. 2109
SearchFieldCollection Class Methods.............................................................................................. 2110
Count...........................................................................................................................................2110
First............................................................................................................................................. 2110
Item............................................................................................................................................. 2111
ItemByName............................................................................................................................... 2111
Next.............................................................................................................................................2112
SearchFilter Class..............................................................................................................................2112
SearchFilter Class Methods.............................................................................................................. 2113
setDateFilter................................................................................................................................ 2113
setDateTimeFilter........................................................................................................................2113
SearchFilter Class Properties............................................................................................................ 2114
Field............................................................................................................................................ 2114
FilterConnector........................................................................................................................... 2115
Filters.......................................................................................................................................... 2115
Operator...................................................................................................................................... 2115
Value........................................................................................................................................... 2116
SearchFilterGenerator Class..............................................................................................................2116
Related SearchFilterGenerator Methods.................................................................................... 2117
SearchFilterGenerator Class Methods.............................................................................................. 2118
AddQueryFilter........................................................................................................................... 2118
AfterDate.....................................................................................................................................2119
AfterDateTime............................................................................................................................ 2120
AfterDateValue............................................................................................................................2120
AppendFilter............................................................................................................................... 2121
BeforeDate.................................................................................................................................. 2122
BeforeDateTime..........................................................................................................................2122
BeforeDateValue......................................................................................................................... 2123
BoostCompositeFilterScore........................................................................................................ 2124
BoostFilterScore..........................................................................................................................2125
ContainsKeyWords..................................................................................................................... 2126
ContainsPartialWord................................................................................................................... 2127
ContainsPhrase............................................................................................................................2127
ContainsWord..............................................................................................................................2128
DateToDatetime.......................................................................................................................... 2129
EndMatchAll...............................................................................................................................2129
EndMatchAny............................................................................................................................. 2130
EqualsDate.................................................................................................................................. 2130
EqualsDateTime..........................................................................................................................2131
EqualsDateValue......................................................................................................................... 2131
EqualsNumber.............................................................................................................................2132
EqualsString................................................................................................................................ 2133
GetFilter...................................................................................................................................... 2133
GreaterThanEqualsNumber........................................................................................................ 2134
GreaterThanNumber................................................................................................................... 2134
LessThanEqualsNumber............................................................................................................. 2135
LessThanNumber........................................................................................................................ 2136
MatchAll..................................................................................................................................... 2136

lxxvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

MatchAllReturnTrue................................................................................................................... 2137
MatchAny................................................................................................................................... 2138
MatchAnyReturnTrue................................................................................................................. 2138
NotContainsWord........................................................................................................................2139
NotEqualsDate............................................................................................................................ 2140
NotEqualsDateTime....................................................................................................................2140
NotEqualsDateValue................................................................................................................... 2141
NotEqualsNumber.......................................................................................................................2142
NotEqualsString.......................................................................................................................... 2142
OnOrAfterDate............................................................................................................................2143
OnOrAfterDateTime................................................................................................................... 2143
OnOrAfterDateValue.................................................................................................................. 2144
OnOrBeforeDate......................................................................................................................... 2145
OnOrBeforeDateTime.................................................................................................................2145
OnOrBeforeDateValue................................................................................................................ 2146
SearchFilterGenerator................................................................................................................. 2147
setBoostMode............................................................................................................................. 2147
setBoostModeAverage................................................................................................................ 2148
setBoostModeMaximum.............................................................................................................2149
setBoostModeMinimum..............................................................................................................2149
setBoostModeSum...................................................................................................................... 2150
SetQueryFilter.............................................................................................................................2151
StringDateToDatetime................................................................................................................ 2151
SearchFilterGenerator Class Properties............................................................................................ 2152
BoostWithoutFilter......................................................................................................................2152
Search Filter Generator Examples.................................................................................................... 2153
Creating Complex Filters........................................................................................................... 2153
Score Boosting Examples...........................................................................................................2155
SearchQuery Class............................................................................................................................ 2159
SearchQuery Class Methods............................................................................................................. 2160
BrowseFacetNodes......................................................................................................................2160
Execute........................................................................................................................................2161
FormatDateFilter.........................................................................................................................2162
FormatDateTimeFilter.................................................................................................................2163
SearchQuery Class Properties...........................................................................................................2163
Categories....................................................................................................................................2164
ContainsAnyWords..................................................................................................................... 2164
ContainsExactPhrase...................................................................................................................2164
ClusteringSpecs...........................................................................................................................2165
DisableScoreSort.........................................................................................................................2165
DocsRequested............................................................................................................................2165
EnableExtendedFilterOperators.................................................................................................. 2166
FacetFilters..................................................................................................................................2166
FilterConnector........................................................................................................................... 2167
Filters.......................................................................................................................................... 2167
GroupingSpec............................................................................................................................. 2167
IncludeImages............................................................................................................................. 2167
Language.....................................................................................................................................2168
MarkDuplicates...........................................................................................................................2168
MaximumNumberOfFacetValues............................................................................................... 2168
MinimumDocumentsPerFacetValue........................................................................................... 2169

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxvii

Contents

ProgrammaticSearchString......................................................................................................... 2169
QueryText....................................................................................................................................2169
RemoveDuplicates...................................................................................................................... 2170
RequestedFields.......................................................................................................................... 2170
ReturnFacetValueCounts.............................................................................................................2170
SearchWithIn...............................................................................................................................2171
SortFacetValuesBy...................................................................................................................... 2171
SortSpecs.....................................................................................................................................2171
StartIndex.................................................................................................................................... 2172
TopN............................................................................................................................................2172
WithoutWords............................................................................................................................. 2172
SearchQueryCollection Class............................................................................................................2172
SearchQueryCollection Class Methods............................................................................................ 2172
addQuery.....................................................................................................................................2173
Count...........................................................................................................................................2173
ExecuteQuerys............................................................................................................................ 2174
First............................................................................................................................................. 2174
Item............................................................................................................................................. 2175
Next.............................................................................................................................................2175
SearchQueryService Class................................................................................................................ 2176
SearchQueryService Class Methods................................................................................................. 2176
CreateQuery................................................................................................................................ 2176
CreateQueryCollection................................................................................................................2177
ExecuteQuery..............................................................................................................................2177
ExecuteQuerys............................................................................................................................ 2178
SearchResult Class............................................................................................................................ 2178
SearchResult Class Methods.............................................................................................................2179
GetCategoryNames..................................................................................................................... 2179
GetContentLength.......................................................................................................................2179
GetCustomAttributes.................................................................................................................. 2180
GetImageUrl................................................................................................................................2180
GetLanguage............................................................................................................................... 2181
GetLastModified......................................................................................................................... 2182
GetScore......................................................................................................................................2182
GetSignature................................................................................................................................2182
GetSummary............................................................................................................................... 2183
GetTitle....................................................................................................................................... 2183
GetUrlLink.................................................................................................................................. 2184
HasDuplicate...............................................................................................................................2184
IsDuplicate.................................................................................................................................. 2185
SearchResultCollection Class........................................................................................................... 2185
SearchResultCollection Class Methods............................................................................................ 2186
First............................................................................................................................................. 2186
GetDocumentCount.................................................................................................................... 2186
GetDuplicatesMarked................................................................................................................. 2187
GetDuplicatesRemoved.............................................................................................................. 2187
GetEstimatedHitCount................................................................................................................ 2188
GetFacetNodes............................................................................................................................ 2188
GetQueryObject.......................................................................................................................... 2189
GetQueryText..............................................................................................................................2189
GetStartIndex.............................................................................................................................. 2190

lxxviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Item............................................................................................................................................. 2190
Next.............................................................................................................................................2191
SearchAuthnQueryFilter Class..........................................................................................................2191
SearchAuthnQueryFilter Class Methods.......................................................................................... 2192
evaluateAttrValues...................................................................................................................... 2192
Additional Search Examples.............................................................................................................2193
Searching Using Facets.............................................................................................................. 2193
Chapter 39: Portal Registry Classes.................................................................................................... 2199
Understanding the Portal Registry....................................................................................................2199
Folders.........................................................................................................................................2199
Content References.....................................................................................................................2200
Nodes.......................................................................................................................................... 2200
Security....................................................................................................................................... 2201
Attributes.....................................................................................................................................2201
Additional Portal Objects........................................................................................................... 2201
Using the Portal Registry API..........................................................................................................2202
Using Security...................................................................................................................................2202
Portal Registry Object Properties...............................................................................................2202
Accessing Portal Registry Objects............................................................................................. 2203
Using PermissionValue, RolePermissionValue, Cascading Permissions and
CascadingRolePermissions......................................................................................................... 2203
Working With ValidFrom and ValidTo.............................................................................................2206
Doing Error Handling....................................................................................................................... 2206
Understanding the Life Cycle of a PortalRegistry Object................................................................2207
Using Content References................................................................................................................ 2209
UsageType...................................................................................................................................2209
TemplateType..............................................................................................................................2211
URLType..................................................................................................................................... 2211
Nodes and URL..........................................................................................................................2212
Naming Conventions.........................................................................................................................2214
Deleting Content Considerations...................................................................................................... 2214
Saving Content Considerations.........................................................................................................2214
Data Type of a PortalRegistry Object.............................................................................................. 2215
Scope of a PortalRegistry Object..................................................................................................... 2215
PortalRegistry Reference.................................................................................................................. 2216
Session Class Methods......................................................................................................................2216
FindPortalRegistries....................................................................................................................2216
GetActualRemoteNodes..............................................................................................................2217
GetLocalNode............................................................................................................................. 2218
GetNodes.....................................................................................................................................2218
GetPortalRegistry........................................................................................................................2219
GetRemoteNodes........................................................................................................................ 2219
PortalRegistry Class.......................................................................................................................... 2220
PortalRegistry Class Methods...........................................................................................................2220
Close........................................................................................................................................... 2220
CopyObject................................................................................................................................. 2221
Create.......................................................................................................................................... 2222
CreateContentRefLink................................................................................................................ 2223
CreateRemote..............................................................................................................................2224
Delete.......................................................................................................................................... 2225
DeleteHomepage.........................................................................................................................2226

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxix

Contents

FindCRefByName.......................................................................................................................2227
FindCRefByURL........................................................................................................................ 2228
FindCRefForURL....................................................................................................................... 2229
FindCRefLinkByName............................................................................................................... 2230
FindFolderByName.....................................................................................................................2231
FindPgltByName.........................................................................................................................2232
GetAbsoluteContentURL............................................................................................................2233
GetDefaultHPTabOID.................................................................................................................2234
GetQualifiedURL........................................................................................................................2234
GrantPermissionForComponent..................................................................................................2234
GrantPermissionForScript...........................................................................................................2236
Open............................................................................................................................................ 2237
PermissionListDelete.................................................................................................................. 2238
PermissionListSaveAs................................................................................................................ 2238
RevokePermissionForComponent.............................................................................................. 2239
RevokePermissionForScript........................................................................................................2240
Save.............................................................................................................................................2241
PortalRegistry Class Properties.........................................................................................................2242
DefaultTemplate..........................................................................................................................2242
Description.................................................................................................................................. 2242
Favorites......................................................................................................................................2242
FolderNavObject.........................................................................................................................2243
Homepage................................................................................................................................... 2243
IsFolderNavigation......................................................................................................................2243
LandingPage................................................................................................................................2243
LandingTabDefinitions............................................................................................................... 2244
Name........................................................................................................................................... 2244
NodeTemplates............................................................................................................................2244
OwnerId...................................................................................................................................... 2244
PageletCategories........................................................................................................................2245
Portals......................................................................................................................................... 2245
RootFolder.................................................................................................................................. 2245
SectionTemplates........................................................................................................................ 2245
TabDefinitions.............................................................................................................................2246
TemplateObject........................................................................................................................... 2246
PortalRegistry Collection.................................................................................................................. 2246
PortalRegistry Collection Methods...................................................................................................2246
First............................................................................................................................................. 2246
Item............................................................................................................................................. 2247
Next.............................................................................................................................................2247
PortalRegistry Collection Property................................................................................................... 2248
Count...........................................................................................................................................2248
Node Class........................................................................................................................................ 2248
Node Class Properties.......................................................................................................................2248
ActiveNode................................................................................................................................. 2248
AppsRelease................................................................................................................................2249
ContentURI................................................................................................................................. 2249
DefaultPortalName......................................................................................................................2249
Description.................................................................................................................................. 2249
IsDefault......................................................................................................................................2249
IsLocal.........................................................................................................................................2250

lxxx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Name........................................................................................................................................... 2250
NodePassword.............................................................................................................................2250
NodeType.................................................................................................................................... 2250
PortalURI.................................................................................................................................... 2251
ToolsRelease............................................................................................................................... 2251
Node Collection................................................................................................................................ 2251
Node Collection Methods................................................................................................................. 2251
First............................................................................................................................................. 2252
ItemByName............................................................................................................................... 2252
Next.............................................................................................................................................2253
Node Collection Property................................................................................................................. 2253
Count...........................................................................................................................................2253
RemoteNode Collection.................................................................................................................... 2253
RemoteNode Collection Methods.....................................................................................................2254
First............................................................................................................................................. 2254
ItemByName............................................................................................................................... 2254
Next.............................................................................................................................................2255
RemoteNode Collection Property..................................................................................................... 2255
Count...........................................................................................................................................2255
Portal Class........................................................................................................................................2256
Portal Class Method..........................................................................................................................2256
Save.............................................................................................................................................2256
Portal Class Properties...................................................................................................................... 2256
HostNodeName...........................................................................................................................2256
IsLocal.........................................................................................................................................2257
Name........................................................................................................................................... 2257
Portal Collection................................................................................................................................2257
Portal Collection Methods................................................................................................................ 2257
First............................................................................................................................................. 2257
ItemByName............................................................................................................................... 2258
Next.............................................................................................................................................2258
Portal Collection Properties.............................................................................................................. 2259
Count...........................................................................................................................................2259
NodeTemplate Class..........................................................................................................................2259
NodeTemplate Class Properties........................................................................................................ 2259
DefaultTemplate..........................................................................................................................2259
Name........................................................................................................................................... 2260
TemplateObject........................................................................................................................... 2260
NodeTemplate Collection..................................................................................................................2260
NodeTemplate Collection Methods.................................................................................................. 2260
DeleteItem...................................................................................................................................2260
First............................................................................................................................................. 2261
InsertItem.................................................................................................................................... 2261
ItemByName............................................................................................................................... 2262
Next.............................................................................................................................................2262
NodeTemplate Collection Properties................................................................................................ 2263
Count...........................................................................................................................................2263
Folder Class.......................................................................................................................................2263
Folder Class Method.........................................................................................................................2264
Save.............................................................................................................................................2264
Folder Class Properties..................................................................................................................... 2264

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxxi

Contents

AbnContentProvider................................................................................................................... 2264
AbnDataSource........................................................................................................................... 2265
AbnPeopleCode.......................................................................................................................... 2265
Attributes.....................................................................................................................................2265
Author......................................................................................................................................... 2266
AuthorAccess.............................................................................................................................. 2266
Authorized...................................................................................................................................2266
CascadedPermissions.................................................................................................................. 2266
CascadedRolePermissions.......................................................................................................... 2267
ContentRefs.................................................................................................................................2267
CreationDate............................................................................................................................... 2267
DefaultChartNavigation.............................................................................................................. 2268
Description.................................................................................................................................. 2268
Folders.........................................................................................................................................2268
IsMobile...................................................................................................................................... 2268
IsVisible...................................................................................................................................... 2269
Label........................................................................................................................................... 2269
Name........................................................................................................................................... 2269
OwnerId...................................................................................................................................... 2270
ParentName.................................................................................................................................2270
Path............................................................................................................................................. 2270
Permissions................................................................................................................................. 2270
Product........................................................................................................................................ 2271
PublicAccess............................................................................................................................... 2271
RolePermissions..........................................................................................................................2271
SequenceNumber........................................................................................................................ 2272
TreeEffectiveDate....................................................................................................................... 2272
TreeName....................................................................................................................................2272
TreeSetId..................................................................................................................................... 2273
TreeStructureName..................................................................................................................... 2274
TreeUserKeyValue...................................................................................................................... 2275
ValidFrom................................................................................................................................... 2275
ValidTo........................................................................................................................................ 2276
Folder Collection...............................................................................................................................2276
Folder Collection Methods............................................................................................................... 2276
DeleteItem...................................................................................................................................2276
First............................................................................................................................................. 2277
InsertItem.................................................................................................................................... 2277
ItemByName............................................................................................................................... 2278
Next.............................................................................................................................................2279
Folder Collection Property................................................................................................................2279
Count...........................................................................................................................................2280
Content Reference Class................................................................................................................... 2280
Content Reference Class Methods....................................................................................................2280
CreateLink...................................................................................................................................2280
Save.............................................................................................................................................2281
Content Reference Class Properties..................................................................................................2282
AbsoluteContentURL..................................................................................................................2282
AbsolutePortalURL.....................................................................................................................2282
AssignedPagelets........................................................................................................................ 2283
AssignedSections........................................................................................................................ 2283

lxxxii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Attributes.....................................................................................................................................2283
Author......................................................................................................................................... 2283
AuthorAccess.............................................................................................................................. 2284
Authorized...................................................................................................................................2284
CascadedPermissions.................................................................................................................. 2284
CascadedRolePermissions.......................................................................................................... 2285
ContentProvider.......................................................................................................................... 2285
CreationDate............................................................................................................................... 2285
Data............................................................................................................................................. 2286
Description.................................................................................................................................. 2286
DisplayIn.....................................................................................................................................2286
DisplayModalParams.................................................................................................................. 2287
EventName..................................................................................................................................2287
GroupletAltHeight...................................................................................................................... 2288
GroupletAltWidth....................................................................................................................... 2288
GroupletAutoSize........................................................................................................................2288
GroupletContentProvider............................................................................................................ 2289
GroupletContentURL..................................................................................................................2289
GroupletDisableHotspot..............................................................................................................2290
GroupletHeight............................................................................................................................2290
GroupletId................................................................................................................................... 2291
GroupletImageName...................................................................................................................2291
GroupletPageName..................................................................................................................... 2291
GroupletTimer.............................................................................................................................2292
GroupletType.............................................................................................................................. 2292
GroupletURL.............................................................................................................................. 2294
GroupletURLType.......................................................................................................................2294
GroupletWidth.............................................................................................................................2295
HasGrouplet................................................................................................................................ 2295
HtmlText..................................................................................................................................... 2295
IsFluid......................................................................................................................................... 2295
IsMobile...................................................................................................................................... 2296
IsSmallFFOptimized................................................................................................................... 2296
IsVisible...................................................................................................................................... 2296
Label........................................................................................................................................... 2297
Links........................................................................................................................................... 2297
Name........................................................................................................................................... 2297
OwnerId...................................................................................................................................... 2298
ParentName.................................................................................................................................2298
Path............................................................................................................................................. 2298
Permissions................................................................................................................................. 2298
Product........................................................................................................................................ 2299
PublicAccess............................................................................................................................... 2299
QualifiedURL..............................................................................................................................2299
RelativeURL............................................................................................................................... 2299
RolePermissions..........................................................................................................................2300
SequenceNumber........................................................................................................................ 2300
StorageType................................................................................................................................ 2300
Template......................................................................................................................................2302
TemplateObject........................................................................................................................... 2302
TemplateType..............................................................................................................................2302

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxxiii

Contents

URL.............................................................................................................................................2303
URLType..................................................................................................................................... 2303
UsageType...................................................................................................................................2304
ValidFrom................................................................................................................................... 2305
ValidTo........................................................................................................................................ 2305
Content Reference Collection........................................................................................................... 2305
Content Reference Collection Methods............................................................................................2306
DeleteItem...................................................................................................................................2306
First............................................................................................................................................. 2307
InsertItem.................................................................................................................................... 2307
ItemByName............................................................................................................................... 2308
Next.............................................................................................................................................2309
Content Reference Collection Property............................................................................................ 2309
Count...........................................................................................................................................2309
AttributeValue Class..........................................................................................................................2310
AttributeValue Class Properties........................................................................................................ 2310
Label........................................................................................................................................... 2310
Name........................................................................................................................................... 2310
Translatable................................................................................................................................. 2311
Value........................................................................................................................................... 2311
Attribute Collection...........................................................................................................................2311
Attribute Collection Methods........................................................................................................... 2312
DeleteItem...................................................................................................................................2312
First............................................................................................................................................. 2313
InsertItem.................................................................................................................................... 2313
ItemByName............................................................................................................................... 2314
Next.............................................................................................................................................2314
Attribute Collection Property............................................................................................................2315
Count...........................................................................................................................................2315
PermissionValue Class...................................................................................................................... 2315
PermissionValue Class Properties.....................................................................................................2316
Cascade....................................................................................................................................... 2316
Name........................................................................................................................................... 2316
PermType.................................................................................................................................... 2316
PermissionValue Collection.............................................................................................................. 2317
PermissionValue Collection Methods............................................................................................... 2317
DeleteItem...................................................................................................................................2317
First............................................................................................................................................. 2318
InsertItem.................................................................................................................................... 2318
ItemByName............................................................................................................................... 2319
Next.............................................................................................................................................2320
PermissionValue Collection Property............................................................................................... 2320
Count...........................................................................................................................................2320
RolePermissionValue Collection.......................................................................................................2320
RolePermissionValue Collection Methods........................................................................................2321
DeleteItem...................................................................................................................................2321
First............................................................................................................................................. 2322
InsertItem.................................................................................................................................... 2322
ItemByName............................................................................................................................... 2323
Next.............................................................................................................................................2323
RolePermissionValue Collection Property........................................................................................2324

lxxxiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Count...........................................................................................................................................2324
ContentReference Links....................................................................................................................2324
ContentReference Links Methods.....................................................................................................2325
Delete.......................................................................................................................................... 2325
Save.............................................................................................................................................2325
ContentReference Links Properties.................................................................................................. 2326
AbsoluteContentURL..................................................................................................................2326
AbsolutePortalURL.....................................................................................................................2326
Attributes.....................................................................................................................................2327
Author......................................................................................................................................... 2327
AuthorAccess.............................................................................................................................. 2327
Authorized...................................................................................................................................2327
CascadedPermissions.................................................................................................................. 2328
CascadedRolePermissions.......................................................................................................... 2328
ContentProvider.......................................................................................................................... 2329
CreationDate............................................................................................................................... 2329
Data............................................................................................................................................. 2329
Description.................................................................................................................................. 2329
IsMobile...................................................................................................................................... 2330
IsVisible...................................................................................................................................... 2330
Label........................................................................................................................................... 2330
Name........................................................................................................................................... 2331
OwnerId...................................................................................................................................... 2331
ParentName.................................................................................................................................2331
Path............................................................................................................................................. 2331
Permissions................................................................................................................................. 2332
Product........................................................................................................................................ 2332
PublicAccess............................................................................................................................... 2332
RelativeURL............................................................................................................................... 2332
RolePermissions..........................................................................................................................2333
SequenceNumber........................................................................................................................ 2333
Template......................................................................................................................................2333
TemplateObject........................................................................................................................... 2334
TemplateType..............................................................................................................................2334
URL.............................................................................................................................................2335
URLType..................................................................................................................................... 2335
UsageType...................................................................................................................................2335
ValidFrom................................................................................................................................... 2336
ValidTo........................................................................................................................................ 2336
Link Collection..................................................................................................................................2336
Link Collection Methods.................................................................................................................. 2336
First............................................................................................................................................. 2336
Next.............................................................................................................................................2337
Link Collection Property.................................................................................................................. 2337
Count...........................................................................................................................................2337
Link Class......................................................................................................................................... 2337
Link Properties.................................................................................................................................. 2338
LinksObjectName....................................................................................................................... 2338
LinksObjectType......................................................................................................................... 2338
LinksPortalName........................................................................................................................ 2338
TabDefinition Class...........................................................................................................................2338

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxxv

Contents

TabDefinition Class Methods........................................................................................................... 2338

Save.............................................................................................................................................2339
TabDefinition Class Properties......................................................................................................... 2339
AssignedPagelets........................................................................................................................ 2339
AssignedSections........................................................................................................................ 2340
AvailableCategories.................................................................................................................... 2340
AvailablePagelets........................................................................................................................ 2340
Attributes.....................................................................................................................................2340
Author......................................................................................................................................... 2340
AuthorAccess.............................................................................................................................. 2341
ColumnLayout............................................................................................................................ 2341
CreationDate............................................................................................................................... 2341
Description.................................................................................................................................. 2341
DynamicCategories.....................................................................................................................2342
HelpID.........................................................................................................................................2342
HideInPersonalize....................................................................................................................... 2342
HtmlText..................................................................................................................................... 2342
IsHideActionBar......................................................................................................................... 2342
IsLayoutLocked.......................................................................................................................... 2343
IsPersonalizable.......................................................................................................................... 2343
IsRenameable.............................................................................................................................. 2343
Label........................................................................................................................................... 2343
LayoutBehavior...........................................................................................................................2343
Name........................................................................................................................................... 2344
OwnerId...................................................................................................................................... 2344
Product........................................................................................................................................ 2344
PublicAccess............................................................................................................................... 2345
QualifiedURL..............................................................................................................................2345
SequenceNumber........................................................................................................................ 2345
StyleSheet....................................................................................................................................2345
ValidFrom................................................................................................................................... 2346
ValidTo........................................................................................................................................ 2346
TabDefinition Collection...................................................................................................................2346
TabDefinition Collection Methods....................................................................................................2346
DeleteItem...................................................................................................................................2346
First............................................................................................................................................. 2347
InsertItem.................................................................................................................................... 2347
ItemByName............................................................................................................................... 2348
Next.............................................................................................................................................2349
TabDefinition Collection Property....................................................................................................2349
Count...........................................................................................................................................2349
AssignedPagelet Class...................................................................................................................... 2350
AssignedPagelet Class Properties..................................................................................................... 2350
Column........................................................................................................................................2350
LayoutBehavior...........................................................................................................................2350
PageletName............................................................................................................................... 2351
Row............................................................................................................................................. 2351
SectionName............................................................................................................................... 2351
AssignedPagelet Collection...............................................................................................................2351
AssignedPagelet Collection Methods............................................................................................... 2352
DeleteItem...................................................................................................................................2352

lxxxvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

First............................................................................................................................................. 2352
InsertItem.................................................................................................................................... 2353
ItemByName............................................................................................................................... 2354
Next.............................................................................................................................................2355
AssignedPagelet Collection Property............................................................................................... 2355
Count...........................................................................................................................................2355
AssignedSection Class...................................................................................................................... 2355
AssignedSection Class Properties.....................................................................................................2356
AssignedPagelets........................................................................................................................ 2356
Column........................................................................................................................................2356
HideInPersonalize....................................................................................................................... 2356
IsPersonalizable.......................................................................................................................... 2356
IsRenameable.............................................................................................................................. 2357
Label........................................................................................................................................... 2357
LayoutBehavior...........................................................................................................................2357
Name........................................................................................................................................... 2358
Order........................................................................................................................................... 2358
AssignedSections Collection.............................................................................................................2358
AssignedSections Collection Methods............................................................................................. 2358
DeleteItem...................................................................................................................................2358
First............................................................................................................................................. 2359
InsertItem.................................................................................................................................... 2359
ItemByName............................................................................................................................... 2360
Next.............................................................................................................................................2361
AssignedSections Collection Property..............................................................................................2361
Count...........................................................................................................................................2362
AvailableCategory Class................................................................................................................... 2362
AvailableCategory Class Properties..................................................................................................2362
AvailablePagelets........................................................................................................................ 2362
CategoryName............................................................................................................................ 2362
AvailableCategory Collection........................................................................................................... 2363
AvailableCategory Collection Methods............................................................................................ 2363
First............................................................................................................................................. 2363
ItemByName............................................................................................................................... 2363
Next.............................................................................................................................................2364
AvailableCategory Collection Property............................................................................................ 2364
Count...........................................................................................................................................2365
AvailablePagelet Class...................................................................................................................... 2365
AvailablePagelet Class Properties.....................................................................................................2365
CategoryLabel.............................................................................................................................2365
CategoryName............................................................................................................................ 2365
Column........................................................................................................................................2366
LayoutBehavior...........................................................................................................................2366
PageletLabel................................................................................................................................2366
PageletName............................................................................................................................... 2366
Row............................................................................................................................................. 2367
AvailablePagelet Collection.............................................................................................................. 2367
AvailablePagelet Collection Methods............................................................................................... 2367
First............................................................................................................................................. 2367
ItemByName............................................................................................................................... 2368
Next.............................................................................................................................................2368

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxxvii

Contents

AvailablePagelet Collection Property............................................................................................... 2369

Count...........................................................................................................................................2369
DynamicCategory Collection............................................................................................................2369
DynamicCategory Collection Methods.............................................................................................2369
DeleteItem...................................................................................................................................2369
First............................................................................................................................................. 2370
InsertItem.................................................................................................................................... 2371
ItemByName............................................................................................................................... 2371
Next.............................................................................................................................................2372
DynamicCategory Collection Property.............................................................................................2372
Count...........................................................................................................................................2373
PageletCategory Class.......................................................................................................................2373
PageletCategory Class Method......................................................................................................... 2373
Save.............................................................................................................................................2373
PageletCategory Class Properties..................................................................................................... 2374
Attributes.....................................................................................................................................2374
Author......................................................................................................................................... 2374
AuthorAccess.............................................................................................................................. 2374
Authorized...................................................................................................................................2375
CascadedPermissions.................................................................................................................. 2375
CreationDate............................................................................................................................... 2375
Description.................................................................................................................................. 2375
Label........................................................................................................................................... 2376
Name........................................................................................................................................... 2376
OwnerId...................................................................................................................................... 2376
Pagelets....................................................................................................................................... 2376
Permissions................................................................................................................................. 2377
Product........................................................................................................................................ 2377
PublicAccess............................................................................................................................... 2377
SequenceNumber........................................................................................................................ 2377
PageletCategory Collection...............................................................................................................2378
PageletCategory Collection Methods............................................................................................... 2378
DeleteItem...................................................................................................................................2378
First............................................................................................................................................. 2379
InsertItem.................................................................................................................................... 2379
ItemByName............................................................................................................................... 2380
Next.............................................................................................................................................2380
PageletCategory Collection Property................................................................................................2381
Count...........................................................................................................................................2381
Pagelet Class..................................................................................................................................... 2381
Pagelet Class Method........................................................................................................................2381
Save.............................................................................................................................................2381
Pagelet Class Properties....................................................................................................................2382
Attributes.....................................................................................................................................2382
Author......................................................................................................................................... 2382
AuthorAccess.............................................................................................................................. 2383
Authorized...................................................................................................................................2383
CascadedPermissions.................................................................................................................. 2383
ContentProvider.......................................................................................................................... 2383
CreationDate............................................................................................................................... 2384
DefaultColumn............................................................................................................................2384

lxxxviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Description.................................................................................................................................. 2384
EditPageContentProvider............................................................................................................2384
EditPageQueryString.................................................................................................................. 2384
HelpID.........................................................................................................................................2385
IsHideMinimize.......................................................................................................................... 2385
Label........................................................................................................................................... 2385
Name........................................................................................................................................... 2385
OwnerId...................................................................................................................................... 2385
ParentName.................................................................................................................................2386
Permissions................................................................................................................................. 2386
Product........................................................................................................................................ 2386
PublicAccess............................................................................................................................... 2386
QualifiedURL..............................................................................................................................2387
SequenceNumber........................................................................................................................ 2387
URL.............................................................................................................................................2387
URLType..................................................................................................................................... 2388
Pagelet Collection............................................................................................................................. 2388
Pagelet Collection Methods.............................................................................................................. 2388
DeleteItem...................................................................................................................................2388
First............................................................................................................................................. 2389
InsertItem.................................................................................................................................... 2389
ItemByName............................................................................................................................... 2390
Next.............................................................................................................................................2391
Pagelet Collection Property.............................................................................................................. 2391
Count...........................................................................................................................................2392
UserHomepage Class........................................................................................................................ 2392
UserHomepage Class Method...........................................................................................................2392
Save.............................................................................................................................................2392
UserHomepage Class Properties.......................................................................................................2393
Greeting.......................................................................................................................................2393
UserId..........................................................................................................................................2393
UserTab....................................................................................................................................... 2393
UserTab Class....................................................................................................................................2393
UserTab Class Properties.................................................................................................................. 2394
ColumnLayout............................................................................................................................ 2394
Label........................................................................................................................................... 2394
QualifiedURL..............................................................................................................................2394
SelectedPagelets..........................................................................................................................2395
SequenceNumber........................................................................................................................ 2395
TabName..................................................................................................................................... 2395
UserTab Collection............................................................................................................................2395
UserTab Collection Methods............................................................................................................ 2395
DeleteItem...................................................................................................................................2396
First............................................................................................................................................. 2396
InsertItem.................................................................................................................................... 2397
ItemByName............................................................................................................................... 2397
Next.............................................................................................................................................2398
UserTab Collection Property.............................................................................................................2398
Count...........................................................................................................................................2398
SelectedPagelet Class........................................................................................................................2399
SelectedPagelet Class Properties...................................................................................................... 2399

Copyright © 1988, 2024, Oracle and/or its affiliates. lxxxix

Contents

CategoryName............................................................................................................................ 2399
Column........................................................................................................................................2399
IsMinimized................................................................................................................................ 2400
PageletName............................................................................................................................... 2400
Row............................................................................................................................................. 2400
SelectedPagelet Collection................................................................................................................2400
SelectedPagelet Collection Methods.................................................................................................2400
DeleteItem...................................................................................................................................2400
First............................................................................................................................................. 2401
InsertItem.................................................................................................................................... 2402
ItemByName............................................................................................................................... 2402
Next.............................................................................................................................................2403
SelectedPagelet Collection Property.................................................................................................2403
Count...........................................................................................................................................2403
Favorite Class....................................................................................................................................2404
Favorite Class Properties.................................................................................................................. 2404
CRefName...................................................................................................................................2404
IsFolder....................................................................................................................................... 2404
Label........................................................................................................................................... 2404
QualifiedURL..............................................................................................................................2405
SequenceNumber........................................................................................................................ 2405
URL.............................................................................................................................................2405
Favorite Collection............................................................................................................................2405
Favorite Collection Methods............................................................................................................ 2405
DeleteItem...................................................................................................................................2406
First............................................................................................................................................. 2406
InsertFolderItem..........................................................................................................................2407
InsertItem.................................................................................................................................... 2407
ItemByLabel................................................................................................................................2408
Next.............................................................................................................................................2409
Save.............................................................................................................................................2409
Favorite Collection Property.............................................................................................................2409
Count...........................................................................................................................................2410
Portal Registry Classes Example......................................................................................................2410
Changing PortalRegistry Properties........................................................................................... 2410
Adding a ContentProvider..........................................................................................................2411
Adding a Folder..........................................................................................................................2413
Adding a Content Reference...................................................................................................... 2415
Setting Permissions Using the PermissionValue Object............................................................ 2418
Using Attributes..........................................................................................................................2420
Visual Basic Example.................................................................................................................2420
C/C++ Example.......................................................................................................................... 2421
Chapter 40: PostReport Class.............................................................................................................. 2425
PostReport Class Overview.............................................................................................................. 2425
Determining the Distribution List.....................................................................................................2425
Data Type of a PostReport Object....................................................................................................2425
Scope of a PostReport Object.......................................................................................................... 2426
PostReport Class Built-in Function.................................................................................................. 2426
PostReport Class Methods................................................................................................................ 2426
AddDistributionOption............................................................................................................... 2426
Put............................................................................................................................................... 2427

xc Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

PostReport Class Properties..............................................................................................................2428

ExpirationDate............................................................................................................................ 2428
OutDestFormat............................................................................................................................2428
ProcessInstance........................................................................................................................... 2428
ProcessName...............................................................................................................................2429
ProcessType................................................................................................................................ 2429
ReportDescr................................................................................................................................ 2429
ReportFolder............................................................................................................................... 2430
ReportId...................................................................................................................................... 2430
ServerName.................................................................................................................................2430
SourceReportPath........................................................................................................................2431
PostReport Class Examples.............................................................................................................. 2431
Chapter 41: Process Request Classes...................................................................................................2433
Understanding Process Request Classes...........................................................................................2433
Data Type of a ProcessRequest Object............................................................................................ 2433
Scope of a ProcessRequest Object................................................................................................... 2433
Options for Items In Jobs and Jobsets............................................................................................. 2434
Values for Output Type and Format................................................................................................. 2437
Alternative Options to Specify Email or Web Attributes.................................................................2440
File Dependant Processing................................................................................................................2441
ProcessRequest Class Built-in Functions......................................................................................... 2441
ProcessRequest Class Methods.........................................................................................................2442
AddDistributionOption............................................................................................................... 2442
AddNotifyInfo.............................................................................................................................2443
PrintJobHTMLRpt...................................................................................................................... 2444
PrintJobRqstRpt.......................................................................................................................... 2445
PrintSchdlHTMLRpt...................................................................................................................2448
RunJobSetNow........................................................................................................................... 2451
Schedule...................................................................................................................................... 2451
SetEmailOption...........................................................................................................................2452
SetItemFolder..............................................................................................................................2454
SetNotifyAppMethod..................................................................................................................2455
SetNotifyService......................................................................................................................... 2457
SetOutputOption......................................................................................................................... 2459
UpdateRunStatus.........................................................................................................................2460
ProcessRequest Class Properties.......................................................................................................2460
EmailAttachLog.......................................................................................................................... 2461
EmailSubject............................................................................................................................... 2461
EmailText.................................................................................................................................... 2461
EmailWebReport......................................................................................................................... 2462
FileName.....................................................................................................................................2462
JobName..................................................................................................................................... 2462
LanguageCd................................................................................................................................ 2463
NotifyTextMsgNum.................................................................................................................... 2463
NotifyTextMsgSet.......................................................................................................................2464
OutDest....................................................................................................................................... 2464
OutDestFormat............................................................................................................................2465
OutDestType............................................................................................................................... 2466
PortalFolder.................................................................................................................................2466
ProcessInstance........................................................................................................................... 2466
ProcessName...............................................................................................................................2467

Copyright © 1988, 2024, Oracle and/or its affiliates. xci

Contents

ProcessType................................................................................................................................ 2467
RunControlID............................................................................................................................. 2468
RunDateTime.............................................................................................................................. 2468
RunLocation................................................................................................................................2469
RunRecurrence............................................................................................................................2469
RunStatus.................................................................................................................................... 2470
Status...........................................................................................................................................2471
TimeZone.................................................................................................................................... 2471
ProcessRequest Class Examples....................................................................................................... 2471
Scheduling a Single Process...................................................................................................... 2472
Scheduling a Job Where Job Item Changes Are Not Made...................................................... 2472
Scheduling a Job Where Job Item Changes Are Made............................................................. 2472
PrcsApi Class.................................................................................................................................... 2473
Scope of a PrcsApi Object............................................................................................................... 2473
Data Type of a PrcsApi Object........................................................................................................ 2474
How to Import the PrcsApi Class.................................................................................................... 2474
How to Create a PrcsApi Object...................................................................................................... 2474
PrcsApi Class Constructor................................................................................................................ 2474
PrcsApi........................................................................................................................................2475
PrcsApi Class Methods.....................................................................................................................2475
getAllFileNames......................................................................................................................... 2475
notifyToWindow......................................................................................................................... 2476
Chapter 42: PSSpreadsheet Class........................................................................................................ 2479
Understanding the PSSpreadsheet Class.......................................................................................... 2479
Instantiating the PSSpreadsheet Class....................................................................................... 2479
PSSpreadsheet Class Methods.......................................................................................................... 2479
CreateSheet................................................................................................................................. 2480
DeleteSheet................................................................................................................................. 2480
GetFileContent............................................................................................................................ 2481
InsertColumns............................................................................................................................. 2481
InsertRows.................................................................................................................................. 2482
Open............................................................................................................................................ 2483
RangeApplyStyle........................................................................................................................ 2483
RangeColOutline.........................................................................................................................2484
RangeRowOutline.......................................................................................................................2485
Save.............................................................................................................................................2486
SaveAs........................................................................................................................................ 2486
SetActiveSheetName.................................................................................................................. 2487
SetCellDate................................................................................................................................. 2488
SetCellFormula........................................................................................................................... 2488
SetCellHeaderStyle..................................................................................................................... 2489
SetCellHyperlink.........................................................................................................................2490
SetCellNumber............................................................................................................................2491
SetCellString............................................................................................................................... 2492
SetColumnWidth.........................................................................................................................2493
SetRowSetData........................................................................................................................... 2493
SetSheetActivate......................................................................................................................... 2494
Chapter 43: PTDirectTransferObject Class........................................................................................2497
Understanding the PTDirectTransferObject Class............................................................................2497
PTDirectTransferObject Class Methods........................................................................................... 2497
SetAuth....................................................................................................................................... 2497

xcii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

SetBody.......................................................................................................................................2498
SetDocId..................................................................................................................................... 2498
SetHeader.................................................................................................................................... 2499
SetIndex...................................................................................................................................... 2500
SetMethod................................................................................................................................... 2500
SetOption.................................................................................................................................... 2501
SetURL....................................................................................................................................... 2502
SyncTransfer............................................................................................................................... 2502
Reset............................................................................................................................................2503
PTDirectTransferObject Class Built-in Functions............................................................................2503
Chapter 44: PTOCIInferenceSupervised Class.................................................................................. 2505
Understanding the PTOCIInferenceSupervised Class...................................................................... 2505
PTOCIInferenceSupervised Class Methods......................................................................................2505
PredictRun...................................................................................................................................2505
Chapter 45: Push Notification Classes................................................................................................ 2507
Understanding the PSEvent Class.................................................................................................... 2507
Instantiating the PSEvent Class................................................................................................. 2507
PSEvent Class Methods.................................................................................................................... 2507
AddRecipient.............................................................................................................................. 2508
AddRecipients.............................................................................................................................2508
GetRecipients.............................................................................................................................. 2509
GetRowSetData...........................................................................................................................2510
GetValueOfKey...........................................................................................................................2511
Publish.........................................................................................................................................2511
RemoveRecipients...................................................................................................................... 2512
SetKeyValuePair......................................................................................................................... 2513
SetRowSetData........................................................................................................................... 2514
Subscribe.....................................................................................................................................2515
Unsubscribe.................................................................................................................................2516
PTNotification Class......................................................................................................................... 2517
PTNotification Class Methods..........................................................................................................2517
AddAction...................................................................................................................................2517
AddAttachment........................................................................................................................... 2517
AddHeader.................................................................................................................................. 2518
AddRecipient.............................................................................................................................. 2518
AddRecipients.............................................................................................................................2519
AddTextAttachment.................................................................................................................... 2519
AddTextMedia............................................................................................................................ 2521
DisableIndividualMail................................................................................................................ 2521
EnableTracking........................................................................................................................... 2522
GenerateKey................................................................................................................................2522
GetFailedPhoneNumbers............................................................................................................ 2523
GetInvalidMailAddresses............................................................................................................2523
GetMailErrorDescription............................................................................................................ 2524
GetMailErrorDetails....................................................................................................................2524
GetNotificationStatus..................................................................................................................2525
GetSentMailAddresses................................................................................................................2526
GetSentToPhoneNumbers........................................................................................................... 2527
GetTextMsgCount.......................................................................................................................2527
GetUnsentMailAddresses............................................................................................................2527
GetUserNotificationStatus.......................................................................................................... 2528

Copyright © 1988, 2024, Oracle and/or its affiliates. xciii

Contents

LogTextMessageSID...................................................................................................................2529
NotifyHeadersOnly..................................................................................................................... 2530
NotifyOnDelay............................................................................................................................2530
NotifyOnError.............................................................................................................................2531
NotifyOnSuccess.........................................................................................................................2531
PTNotification.............................................................................................................................2532
Send.............................................................................................................................................2533
SetBounceTo............................................................................................................................... 2533
SetCategory.................................................................................................................................2534
SetMessage..................................................................................................................................2534
SetMsgKey..................................................................................................................................2535
SetOnClickUrl.............................................................................................................................2536
SetPriority................................................................................................................................... 2536
SetReplyTo..................................................................................................................................2537
SetSender.................................................................................................................................... 2537
SetSMTPParam...........................................................................................................................2537
SetSubject....................................................................................................................................2538
SetTimeToWait............................................................................................................................2538
SetURLIdForText........................................................................................................................2539
NotificationManager Class................................................................................................................2539
NotificationManager Class Methods................................................................................................ 2540
AddPersonalizationList...............................................................................................................2540
AddPersonalizationLists............................................................................................................. 2541
ClearPersonalizationList............................................................................................................. 2541
Delete.......................................................................................................................................... 2542
DisableMail.................................................................................................................................2542
DisablePush.................................................................................................................................2543
DisableText................................................................................................................................. 2543
EnableMail.................................................................................................................................. 2544
EnablePersonalization.................................................................................................................2545
EnablePush..................................................................................................................................2545
EnableText.................................................................................................................................. 2546
GetCategory................................................................................................................................ 2546
GetDescription............................................................................................................................ 2547
GetEventName............................................................................................................................ 2547
GetOwnerDescr...........................................................................................................................2548
GetOwnerId.................................................................................................................................2548
IsMailAvailable........................................................................................................................... 2549
IsMailDefault.............................................................................................................................. 2549
IsMandatory................................................................................................................................ 2550
IsNew.......................................................................................................................................... 2550
IsPersonalizationAllowed........................................................................................................... 2551
IsPersonalized............................................................................................................................. 2551
IsPushAvailable...........................................................................................................................2551
IsPushDefault.............................................................................................................................. 2552
IsTextAvailable........................................................................................................................... 2552
IsTextDefault...............................................................................................................................2553
NotificationManager................................................................................................................... 2553
RemoveFromPersonalizationList................................................................................................2554
ResetUserPersonalization............................................................................................................2555
ResetUserPersonalizations.......................................................................................................... 2555

xciv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Save.............................................................................................................................................2556
SetDescription.............................................................................................................................2556
SetEventName.............................................................................................................................2557
SetFuncCategory.........................................................................................................................2557
SetMailAvailable.........................................................................................................................2558
SetMandatory.............................................................................................................................. 2558
SetOwnerId................................................................................................................................. 2559
SetPushAvailable........................................................................................................................ 2559
SetTextAvailable......................................................................................................................... 2560
Chapter 46: Query Classes................................................................................................................... 2561
Understanding Query Classes........................................................................................................... 2561
Collections in the Query Classes......................................................................................................2561
Life Cycle of a Query.......................................................................................................................2562
Query API Overview........................................................................................................................ 2563
Query...........................................................................................................................................2564
QuerySelect.................................................................................................................................2564
QueryRecords..............................................................................................................................2565
QueryOutputFields......................................................................................................................2565
QuerySelectedFields................................................................................................................... 2565
QueryCriteria.............................................................................................................................. 2565
QueryDBRecords and QueryDBRecordFields...........................................................................2566
Working With Query Criteria and Expressions................................................................................2566
Setting the Expression Type.......................................................................................................2566
Adding New Expressions........................................................................................................... 2567
Adding an Operator and Expression 2 Dependencies............................................................... 2567
Setting a Drilling URL...............................................................................................................2568
Query Monitor...................................................................................................................................2570
Using Query Metadata...................................................................................................................... 2570
Running a Query...............................................................................................................................2571
Specifying the User’s Language................................................................................................ 2572
Query Security.................................................................................................................................. 2572
Error Handling With Query Classes.................................................................................................2573
Understanding QueryOutputFields and QuerySelectedFields.......................................................... 2574
Understanding Having Criteria......................................................................................................... 2574
Data Type of Query Objects.............................................................................................................2574
Scope of Query Objects....................................................................................................................2575
Query Classes Reference.................................................................................................................. 2575
Session Class Methods in the Query API........................................................................................ 2576
AdvancedSearchQueries............................................................................................................. 2576
AdvancedSearchRecords............................................................................................................ 2579
FindQueryDBRecords.................................................................................................................2581
FindQueries.................................................................................................................................2582
FindQueriesDateRange............................................................................................................... 2583
GetQuery.....................................................................................................................................2584
GetQuerySecurityProfile.............................................................................................................2584
SearchQueryDBRecords............................................................................................................. 2585
SearchPrivateQueries.................................................................................................................. 2586
SearchPublicQueries................................................................................................................... 2588
Query Collection............................................................................................................................... 2590
Query Collection Methods................................................................................................................2590
First............................................................................................................................................. 2591

Copyright © 1988, 2024, Oracle and/or its affiliates. xcv

Contents

Item............................................................................................................................................. 2591
ItemByName............................................................................................................................... 2592
Next.............................................................................................................................................2592
Query Collection Property................................................................................................................ 2593
Count...........................................................................................................................................2593
Query Class....................................................................................................................................... 2593
Query Class Methods........................................................................................................................2593
AddPrompt.................................................................................................................................. 2594
AddQuerySelect.......................................................................................................................... 2594
AddTrackingURL....................................................................................................................... 2595
Close........................................................................................................................................... 2596
CopyPrivateQuery.......................................................................................................................2597
Create.......................................................................................................................................... 2598
Delete.......................................................................................................................................... 2599
DeletePrompt.............................................................................................................................. 2600
FindExpression........................................................................................................................... 2601
FormatBinaryResultString.......................................................................................................... 2601
FormatResultString..................................................................................................................... 2602
GetTreePromptCount.................................................................................................................. 2604
Open............................................................................................................................................ 2604
Rename........................................................................................................................................2605
RunToFile....................................................................................................................................2606
RunToRowset..............................................................................................................................2609
RunToString................................................................................................................................ 2611
Save.............................................................................................................................................2614
SetTrackingURL......................................................................................................................... 2614
Query Class Properties......................................................................................................................2615
Approved.....................................................................................................................................2616
ApproveOprId............................................................................................................................. 2616
ApproveUserId............................................................................................................................2616
ApproveDtTm............................................................................................................................. 2617
CreateOprId.................................................................................................................................2617
CreateDtTm.................................................................................................................................2617
CreateUserId............................................................................................................................... 2617
Description.................................................................................................................................. 2617
Disabled...................................................................................................................................... 2618
ExecAppName............................................................................................................................ 2618
ExecLogging............................................................................................................................... 2618
Folder.......................................................................................................................................... 2619
LastSQLErrorCode..................................................................................................................... 2619
LastUpdDttm...............................................................................................................................2619
LastUpdOprId............................................................................................................................. 2619
LongDescription..........................................................................................................................2619
Metadata......................................................................................................................................2620
MetaSQL.....................................................................................................................................2620
MoreRowsAvailable....................................................................................................................2620
Name........................................................................................................................................... 2621
OutputUnicode............................................................................................................................ 2621
PDFFont...................................................................................................................................... 2621
Prompts....................................................................................................................................... 2622
PromptRecord............................................................................................................................. 2622

xcvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

PublicPrivate............................................................................................................................... 2623
QuerySelect.................................................................................................................................2623
QueryStatistics............................................................................................................................ 2623
RunTimePrompts........................................................................................................................ 2624
SQL............................................................................................................................................. 2624
Type.............................................................................................................................................2624
QuerySelect Collection..................................................................................................................... 2625
QuerySelect Collection Methods...................................................................................................... 2625
AddUnion....................................................................................................................................2625
DeleteQuerySelect...................................................................................................................... 2626
First............................................................................................................................................. 2626
Item............................................................................................................................................. 2627
ItemBySelNum............................................................................................................................2627
Next.............................................................................................................................................2628
QuerySelect Collection Property...................................................................................................... 2628
Count...........................................................................................................................................2629
QuerySelect Class............................................................................................................................. 2629
QuerySelect Methods........................................................................................................................ 2630
AddAllFields...............................................................................................................................2630
AddCriteria..................................................................................................................................2631
AddExpression............................................................................................................................ 2631
AddHavingCriteria......................................................................................................................2632
AddQueryOutputField................................................................................................................ 2633
AddQueryRecord........................................................................................................................ 2633
AddQuerySelectedField.............................................................................................................. 2634
DeleteCriteria.............................................................................................................................. 2635
DeleteExpression........................................................................................................................ 2635
DeleteField.................................................................................................................................. 2636
DeleteHavingCriteria.................................................................................................................. 2637
DeleteRecord...............................................................................................................................2637
QuerySelect Properties......................................................................................................................2638
Criteria........................................................................................................................................ 2638
Distinct........................................................................................................................................ 2638
Expressions................................................................................................................................. 2638
HavingCriteria.............................................................................................................................2639
ParentSelectNum.........................................................................................................................2639
QueryOutputFields......................................................................................................................2639
QueryRecords..............................................................................................................................2639
QuerySelectedFields................................................................................................................... 2640
QuerySelects............................................................................................................................... 2640
SelectNum...................................................................................................................................2640
SelectType...................................................................................................................................2640
QueryRecord Collection....................................................................................................................2641
QueryRecord Collection Methods.................................................................................................... 2641
First............................................................................................................................................. 2641
Item............................................................................................................................................. 2642
ItemByAlias................................................................................................................................ 2642
Next.............................................................................................................................................2643
QueryRecord Collection Property.....................................................................................................2643
Count...........................................................................................................................................2643
QueryRecord Class............................................................................................................................2644

Copyright © 1988, 2024, Oracle and/or its affiliates. xcvii

Contents

QueryRecord Class Method..............................................................................................................2644

GetField.......................................................................................................................................2644
QueryRecord Class Properties.......................................................................................................... 2645
Description.................................................................................................................................. 2645
JoinAlias..................................................................................................................................... 2645
JoinFieldName............................................................................................................................ 2645
JoinType...................................................................................................................................... 2645
Name........................................................................................................................................... 2646
QueryFields.................................................................................................................................2646
RecordAlias.................................................................................................................................2646
QueryField Collection....................................................................................................................... 2647
QueryField Collection Methods........................................................................................................2647
First............................................................................................................................................. 2647
Item............................................................................................................................................. 2648
ItemByNameAndAlias................................................................................................................2648
ItemByExpNum.......................................................................................................................... 2649
Next.............................................................................................................................................2650
QueryField Collection Property........................................................................................................2650
Count...........................................................................................................................................2650
QueryField Class...............................................................................................................................2650
QueryField Class Methods................................................................................................................2651
AddTranslateExpression............................................................................................................. 2651
AddTranslateField.......................................................................................................................2651
GetImageFormat......................................................................................................................... 2652
QueryField Class Properties............................................................................................................. 2653
Aggregate.................................................................................................................................... 2653
ColumnNumber...........................................................................................................................2653
Description.................................................................................................................................. 2654
Decimal....................................................................................................................................... 2654
ExpNum...................................................................................................................................... 2654
Flag............................................................................................................................................. 2654
Format......................................................................................................................................... 2654
HeadingText................................................................................................................................ 2655
HeadingType............................................................................................................................... 2655
HeadingUniqueFieldName..........................................................................................................2656
Length......................................................................................................................................... 2656
LongName...................................................................................................................................2656
Name........................................................................................................................................... 2656
OrderByDirection........................................................................................................................2657
OrderByNumber..........................................................................................................................2657
QueryRecord............................................................................................................................... 2658
RecordAlias.................................................................................................................................2658
ShortName.................................................................................................................................. 2658
TranslateEffDtLogic....................................................................................................................2658
TranslateExpression.................................................................................................................... 2659
TranslateField..............................................................................................................................2659
TranslateOption...........................................................................................................................2659
Type.............................................................................................................................................2660
QueryCriteria Collection................................................................................................................... 2661
QueryCriteria Collection Methods....................................................................................................2661
First............................................................................................................................................. 2661

xcviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Item............................................................................................................................................. 2661
ItemByName............................................................................................................................... 2662
Next.............................................................................................................................................2663
QueryCriteria Collection Property.................................................................................................... 2663
Count...........................................................................................................................................2663
QueryCriteria Class...........................................................................................................................2663
QueryCriteria Class Methods............................................................................................................2664
AddExpr1Expression.................................................................................................................. 2664
AddExpr1Field............................................................................................................................2664
AddExpr2Expression.................................................................................................................. 2665
AddExpr2Field1..........................................................................................................................2666
AddExpr2Field2..........................................................................................................................2666
AddExpr2List..............................................................................................................................2667
AddExpr2Subquery.....................................................................................................................2668
QueryCriteria Class Properties......................................................................................................... 2668
Expr1Expression......................................................................................................................... 2668
Expr1Field...................................................................................................................................2669
Expr1Type...................................................................................................................................2669
Expr2Constant1...........................................................................................................................2670
Expr2Constant2...........................................................................................................................2670
Expr2Expression1....................................................................................................................... 2670
Expr2Expression2....................................................................................................................... 2671
Expr2Field1.................................................................................................................................2671
Expr2Field2.................................................................................................................................2671
Expr2List.....................................................................................................................................2672
Expr2Subquery........................................................................................................................... 2672
Expr2Type...................................................................................................................................2672
Logical........................................................................................................................................ 2675
LParenLvl....................................................................................................................................2676
Name........................................................................................................................................... 2676
Negation...................................................................................................................................... 2676
Operator...................................................................................................................................... 2677
R1ExprNum................................................................................................................................ 2679
R2ExprNum................................................................................................................................ 2679
R1ExprType................................................................................................................................ 2679
R2ExprType................................................................................................................................ 2680
RParenLvl................................................................................................................................... 2680
QueryExpression Collection............................................................................................................. 2680
QueryExpression Collection Methods.............................................................................................. 2680
First............................................................................................................................................. 2680
Item............................................................................................................................................. 2681
ItemByName............................................................................................................................... 2681
Next.............................................................................................................................................2682
QueryExpression Collection Property.............................................................................................. 2682
Count...........................................................................................................................................2683
QueryExpression Class..................................................................................................................... 2683
QueryExpression Class Properties....................................................................................................2683
Aggregate.................................................................................................................................... 2683
BindFlag......................................................................................................................................2684
Decimal....................................................................................................................................... 2684
ExpNum...................................................................................................................................... 2684

Copyright © 1988, 2024, Oracle and/or its affiliates. xcix

Contents

IsXlatExpression......................................................................................................................... 2684
Length......................................................................................................................................... 2685
Name........................................................................................................................................... 2685
OutputField................................................................................................................................. 2685
RightExprFlag.............................................................................................................................2685
SelectedField...............................................................................................................................2686
Text..............................................................................................................................................2686
Type.............................................................................................................................................2686
QueryList Class.................................................................................................................................2687
QueryList Class Methods..................................................................................................................2687
AddListValue.............................................................................................................................. 2687
First............................................................................................................................................. 2688
Item............................................................................................................................................. 2688
Next.............................................................................................................................................2689
QueryList Class Property..................................................................................................................2689
Count...........................................................................................................................................2690
QueryListValue Class........................................................................................................................2690
QueryListValue Class Properties...................................................................................................... 2690
IsPrompt...................................................................................................................................... 2690
Value........................................................................................................................................... 2690
QueryRecordHierarchy Collection....................................................................................................2690
QueryRecordHierarchy Collection Methods.................................................................................... 2691
First............................................................................................................................................. 2691
Item............................................................................................................................................. 2691
ItemByName............................................................................................................................... 2692
Next.............................................................................................................................................2693
QueryRecordHierarchy Collection Property.....................................................................................2693
Count...........................................................................................................................................2693
QueryRecordHierarchy Class............................................................................................................2693
QueryRecordHierarchy Class Properties.......................................................................................... 2694
Description.................................................................................................................................. 2694
Level........................................................................................................................................... 2694
Name........................................................................................................................................... 2694
ParentFlag................................................................................................................................... 2694
Query Metadata Collection............................................................................................................... 2695
Query Metadata Collection Methods................................................................................................2695
First............................................................................................................................................. 2695
Item............................................................................................................................................. 2696
ItemByName............................................................................................................................... 2696
Next.............................................................................................................................................2697
Query Metadata Collection Property................................................................................................ 2697
Count...........................................................................................................................................2697
Query Metadata Class.......................................................................................................................2698
Query Metadata Class Properties..................................................................................................... 2698
Name........................................................................................................................................... 2698
Value........................................................................................................................................... 2699
QueryStatistics Class.........................................................................................................................2699
QueryStatistics Class Properties....................................................................................................... 2699
AvgExecTime..............................................................................................................................2699
AvgFetchTime.............................................................................................................................2699
AvgNumRows.............................................................................................................................2700

c Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

ExecCount...................................................................................................................................2700
LastExecDtTm............................................................................................................................ 2700
QuerySecurityProfile Class............................................................................................................... 2700
QuerySecurityProfile Class Properties............................................................................................. 2700
AllowAnyJoin............................................................................................................................. 2700
AllowDistinct.............................................................................................................................. 2701
AllowExpressions....................................................................................................................... 2701
AllowSubqueries.........................................................................................................................2701
AllowUnions............................................................................................................................... 2701
ApprovePrivateQuery................................................................................................................. 2701
ApprovePublicQuery.................................................................................................................. 2702
CanCreatePublic..........................................................................................................................2702
CanCreateWorkFlow...................................................................................................................2702
CanModifyQuery........................................................................................................................ 2702
CanRunQuery............................................................................................................................. 2703
CanRunToExcel.......................................................................................................................... 2703
LimitUnapproved........................................................................................................................ 2703
MaxInTreeCriteria.......................................................................................................................2703
MaxJoins..................................................................................................................................... 2703
MaxRowsToFetch....................................................................................................................... 2704
MaxUnapprovedRows................................................................................................................ 2704
QueryDBRecord Collection.............................................................................................................. 2704
QueryDBRecord Collection Methods...............................................................................................2704
First............................................................................................................................................. 2704
Item............................................................................................................................................. 2705
ItemByName............................................................................................................................... 2705
Next.............................................................................................................................................2706
QueryDBRecord Collection Property............................................................................................... 2706
Count...........................................................................................................................................2707
QueryDBRecord Class...................................................................................................................... 2707
QueryDBRecord Class Methods.......................................................................................................2707
QueryDBRecordFieldByIndex....................................................................................................2707
QueryDBRecordFieldByName................................................................................................... 2708
QueryDBRecord Class Properties.....................................................................................................2708
Description.................................................................................................................................. 2708
Name........................................................................................................................................... 2709
QueryDBRecordFields................................................................................................................2709
RecordHierachy.......................................................................................................................... 2709
QueryDBRecordField Collection......................................................................................................2709
QueryDBRecordField Collection Methods.......................................................................................2709
First............................................................................................................................................. 2710
Item............................................................................................................................................. 2710
ItemByName............................................................................................................................... 2711
Next.............................................................................................................................................2711
Sort.............................................................................................................................................. 2712
QueryDBRecordField Collection Property.......................................................................................2712
Count...........................................................................................................................................2713
QueryDBRecordField Class..............................................................................................................2713
QueryDBRecordField Class Method................................................................................................ 2713
GetImageFormat......................................................................................................................... 2713
QueryDBRecordField Class Properties............................................................................................ 2714

Copyright © 1988, 2024, Oracle and/or its affiliates. ci

Contents

Decimal....................................................................................................................................... 2714
Description.................................................................................................................................. 2714
Flag............................................................................................................................................. 2714
Format......................................................................................................................................... 2716
Length......................................................................................................................................... 2717
LongName...................................................................................................................................2717
LookupTableName......................................................................................................................2717
LookupTableRecord....................................................................................................................2717
Name........................................................................................................................................... 2717
Shortname................................................................................................................................... 2717
Type.............................................................................................................................................2718
QueryPrompt Collection................................................................................................................... 2718
QueryPrompt Collection Methods.................................................................................................... 2719
First............................................................................................................................................. 2719
Item............................................................................................................................................. 2719
ItemByName............................................................................................................................... 2720
Next.............................................................................................................................................2720
QueryPrompt Collection Property.................................................................................................... 2721
Count...........................................................................................................................................2721
QueryPrompt Class........................................................................................................................... 2721
QueryPrompt Properties....................................................................................................................2721
EditType...................................................................................................................................... 2722
FieldDecimal...............................................................................................................................2722
FieldFormat.................................................................................................................................2722
FieldLength................................................................................................................................. 2723
FieldName...................................................................................................................................2723
FieldType.................................................................................................................................... 2724
HeadingText................................................................................................................................ 2724
HeadingType............................................................................................................................... 2724
LangCount...................................................................................................................................2725
Name........................................................................................................................................... 2725
PromptRecordFieldName............................................................................................................2725
PromptTable................................................................................................................................ 2725
UniquePromptName....................................................................................................................2726
UseCount.....................................................................................................................................2726
Query Classes Examples...................................................................................................................2726
Creating a New Query............................................................................................................... 2726
Adding Criteria........................................................................................................................... 2728
Using Outer Joins....................................................................................................................... 2733
Chapter 47: Record Class..................................................................................................................... 2735
Understanding Record Class.............................................................................................................2735
Shortcut Considerations.................................................................................................................... 2735
Record Methods Used to Create SQL Statements........................................................................... 2736
Data Type of a Record Object..........................................................................................................2737
Scope of a Record Object.................................................................................................................2737
Record Class Built-in Functions.......................................................................................................2737
Record Class Methods...................................................................................................................... 2737
CompareFields............................................................................................................................ 2737
CopyChangedFieldsTo................................................................................................................2738
CopyFieldsTo.............................................................................................................................. 2739
Delete.......................................................................................................................................... 2742

cii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

ExecuteEdits................................................................................................................................2743
GetField.......................................................................................................................................2745
Insert........................................................................................................................................... 2747
Save.............................................................................................................................................2748
SearchClear................................................................................................................................. 2751
SelectByKey................................................................................................................................2752
SelectByKeyEffDt...................................................................................................................... 2754
SetDefault....................................................................................................................................2756
SetEditTable................................................................................................................................ 2756
Update......................................................................................................................................... 2758
Record Class Properties.................................................................................................................... 2760
FieldCount...................................................................................................................................2760
fieldname.....................................................................................................................................2760
IsChanged................................................................................................................................... 2761
IsDeleted..................................................................................................................................... 2761
IsEditError...................................................................................................................................2762
Name........................................................................................................................................... 2762
ParentRow...................................................................................................................................2763
RelLangRecName....................................................................................................................... 2763
SystemIDFieldName...................................................................................................................2763
TimeStampFieldName................................................................................................................ 2764
Chapter 48: Row Class..........................................................................................................................2765
Understanding Row Class.................................................................................................................2765
Shortcut Considerations.................................................................................................................... 2765
Data Type of a Row Object..............................................................................................................2766
Scope of a Row Object.....................................................................................................................2766
Row Class Built-in Function............................................................................................................ 2766
Row Class Methods.......................................................................................................................... 2766
CopyTo........................................................................................................................................2766
GetNextEffRow.......................................................................................................................... 2767
GetPriorEffRow.......................................................................................................................... 2768
GetRecord................................................................................................................................... 2768
GetRowset...................................................................................................................................2770
scrollname................................................................................................................................... 2771
Row Class Properties........................................................................................................................ 2771
ChildCount.................................................................................................................................. 2772
DeleteEnabled............................................................................................................................. 2772
IsChanged................................................................................................................................... 2773
IsDeleted..................................................................................................................................... 2774
IsEditError...................................................................................................................................2774
IsNew.......................................................................................................................................... 2775
ParentRowset.............................................................................................................................. 2775
recname....................................................................................................................................... 2775
RecordCount............................................................................................................................... 2775
RowNumber................................................................................................................................ 2776
Selected....................................................................................................................................... 2776
Style............................................................................................................................................ 2777
Visible......................................................................................................................................... 2777
Chapter 49: Related Content Framework Classes............................................................................. 2779
Understanding the Related Content Framework Classes................................................................. 2779
RCServiceDefinition Class............................................................................................................... 2780

Copyright © 1988, 2024, Oracle and/or its affiliates. ciii

Contents

RCServiceDefinition Class Methods................................................................................................ 2780

AppendRCParam........................................................................................................................ 2780
CloneForNew.............................................................................................................................. 2781
Delete.......................................................................................................................................... 2782
DeleteRCParam...........................................................................................................................2782
GetRCParamCount......................................................................................................................2783
GetRCParameter......................................................................................................................... 2784
RCServiceDefinition...................................................................................................................2785
Rename........................................................................................................................................2786
Save.............................................................................................................................................2786
RCServiceDefinition Class Properties.............................................................................................. 2787
AppclassId...................................................................................................................................2787
Descr........................................................................................................................................... 2788
EscapeParam............................................................................................................................... 2788
FieldName...................................................................................................................................2788
IsBulkAction............................................................................................................................... 2789
IsNew.......................................................................................................................................... 2789
LanguageCD............................................................................................................................... 2790
Market......................................................................................................................................... 2790
MsgNodeName........................................................................................................................... 2791
PackageRoot................................................................................................................................2791
PcEventType............................................................................................................................... 2791
PcFunctionName.........................................................................................................................2792
PnlGrpName............................................................................................................................... 2792
PnlName......................................................................................................................................2793
PortalMenuName........................................................................................................................ 2793
PortalRecName........................................................................................................................... 2794
PortalUrlAdm..............................................................................................................................2794
PortalUriText...............................................................................................................................2795
PostMapdata................................................................................................................................2795
PtppbPageletId............................................................................................................................ 2795
QualifyPath................................................................................................................................. 2796
Queryname.................................................................................................................................. 2796
SecUseEdit.................................................................................................................................. 2796
ServiceId..................................................................................................................................... 2797
ServiceName............................................................................................................................... 2797
ServiceType.................................................................................................................................2798
ServiceUrlType........................................................................................................................... 2798
SrvcAttribute...............................................................................................................................2799
SrvHelpText................................................................................................................................ 2800
TileCategory................................................................................................................................2800
Useedit........................................................................................................................................ 2800
ValFromDt...................................................................................................................................2801
ValToDt....................................................................................................................................... 2801
RCParameter Class............................................................................................................................2801
RCParameter Class Properties.......................................................................................................... 2802
Descr........................................................................................................................................... 2802
ParameterName...........................................................................................................................2802
RequiredFlg.................................................................................................................................2803
SeqNum.......................................................................................................................................2803
RCService Class................................................................................................................................2803

civ Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

RCService Class Methods................................................................................................................ 2804

AddNewService.......................................................................................................................... 2804
Delete.......................................................................................................................................... 2805
DeleteService.............................................................................................................................. 2806
DeleteServiceInstance.................................................................................................................2807
GetInstanceId.............................................................................................................................. 2808
GetServiceInfo............................................................................................................................ 2808
RCService................................................................................................................................... 2809
Save.............................................................................................................................................2810
RCService Class Properties.............................................................................................................. 2810
ExpandFrame.............................................................................................................................. 2811
IsNew.......................................................................................................................................... 2811
MenuName..................................................................................................................................2811
MinPagelets.................................................................................................................................2812
PnlGrpName............................................................................................................................... 2812
RCFrameLoc...............................................................................................................................2813
RCServiceConfig Class.....................................................................................................................2813
RCServiceConfig Class Methods..................................................................................................... 2814
AddPageFieldMenu.................................................................................................................... 2814
AppendMapField........................................................................................................................ 2815
CloneForNew.............................................................................................................................. 2816
CloneForNewFull........................................................................................................................2817
Delete.......................................................................................................................................... 2819
DeleteMapField...........................................................................................................................2821
GetMapField............................................................................................................................... 2822
GetMapFieldCount......................................................................................................................2822
Save.............................................................................................................................................2823
RCServiceConfig Class Properties................................................................................................... 2824
AllowPersonalization.................................................................................................................. 2824
cEnable........................................................................................................................................2825
cInitMin.......................................................................................................................................2825
CompEvent................................................................................................................................. 2825
CompRecEvent........................................................................................................................... 2826
EventRecName............................................................................................................................2827
FieldName...................................................................................................................................2828
InstanceId.................................................................................................................................... 2828
InstanceLbl..................................................................................................................................2829
IsCompService............................................................................................................................ 2829
IsDefault......................................................................................................................................2829
IsEmbeddable..............................................................................................................................2830
IsNew.......................................................................................................................................... 2830
LanguageCD............................................................................................................................... 2831
MainMenuOpt.............................................................................................................................2831
MenuOpt..................................................................................................................................... 2831
PnlName......................................................................................................................................2832
PortalName..................................................................................................................................2832
PortalObjName............................................................................................................................2832
ProcessSeq.................................................................................................................................. 2833
SeqNum.......................................................................................................................................2833
ServiceId..................................................................................................................................... 2834
SrvcAttribute...............................................................................................................................2834

Copyright © 1988, 2024, Oracle and/or its affiliates. cv

Contents

UrlTarget..................................................................................................................................... 2835
RCMapFields Class...........................................................................................................................2835
RCMapFields Class Methods........................................................................................................... 2836
CopyFrom................................................................................................................................... 2836
Save.............................................................................................................................................2837
RCMapFields Class Properties......................................................................................................... 2838
FieldMenuOpt............................................................................................................................. 2838
MapFieldType............................................................................................................................. 2838
MapNullValue............................................................................................................................. 2839
ParameterName...........................................................................................................................2839
PnlFieldName..............................................................................................................................2840
PnlName......................................................................................................................................2840
RefreshService............................................................................................................................ 2841
RCMenuLayout Class....................................................................................................................... 2841
RCMenuLayout Class Methods........................................................................................................2841
AddFolder................................................................................................................................... 2842
CloneForNew.............................................................................................................................. 2843
CloneForNewFull........................................................................................................................2844
Delete.......................................................................................................................................... 2846
DeleteFolder................................................................................................................................2846
DeleteMenuLink......................................................................................................................... 2847
GetFolder.................................................................................................................................... 2848
GetFolderCount...........................................................................................................................2849
GetFolderFromFolderId.............................................................................................................. 2850
Save.............................................................................................................................................2851
RCMenuLayout Class Properties......................................................................................................2851
IsNew.......................................................................................................................................... 2852
LanguageCD............................................................................................................................... 2852
MenuId........................................................................................................................................ 2852
MenuType................................................................................................................................... 2853
PnlFldName................................................................................................................................ 2853
PnlName......................................................................................................................................2854
PortalName..................................................................................................................................2854
PortalObjName............................................................................................................................2854
RCMenuFolder Class........................................................................................................................ 2855
RCMenuFolder Class Methods.........................................................................................................2855
AppendMenuLink....................................................................................................................... 2855
DeleteMenuLink......................................................................................................................... 2856
GetMenuLink.............................................................................................................................. 2857
GetMenuLinkCount.................................................................................................................... 2858
RCMenuFolder Class Properties.......................................................................................................2859
FolderId.......................................................................................................................................2859
FolderLbl.....................................................................................................................................2859
FolderSeqNum............................................................................................................................ 2860
PrntFolderId................................................................................................................................ 2860
RCMenuLink Class...........................................................................................................................2860
RCMenuLink Class Properties......................................................................................................... 2860
InstanceId.................................................................................................................................... 2861
SeqNum.......................................................................................................................................2861
ServiceId..................................................................................................................................... 2861
Additional PeopleCode Examples.................................................................................................... 2861

cvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Creating Service Definitions and Service Configurations......................................................... 2861

Chapter 50: Rowset Class..................................................................................................................... 2865
Understanding Rowset Class............................................................................................................ 2865
Shortcut Considerations.................................................................................................................... 2865
Data Type of a Rowset Object......................................................................................................... 2866
Scope of a Rowset Object................................................................................................................ 2866
Rowset Class Built-In Functions...................................................................................................... 2866
Rowset Class Methods......................................................................................................................2866
ClearDeletesChanges.................................................................................................................. 2867
CopyTo........................................................................................................................................2868
DeleteRow...................................................................................................................................2870
Fill............................................................................................................................................... 2872
FillAppend.................................................................................................................................. 2875
FillChunk.................................................................................................................................... 2876
Flush............................................................................................................................................2878
FlushRow.................................................................................................................................... 2879
GetCurrEffRow........................................................................................................................... 2880
GetFirstUserSortedRow.............................................................................................................. 2881
GetLastUserSortedRow.............................................................................................................. 2882
GetNewEffRow...........................................................................................................................2883
GetRow....................................................................................................................................... 2883
HideAllRows...............................................................................................................................2884
InsertRow.................................................................................................................................... 2885
IsUserSorted................................................................................................................................2886
MapBufRowToUserSortRow......................................................................................................2887
MapUserSortRowToBufRow......................................................................................................2888
Refresh........................................................................................................................................ 2889
Select...........................................................................................................................................2890
SelectNew................................................................................................................................... 2893
SetDefault....................................................................................................................................2895
ShowAllRows............................................................................................................................. 2895
Sort.............................................................................................................................................. 2896
Rowset Class Properties....................................................................................................................2898
ActiveRowCount.........................................................................................................................2898
ChangeOnInit.............................................................................................................................. 2898
DataAreaCollapsed..................................................................................................................... 2899
DBRecordName.......................................................................................................................... 2899
DeleteEnabled............................................................................................................................. 2900
EffDt............................................................................................................................................2901
EffSeq..........................................................................................................................................2901
InsertEnabled.............................................................................................................................. 2901
IsEditError...................................................................................................................................2902
Level........................................................................................................................................... 2903
Name........................................................................................................................................... 2903
ParentRow...................................................................................................................................2904
ParentRowset.............................................................................................................................. 2904
RowCount................................................................................................................................... 2904
SetComponentChanged...............................................................................................................2904
TopRowNumber..........................................................................................................................2905
Chapter 51: RowsetCache Class...........................................................................................................2907
Understanding a Rowset Cache........................................................................................................2907

Copyright © 1988, 2024, Oracle and/or its affiliates. cvii

Contents

Using the RowsetCache Class.......................................................................................................... 2907

Error Handling.................................................................................................................................. 2908
Data Type of a RowsetCache Object............................................................................................... 2908
Scope of a RowsetCache Object...................................................................................................... 2908
RowsetCache Class Built-in Functions............................................................................................ 2909
RowsetCache Class Methods............................................................................................................2909
Delete.......................................................................................................................................... 2909
Get...............................................................................................................................................2910
Save.............................................................................................................................................2910
RowsetCache Class Properties..........................................................................................................2912
Content........................................................................................................................................ 2912
Description.................................................................................................................................. 2913
Chapter 52: Security Authorization Classes....................................................................................... 2915
Understanding the Security Authorization Classes.......................................................................... 2915
Importing the Security Authorization Classes..................................................................................2915
AuthRequest Class............................................................................................................................ 2915
AuthRequest Class Methods............................................................................................................. 2916
GetParameterValue......................................................................................................................2917
AuthRequest Class Properties...........................................................................................................2917
Access......................................................................................................................................... 2917
UserId..........................................................................................................................................2918
SecurityHandler Class....................................................................................................................... 2918
SecurityHandler Class Methods........................................................................................................2918
GetAuthorization.........................................................................................................................2918
Implementing a Security Authorization Handler..............................................................................2919
Chapter 53: Session Class..................................................................................................................... 2923
Understanding Session Class............................................................................................................ 2923
Security and Access to the PeopleSoft System................................................................................ 2924
Error Handling.................................................................................................................................. 2924
Displaying Error Messages........................................................................................................ 2925
Regional Settings.............................................................................................................................. 2925
Trace Settings....................................................................................................................................2925
Session Object Declaration............................................................................................................... 2926
State Considerations................................................................................................................... 2927
Considerations for Declaring Collections.................................................................................. 2927
Scope of a Session Object................................................................................................................ 2927
Session Class Built-in Function........................................................................................................2927
Session Class Methods......................................................................................................................2928
Connect....................................................................................................................................... 2928
Disconnect...................................................................................................................................2930
API Instantiation Methods................................................................................................................ 2930
Session Class Properties................................................................................................................... 2931
ErrorPending............................................................................................................................... 2931
PSMessages.................................................................................................................................2931
PSMessagesMode....................................................................................................................... 2932
RegionalSettings......................................................................................................................... 2933
Repository................................................................................................................................... 2933
SuspendFormatting..................................................................................................................... 2933
TraceSettings...............................................................................................................................2933
WarningPending..........................................................................................................................2934
Accessing a PSMessages Collection................................................................................................ 2934

cviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

PSMessages Collection Methods......................................................................................................2934

DeleteAll..................................................................................................................................... 2935
DeleteItem...................................................................................................................................2935
First............................................................................................................................................. 2936
Item............................................................................................................................................. 2936
Next.............................................................................................................................................2937
PSMessages Collection Property...................................................................................................... 2937
Count...........................................................................................................................................2937
PSMessage Class Properties............................................................................................................. 2937
ExplainText................................................................................................................................. 2937
MessageNumber..........................................................................................................................2938
MessageSetNumber.................................................................................................................... 2938
MessageType...............................................................................................................................2938
Source......................................................................................................................................... 2939
Text..............................................................................................................................................2940
Regional Settings Class Properties................................................................................................... 2941
ClientTimeZone.......................................................................................................................... 2941
CurrencyFormat.......................................................................................................................... 2941
CurrencySymbol......................................................................................................................... 2942
DateFormat..................................................................................................................................2942
DateSeparator..............................................................................................................................2942
DecimalSymbol...........................................................................................................................2943
DigitGroupingSymbol.................................................................................................................2943
LanguageCD............................................................................................................................... 2943
UseLocalTime............................................................................................................................. 2944
1159Separator............................................................................................................................. 2944
2359Separator............................................................................................................................. 2945
Trace Setting Class Properties.......................................................................................................... 2945
API.............................................................................................................................................. 2945
COBOLStmtTimings.................................................................................................................. 2946
ConnDisRollbackCommit...........................................................................................................2946
DBSpecificCalls..........................................................................................................................2946
ManagerInfo................................................................................................................................2946
NetworkServices......................................................................................................................... 2946
NonSSBs..................................................................................................................................... 2947
OutputUNICODE....................................................................................................................... 2947
PCExtFcnCalls............................................................................................................................ 2947
PCFcnReturnValues.................................................................................................................... 2947
PCFetchedValues........................................................................................................................ 2947
PCIntFcnCalls............................................................................................................................. 2948
PCListProgram............................................................................................................................2948
PCParameterValues.....................................................................................................................2948
PCProgramStatements................................................................................................................ 2948
PCStack.......................................................................................................................................2948
PCStartOfPrograms.....................................................................................................................2949
PCTraceProgram......................................................................................................................... 2949
PCVariableAssignments..............................................................................................................2949
RowFetch.................................................................................................................................... 2949
SQLStatement............................................................................................................................. 2949
SQLStatementVariables.............................................................................................................. 2950
SSBs............................................................................................................................................ 2950

Copyright © 1988, 2024, Oracle and/or its affiliates. cix

Contents

SybBindInfo................................................................................................................................ 2950
SybFetchInfo...............................................................................................................................2950
TraceFile..................................................................................................................................... 2951
Chapter 54: SOAPDoc Class................................................................................................................ 2953
Understanding theSOAPDoc Class...................................................................................................2953
SOAP Message Exchange Model.....................................................................................................2953
SOAP Message Document................................................................................................................2954
The SOAPDoc Class.........................................................................................................................2955
SOAPDoc Object Creation............................................................................................................... 2956
SOAP Header Section................................................................................................................ 2956
SOAP Envelope Section.............................................................................................................2956
SOAP Body Section................................................................................................................... 2956
SOAP Method Section............................................................................................................... 2957
SOAPDoc Section Access..........................................................................................................2957
PeopleCode to Create a SOAPDoc............................................................................................2958
SOAPDoc Fault Section.............................................................................................................2958
The ValidateSOAPDoc Method........................................................................................................2958
SOAPDoc Objects and Messages.....................................................................................................2959
Data Type of a SOAPDoc Object.................................................................................................... 2959
Scope of a SOAPDoc Object........................................................................................................... 2959
SOAPDoc Built-In Functions........................................................................................................... 2960
SOAPDoc Class Methods.................................................................................................................2960
AddBody..................................................................................................................................... 2960
AddEnvelope...............................................................................................................................2961
AddFault..................................................................................................................................... 2964
AddHeader.................................................................................................................................. 2965
AddMethod................................................................................................................................. 2967
AddParm..................................................................................................................................... 2968
GetParmName.............................................................................................................................2969
GetParmValue............................................................................................................................. 2969
ValidateSOAPDoc.......................................................................................................................2970
SOAPDoc Class Properties...............................................................................................................2971
BodyNode................................................................................................................................... 2971
EnvelopeNode.............................................................................................................................2972
FaultCode.................................................................................................................................... 2972
FaultCodeS..................................................................................................................................2972
FaultString...................................................................................................................................2973
HeaderNode................................................................................................................................ 2973
MethodName...............................................................................................................................2974
MethodNode............................................................................................................................... 2974
ParmCount.................................................................................................................................. 2975
XmlDoc.......................................................................................................................................2975
SOAPDoc Class Examples............................................................................................................... 2975
Creating a SOAP Document...................................................................................................... 2976
Reading an Existing SOAP Document...................................................................................... 2976
Using SOAP XML Text.............................................................................................................2976
Chapter 55: SQL Class..........................................................................................................................2979
Understanding SQL Class.................................................................................................................2979
Using Record Class SQL..................................................................................................................2980
Creating a SQL Definition................................................................................................................2980
Binding and Executing of SQL Statements......................................................................................2981

cx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Fetching From a SELECT................................................................................................................ 2982

Using Array of Any for Bind Values or Fetch Results.................................................................... 2982
Reusing a Cursor...............................................................................................................................2983
Using the ReuseCursor Property................................................................................................2983
Reusing a Cursor Without the ReuseCursor Property............................................................... 2983
Understanding SQL Objects and Application Engine Programs......................................................2985
Declaring a SQL Object................................................................................................................... 2985
Scope of an SQL Object...................................................................................................................2985
SQL Class Built-in Functions...........................................................................................................2986
SQL Class Methods.......................................................................................................................... 2986
Close........................................................................................................................................... 2986
Execute........................................................................................................................................2987
Fetch............................................................................................................................................2988
Open............................................................................................................................................ 2990
SQL Class Properties........................................................................................................................ 2991
BulkMode................................................................................................................................... 2992
IsOpen......................................................................................................................................... 2993
LTrim...........................................................................................................................................2993
ReuseCursor................................................................................................................................ 2994
RowsAffected..............................................................................................................................2994
Status...........................................................................................................................................2995
TraceName.................................................................................................................................. 2995
Value........................................................................................................................................... 2996
Chapter 56: Tile Wizard and Other Tile Classes...............................................................................2999
Understanding the Tile Wizard Classes............................................................................................2999
Understanding Other Tile Classes.................................................................................................... 2999
Understanding Application Class Tile Content................................................................................ 3000
Tile Title..................................................................................................................................... 3001
Tile Content................................................................................................................................ 3001
Live Data.................................................................................................................................... 3002
Trend Image................................................................................................................................3002
Badge Data................................................................................................................................. 3002
Example of Tile Content............................................................................................................ 3003
Implementing an Application Class for Tile Content.......................................................................3005
Properties and Methods Required by Tile Content Type...........................................................3006
Tile Class Methods........................................................................................................................... 3007
getAmountFormattedValue......................................................................................................... 3007
getTileLiveData...........................................................................................................................3008
SetTileContentAsChart............................................................................................................... 3009
SetTileContentAsChartAndKPI..................................................................................................3009
SetTileContentAsHTML.............................................................................................................3010
SetTileContentAsImage.............................................................................................................. 3010
SetTileContentAsOneKPI........................................................................................................... 3011
SetTileContentAsTwoKPIs......................................................................................................... 3012
SetTileContentAsTwoKPIsTopBottom.......................................................................................3012
setTileContentOption.................................................................................................................. 3013
setTileHasCount..........................................................................................................................3013
setTileID......................................................................................................................................3014
setTileImageRef.......................................................................................................................... 3014
setTileLiveData........................................................................................................................... 3015
Tile.............................................................................................................................................. 3016

Copyright © 1988, 2024, Oracle and/or its affiliates. cxi

Contents

Tile Class Properties......................................................................................................................... 3017

GroupletIDStyleClass................................................................................................................. 3017
hasContent...................................................................................................................................3017
hasLiveDataCount.......................................................................................................................3018
hasLiveDataDescr....................................................................................................................... 3018
hasLivedataTrendImage.............................................................................................................. 3019
ImageReferenceField.................................................................................................................. 3020
isTileLiveData_1_Metrics...........................................................................................................3020
isTileLiveData_1_MetricsLabel................................................................................................. 3020
isTileLiveData_2_Metrics...........................................................................................................3021
isTileLiveData_2_MetricsLabel................................................................................................. 3021
isTileLiveData_3_Metrics...........................................................................................................3022
isTileLiveData_3_MetricsLabel................................................................................................. 3022
PreferencesUrl.............................................................................................................................3022
PreferencesUrlLabel....................................................................................................................3023
Tilechart...................................................................................................................................... 3023
TileContentOption.......................................................................................................................3024
TileHtmlArea.............................................................................................................................. 3024
TileHtmlAreaStyle...................................................................................................................... 3024
TileID.......................................................................................................................................... 3025
TileImageReferenceLabel........................................................................................................... 3025
TileKPI_1....................................................................................................................................3025
TileKPI_1_Label.........................................................................................................................3026
TileKPI_2....................................................................................................................................3027
TileKPI_2_Label.........................................................................................................................3027
TileKPI_2_Layout.......................................................................................................................3027
TileLiveData_1........................................................................................................................... 3028
TileLiveData_2........................................................................................................................... 3028
TileLiveData_3........................................................................................................................... 3029
TileSpecificStyleSheet................................................................................................................ 3029
TileTransCount............................................................................................................................3030
TrendImage................................................................................................................................. 3030
ImageTile Class Methods................................................................................................................. 3031
AddToHomePage........................................................................................................................ 3031
Delete.......................................................................................................................................... 3032
ImageTile.................................................................................................................................... 3033
Publish.........................................................................................................................................3034
Save.............................................................................................................................................3035
ImageTile Class Properties............................................................................................................... 3035
AlternateHeight...........................................................................................................................3036
AlternateWidth............................................................................................................................ 3036
Description.................................................................................................................................. 3037
DisableHotspot............................................................................................................................3037
DisplayMode...............................................................................................................................3037
EventName..................................................................................................................................3038
Height..........................................................................................................................................3038
ImageName................................................................................................................................. 3038
IsAuthorAccess........................................................................................................................... 3039
IsAutosize................................................................................................................................... 3039
IsInteractive.................................................................................................................................3039
IsPublic....................................................................................................................................... 3040

cxii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

IsPublished.................................................................................................................................. 3040
IsResizable.................................................................................................................................. 3040
ModalParameters........................................................................................................................ 3041
Name........................................................................................................................................... 3041
Owner..........................................................................................................................................3041
ParentFolder................................................................................................................................ 3041
Permissions................................................................................................................................. 3042
RefreshFrequency....................................................................................................................... 3042
Roles........................................................................................................................................... 3042
ShowingSequence....................................................................................................................... 3043
TargetCrefName..........................................................................................................................3043
Title............................................................................................................................................. 3043
UseInDashboard..........................................................................................................................3044
UseInHomePage..........................................................................................................................3044
UseInNavBar...............................................................................................................................3044
Width...........................................................................................................................................3045
FreeTextTile Class Methods............................................................................................................. 3045
FreeTextTile................................................................................................................................ 3045
FreeTextTile Class Properties........................................................................................................... 3046
Content........................................................................................................................................ 3047
TileAppFilter Class Methods............................................................................................................ 3047
IsTileVisible................................................................................................................................ 3047
Chapter 57: TransformData Class....................................................................................................... 3049
Understanding the TransformData Class.......................................................................................... 3049
Creating a TransformData Object.....................................................................................................3049
TransformData Class Properties....................................................................................................... 3049
DestMsgName.............................................................................................................................3050
DestMsgVersion.......................................................................................................................... 3050
DestNode.....................................................................................................................................3050
RejectTransform..........................................................................................................................3050
RoutingDefnName...................................................................................................................... 3051
SourceMsgName.........................................................................................................................3051
SourceMsgVersion...................................................................................................................... 3051
SourceNode.................................................................................................................................3051
Status...........................................................................................................................................3051
XmlDoc.......................................................................................................................................3052
Chapter 58: Tree Classes.......................................................................................................................3053
Understanding Tree Classes..............................................................................................................3053
Relationships Between Different Tree Classes.................................................................................3055
Collections in the Tree Classes........................................................................................................ 3056
Error Handling With Trees............................................................................................................... 3056
Leaves and Nodes Insert Verification...............................................................................................3057
Restrictions on Trees When Used as a SmartNavigation Data Source............................................ 3058
Data Types for Tree Objects.............................................................................................................3059
Scope of the Tree Objects................................................................................................................ 3059
Tree Classes Implementation............................................................................................................ 3059
Tree Classes Reference..................................................................................................................... 3062
Session Class Methods......................................................................................................................3062
GetTree........................................................................................................................................3062
GetTreeStructure......................................................................................................................... 3063
Branch Collection..............................................................................................................................3063

Copyright © 1988, 2024, Oracle and/or its affiliates. cxiii

Contents

Branch Collection Property.............................................................................................................. 3063

Count...........................................................................................................................................3063
Leaf Class..........................................................................................................................................3064
Leaf Class Methods.......................................................................................................................... 3064
Cut...............................................................................................................................................3064
Delete.......................................................................................................................................... 3065
DeleteByRange........................................................................................................................... 3065
GenABNMenuElement...............................................................................................................3066
GenABNMenuElementWithImage............................................................................................. 3066
InsertDynSib............................................................................................................................... 3067
InsertSib...................................................................................................................................... 3068
LoadABNChart........................................................................................................................... 3069
LoadABNChartOrdered.............................................................................................................. 3069
MoveAsChild.............................................................................................................................. 3070
MoveAsChildByName................................................................................................................3071
MoveAsSib................................................................................................................................. 3072
MoveAsSibByRange...................................................................................................................3072
PasteSib.......................................................................................................................................3073
RefreshDescription......................................................................................................................3074
UpdateRanges............................................................................................................................. 3074
Leaf Class Properties........................................................................................................................ 3075
Description.................................................................................................................................. 3075
DisplayLevelNumber.................................................................................................................. 3075
Dynamic...................................................................................................................................... 3076
HasNextSib................................................................................................................................. 3076
HasPrevSib..................................................................................................................................3076
ImageName................................................................................................................................. 3076
IsChanged................................................................................................................................... 3076
IsCut............................................................................................................................................ 3077
IsDeleted..................................................................................................................................... 3077
IsInserted.....................................................................................................................................3077
NextSib....................................................................................................................................... 3077
Parent.......................................................................................................................................... 3078
PrevSib........................................................................................................................................ 3078
RangeFrom..................................................................................................................................3078
RangeTo...................................................................................................................................... 3078
TreeBranchName........................................................................................................................ 3079
TreeEffDt.................................................................................................................................... 3079
TreeName....................................................................................................................................3079
TreeSetId..................................................................................................................................... 3079
TreeUserKeyValue...................................................................................................................... 3079
Level Collection................................................................................................................................ 3079
Level Collection Methods.................................................................................................................3080
Add..............................................................................................................................................3080
Item............................................................................................................................................. 3080
Remove....................................................................................................................................... 3081
Level Collection Properties.............................................................................................................. 3081
Count...........................................................................................................................................3081
First............................................................................................................................................. 3081
Last..............................................................................................................................................3082
Next.............................................................................................................................................3082

cxiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Level Class........................................................................................................................................ 3082

Level Class Methods.........................................................................................................................3082
Create.......................................................................................................................................... 3082
Level Class Properties...................................................................................................................... 3083
AllValuesAudit............................................................................................................................3083
Description.................................................................................................................................. 3083
Name........................................................................................................................................... 3083
Number....................................................................................................................................... 3083
TreeBranchName........................................................................................................................ 3084
TreeEffDt.................................................................................................................................... 3084
TreeName....................................................................................................................................3084
TreeSetId..................................................................................................................................... 3084
TreeUserKeyValue...................................................................................................................... 3084
Node Class........................................................................................................................................ 3084
Node Class Methods......................................................................................................................... 3085
Branch......................................................................................................................................... 3085
Cut...............................................................................................................................................3085
Delete.......................................................................................................................................... 3086
DeleteByName............................................................................................................................ 3086
Expand........................................................................................................................................ 3087
GenABNMenuElement...............................................................................................................3087
GenABNMenuElementWithImage............................................................................................. 3088
GenBreadCrumbs........................................................................................................................3089
GenRelatedActions..................................................................................................................... 3090
InsertChildLeaf........................................................................................................................... 3090
InsertChildNode.......................................................................................................................... 3091
InsertChildRecord....................................................................................................................... 3092
InsertDynChildLeaf.................................................................................................................... 3093
InsertSib...................................................................................................................................... 3094
InsertSibRecord...........................................................................................................................3094
LoadABNChart........................................................................................................................... 3095
LoadABNChartOrdered.............................................................................................................. 3096
MoveAsChild.............................................................................................................................. 3097
MoveAsChildByName................................................................................................................3097
MoveAsSib................................................................................................................................. 3098
MoveAsSibByName................................................................................................................... 3099
PasteChild................................................................................................................................... 3100
PasteSib.......................................................................................................................................3100
RefreshDescription......................................................................................................................3100
Rename........................................................................................................................................3101
SwitchLevel................................................................................................................................ 3101
Unbranch.....................................................................................................................................3102
Node Class Properties.......................................................................................................................3103
AllChildCount.............................................................................................................................3103
AllChildNodeCount.................................................................................................................... 3103
ChildLeafCount...........................................................................................................................3103
ChildNodeCount......................................................................................................................... 3103
ColImageName........................................................................................................................... 3104
Description.................................................................................................................................. 3104
DisplayLevelNumber.................................................................................................................. 3104
ExpImageName...........................................................................................................................3104

Copyright © 1988, 2024, Oracle and/or its affiliates. cxv

Contents

FirstChildLeaf............................................................................................................................. 3104
FirstChildNode............................................................................................................................3105
HasChildLeaves.......................................................................................................................... 3105
HasChildNodes........................................................................................................................... 3105
HasChildren................................................................................................................................ 3105
HasNextSib................................................................................................................................. 3105
HasPrevSib..................................................................................................................................3106
IsBranched.................................................................................................................................. 3106
IsChanged................................................................................................................................... 3106
IsCut............................................................................................................................................ 3106
IsDeleted..................................................................................................................................... 3106
IsInserted.....................................................................................................................................3107
IsRoot.......................................................................................................................................... 3107
LastChildLeaf..............................................................................................................................3107
LastChildNode............................................................................................................................ 3107
LevelNumber.............................................................................................................................. 3108
Name........................................................................................................................................... 3108
NextSib....................................................................................................................................... 3108
Parent.......................................................................................................................................... 3109
PrevSib........................................................................................................................................ 3109
State.............................................................................................................................................3109
TreeBranchName........................................................................................................................ 3110
TreeEffDt.................................................................................................................................... 3110
TreeName....................................................................................................................................3110
TreeSetId..................................................................................................................................... 3110
TreeUserKeyValue...................................................................................................................... 3111
Type.............................................................................................................................................3111
Tree Class..........................................................................................................................................3111
Tree Class Methods...........................................................................................................................3112
Audit........................................................................................................................................... 3112
AuditByName............................................................................................................................. 3112
Close........................................................................................................................................... 3114
Copy............................................................................................................................................ 3114
Create.......................................................................................................................................... 3116
Delete.......................................................................................................................................... 3118
Exists...........................................................................................................................................3119
FindLeaf...................................................................................................................................... 3120
FindNode.....................................................................................................................................3121
FindRoot..................................................................................................................................... 3122
InsertRoot....................................................................................................................................3123
LeafExists....................................................................................................................................3123
LockTree..................................................................................................................................... 3124
Open............................................................................................................................................ 3125
OpenAsOfDate............................................................................................................................3127
OpenForExport........................................................................................................................... 3128
OpenWholeTree.......................................................................................................................... 3130
NodeExists.................................................................................................................................. 3131
Rename........................................................................................................................................3131
Save.............................................................................................................................................3133
SaveAs........................................................................................................................................ 3134
SaveAsDraft................................................................................................................................ 3135

cxvi Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

SaveDraft.................................................................................................................................... 3136
SetImportMode........................................................................................................................... 3137
TreeLocksNumber.......................................................................................................................3138
UnlockTree..................................................................................................................................3139
UpdateLock.................................................................................................................................3140
Tree Class Properties........................................................................................................................ 3141
AllValues.....................................................................................................................................3141
AuditDetails................................................................................................................................ 3141
Branches......................................................................................................................................3141
BranchImageName......................................................................................................................3142
BranchLevel................................................................................................................................ 3142
BranchName................................................................................................................................3142
Category...................................................................................................................................... 3142
Description.................................................................................................................................. 3143
DuplicateLeaves..........................................................................................................................3143
EffDt............................................................................................................................................3143
HasDetailRanges.........................................................................................................................3144
HasLockedBranches....................................................................................................................3144
IsBranched.................................................................................................................................. 3144
IsChanged................................................................................................................................... 3145
IsOpen......................................................................................................................................... 3145
IsQueryTree.................................................................................................................................3145
IsValid......................................................................................................................................... 3146
IsVersionChanged....................................................................................................................... 3146
IsWholeTree................................................................................................................................3146
KeyBranchName.........................................................................................................................3147
KeyEffDt..................................................................................................................................... 3147
KeyName.................................................................................................................................... 3147
KeySetId..................................................................................................................................... 3147
KeyUserKeyValue.......................................................................................................................3148
LeafCount....................................................................................................................................3148
LeafImageName..........................................................................................................................3148
LeafOnClipboard........................................................................................................................ 3148
LevelCount..................................................................................................................................3148
Levels.......................................................................................................................................... 3149
LevelUse..................................................................................................................................... 3149
LockOwner................................................................................................................................. 3150
LockStatus...................................................................................................................................3150
Name........................................................................................................................................... 3151
NodeColImageName...................................................................................................................3151
NodeCount.................................................................................................................................. 3151
NodeExpImageName.................................................................................................................. 3151
NodeOnClipboard....................................................................................................................... 3152
ParentLevel................................................................................................................................. 3152
ParentName.................................................................................................................................3152
PerformanceMethod....................................................................................................................3152
PerformanceSelector................................................................................................................... 3153
PerformanceSelectorOption........................................................................................................ 3154
SetID........................................................................................................................................... 3154
Status...........................................................................................................................................3155
Structure...................................................................................................................................... 3155

Copyright © 1988, 2024, Oracle and/or its affiliates. cxvii

Contents

StructureName............................................................................................................................ 3155
TreeImageName..........................................................................................................................3156
UserKeyValue............................................................................................................................. 3156
UseUpdateReservation................................................................................................................3156
Tree Structure Class..........................................................................................................................3156
Tree Structure Class Methods...........................................................................................................3157
Close........................................................................................................................................... 3157
Copy............................................................................................................................................ 3157
Create.......................................................................................................................................... 3158
Delete.......................................................................................................................................... 3158
Open............................................................................................................................................ 3159
Rename........................................................................................................................................3159
Save.............................................................................................................................................3160
Tree Structure Class Properties........................................................................................................ 3160
Description.................................................................................................................................. 3160
DetailComponent........................................................................................................................ 3161
DetailField...................................................................................................................................3161
DetailMenu..................................................................................................................................3161
DetailMenuBar............................................................................................................................3162
DetailMenuItem.......................................................................................................................... 3162
DetailMultiNavigate....................................................................................................................3162
DetailPage................................................................................................................................... 3163
DetailRecord............................................................................................................................... 3163
IndirectionMethod.......................................................................................................................3164
KeyName.................................................................................................................................... 3165
LevelComponent.........................................................................................................................3165
LevelMenu.................................................................................................................................. 3165
LevelMenuBar............................................................................................................................ 3165
LevelMenuItem...........................................................................................................................3166
LevelPage....................................................................................................................................3166
LevelRecord................................................................................................................................ 3166
Name........................................................................................................................................... 3166
NodeComponent......................................................................................................................... 3167
NodeField....................................................................................................................................3167
NodeMenu...................................................................................................................................3168
NodeMenuBar.............................................................................................................................3168
NodeMenuItem........................................................................................................................... 3168
NodeMultiNavigate.....................................................................................................................3168
NodePage.................................................................................................................................... 3169
NodeRecord................................................................................................................................ 3169
NodeUserKeyField......................................................................................................................3169
SummarySetId.............................................................................................................................3170
SummaryLevelNumber...............................................................................................................3170
SummaryTreeName.................................................................................................................... 3170
SummaryUserKeyValue..............................................................................................................3171
Type.............................................................................................................................................3171
Traverse Tree Hierarchy Example.................................................................................................... 3171
Chapter 59: Universal Queue Classes..................................................................................................3173
Understanding Universal Queue Classes..........................................................................................3173
Scope of the Universal Queue Classes.............................................................................................3173
Data Types of the Universal Queue Classes.................................................................................... 3173

cxviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

How to Import Universal Queue Classes......................................................................................... 3174

How to Create a Universal Queue Object........................................................................................3175
Universal Queue Classes Built-in Functions.................................................................................... 3175
Universal Queue Classes Constructors.............................................................................................3175
Agent...........................................................................................................................................3175
AgentPhysQueueProps............................................................................................................... 3176
AgentPhysQueueTasks................................................................................................................3177
Broadcast.....................................................................................................................................3177
LogicalQueue.............................................................................................................................. 3178
MCFFactory................................................................................................................................ 3178
PhysicalQueue.............................................................................................................................3179
Task............................................................................................................................................. 3180
TaskList.......................................................................................................................................3181
Util.............................................................................................................................................. 3182
Agent Class....................................................................................................................................... 3183
Agent Methods.................................................................................................................................. 3183
Delete.......................................................................................................................................... 3183
Refresh........................................................................................................................................ 3184
RefreshQTaskList........................................................................................................................3185
Agent Properties................................................................................................................................3185
AgentID.......................................................................................................................................3186
AgentProps..................................................................................................................................3186
AgentTasks..................................................................................................................................3186
Buddy.......................................................................................................................................... 3187
Language.....................................................................................................................................3187
Name........................................................................................................................................... 3187
NickName................................................................................................................................... 3187
PhysicalQueueID........................................................................................................................ 3188
TotalPhysicalQueues................................................................................................................... 3188
AgentPhysQueueProps Class............................................................................................................ 3188
AgentPhysQueueProps Properties.....................................................................................................3188
AgentID.......................................................................................................................................3189
PhysicalQueueID........................................................................................................................ 3189
SkillLevel.................................................................................................................................... 3189
WorkLoad....................................................................................................................................3189
AgentPhysQueueTasks Class............................................................................................................ 3190
AgentPhysQueueTasks Method........................................................................................................ 3190
Refresh........................................................................................................................................ 3190
AgentPhysQueueTasks Properties.....................................................................................................3191
AcceptedTaskList........................................................................................................................3191
AssignedTaskList........................................................................................................................ 3191
AgentID.......................................................................................................................................3191
PhysicalQueueID........................................................................................................................ 3191
Broadcast Class................................................................................................................................. 3192
Broadcast Class Method................................................................................................................... 3192
Broadcast.....................................................................................................................................3192
LogicalQueue Class.......................................................................................................................... 3194
LogicalQueue Properties................................................................................................................... 3194
LogicalQueueID..........................................................................................................................3194
PhysicalQueueID........................................................................................................................ 3194
MCFFactory Class............................................................................................................................ 3194

Copyright © 1988, 2024, Oracle and/or its affiliates. cxix

Contents

MCFFactory Property....................................................................................................................... 3195

LogicalQueue.............................................................................................................................. 3195
PhysicalQueue Class......................................................................................................................... 3195
PhysicalQueue Methods....................................................................................................................3195
Refresh........................................................................................................................................ 3195
RefreshTaskList.......................................................................................................................... 3196
PhysicalQueue Properties..................................................................................................................3196
AcceptedTaskList........................................................................................................................3197
AssignedTaskList........................................................................................................................ 3197
Agent...........................................................................................................................................3197
BrowserURL............................................................................................................................... 3197
EnqueuedTaskList....................................................................................................................... 3198
EscalatedTaskList........................................................................................................................3198
InternalURL................................................................................................................................ 3198
IsActive....................................................................................................................................... 3199
LogicalQueueID..........................................................................................................................3199
OverflowedTaskList....................................................................................................................3199
PhysicalQueueID........................................................................................................................ 3200
RENURLID................................................................................................................................ 3200
TotalAgents................................................................................................................................. 3200
Task Class..........................................................................................................................................3200
Task Methods.................................................................................................................................... 3200
Close........................................................................................................................................... 3200
Enqueue.......................................................................................................................................3201
Refresh........................................................................................................................................ 3203
RefreshStatus.............................................................................................................................. 3203
Task Properties.................................................................................................................................. 3204
AgentID.......................................................................................................................................3204
ApplicationData.......................................................................................................................... 3204
Comments................................................................................................................................... 3204
EnqueueTime.............................................................................................................................. 3205
EscalationTime............................................................................................................................3205
Language.....................................................................................................................................3205
OriginalTime............................................................................................................................... 3205
OverFlowTime............................................................................................................................ 3205
PhysicalQueueID........................................................................................................................ 3206
TiedAgentID............................................................................................................................... 3206
TaskList Class................................................................................................................................... 3206
TaskList Method................................................................................................................................3206
Refresh........................................................................................................................................ 3206
TaskList Properties............................................................................................................................3207
AgentID.......................................................................................................................................3207
PhysicalQueueID........................................................................................................................ 3207
Task............................................................................................................................................. 3207
TaskType..................................................................................................................................... 3208
Total............................................................................................................................................ 3208
Util Class...........................................................................................................................................3208
Util Methods......................................................................................................................................3208
GetLogicalQueue........................................................................................................................ 3208
GetTimeDiff................................................................................................................................ 3209
MCFFactory Example....................................................................................................................... 3210

cxx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Chapter 60: Workflow Notification Classes........................................................................................3213

Understanding Notification Classes..................................................................................................3213
Scope of the Notification Classes.....................................................................................................3213
Data Types of the Notification Classes............................................................................................ 3213
How to Import the Notification Classes...........................................................................................3214
How to Create a Notification Object................................................................................................3214
Notification Classes Constructors.....................................................................................................3215
Notification................................................................................................................................. 3215
NotificationAddress.................................................................................................................... 3216
NotificationTemplate.................................................................................................................. 3217
Worklist....................................................................................................................................... 3218
WorklistEntry.............................................................................................................................. 3219
WSWorklistEntry........................................................................................................................ 3219
Notification Class..............................................................................................................................3220
Notification Class Import Statements...............................................................................................3220
Notification Class Method................................................................................................................ 3220
Send.............................................................................................................................................3221
Notification Class Properties............................................................................................................ 3221
ContentType................................................................................................................................ 3221
dttmCreated.................................................................................................................................3221
EmailReplyTo............................................................................................................................. 3222
FileNames................................................................................................................................... 3222
FileTitles..................................................................................................................................... 3222
language_cd................................................................................................................................ 3222
Message.......................................................................................................................................3223
NotifyBCC.................................................................................................................................. 3223
NotifyCC.....................................................................................................................................3223
NotifyFrom................................................................................................................................. 3224
NotifyGuid.................................................................................................................................. 3224
NotifyTo...................................................................................................................................... 3224
Rte............................................................................................................................................... 3224
SourceComponent.......................................................................................................................3224
SourceMarket.............................................................................................................................. 3225
SourceMenu................................................................................................................................ 3225
Subject.........................................................................................................................................3225
Template......................................................................................................................................3225
NotificationAddress Class.................................................................................................................3225
NotificationAddress Class Properties............................................................................................... 3226
Channel....................................................................................................................................... 3226
Description.................................................................................................................................. 3226
EmailId........................................................................................................................................3226
Language.....................................................................................................................................3226
Oprid........................................................................................................................................... 3227
NotificationTemplate Class............................................................................................................... 3227
NotificationTemplate Class Methods................................................................................................3227
GetAndExpandTemplate............................................................................................................. 3227
SetupCompVarsAndRcpts...........................................................................................................3228
SetupCompVarsAndRcptsLevel1................................................................................................3229
SetupGenericVars........................................................................................................................3230
NotificationTemplate Class Properties..............................................................................................3231
ComponentId...............................................................................................................................3231

Copyright © 1988, 2024, Oracle and/or its affiliates. cxxi

Contents

Instruction................................................................................................................................... 3231
Language.....................................................................................................................................3231
Market......................................................................................................................................... 3231
Priority........................................................................................................................................ 3232
Responses....................................................................................................................................3232
Subject.........................................................................................................................................3232
TemplateId.................................................................................................................................. 3232
TemplateType..............................................................................................................................3232
Text..............................................................................................................................................3233
Worklist Class................................................................................................................................... 3233
Worklist Class Method......................................................................................................................3233
Reassign...................................................................................................................................... 3233
WorklistEntry Class...........................................................................................................................3234
WorklistEntry Class Methods........................................................................................................... 3234
Create.......................................................................................................................................... 3234
GetResponseStatus......................................................................................................................3235
Reassign...................................................................................................................................... 3236
Save.............................................................................................................................................3237
SaveWithCustomData................................................................................................................. 3238
SelectByKey................................................................................................................................3239
SelectByMessageId.....................................................................................................................3240
Update......................................................................................................................................... 3240
WorklistEntry Class Properties......................................................................................................... 3241
actiondttm....................................................................................................................................3241
busactivity................................................................................................................................... 3241
buseventname..............................................................................................................................3242
busprocname............................................................................................................................... 3242
commentshort..............................................................................................................................3242
do_replicate_flag.........................................................................................................................3242
instanceid.................................................................................................................................... 3242
instselecteddttm...........................................................................................................................3243
inststatus......................................................................................................................................3243
insttimeoutddttm......................................................................................................................... 3243
instworkeddttm............................................................................................................................3244
IsCreatedViaWebService.............................................................................................................3244
oprid............................................................................................................................................ 3244
originatorid..................................................................................................................................3244
prevoprid..................................................................................................................................... 3244
requestmessageid........................................................................................................................ 3244
ResponseStatus............................................................................................................................3245
syncid.......................................................................................................................................... 3245
timedout...................................................................................................................................... 3245
transactionid................................................................................................................................ 3246
url................................................................................................................................................ 3246
wl_priority...................................................................................................................................3246
wldaystoselect............................................................................................................................. 3246
wldaystowork.............................................................................................................................. 3247
worklistname...............................................................................................................................3247
WSWorklistEntry Class.....................................................................................................................3247
WSWorklistEntry Class Methods..................................................................................................... 3247
OnError....................................................................................................................................... 3247

cxxii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

OnNotify..................................................................................................................................... 3248
WSWorklistEntry Class Properties................................................................................................... 3249
InstanceID................................................................................................................................... 3249
TransactionID..............................................................................................................................3249
Notification Classes Examples......................................................................................................... 3249
Creating a WorklistEntry............................................................................................................3249
Updating a WorklistEntry...........................................................................................................3251
Chapter 61: XmlDoc Classes................................................................................................................ 3253
Understanding XmlDoc Classes....................................................................................................... 3253
When to Use an XmlDoc Object..................................................................................................... 3253
XmlDoc Object Creation.................................................................................................................. 3254
Considerations Using a Unique Namespace.............................................................................. 3254
Considerations Using Rowsets...................................................................................................3255
XmlNode Class Considerations........................................................................................................ 3256
Accessing and Traversing an XmlNode Object.........................................................................3256
Error Handling.................................................................................................................................. 3257
SOAPDoc Object Considerations..................................................................................................... 3257
Scope of XmlDoc and XmlNode Objects........................................................................................ 3258
Data Type of an XmlDoc or XmlNode Object................................................................................ 3258
XmlDoc Classes Built-in Functions................................................................................................. 3258
XmlDoc Class Methods.................................................................................................................... 3258
CopyRowset................................................................................................................................ 3259
CopyToPSFTMessage.................................................................................................................3260
CopyToRowset............................................................................................................................3261
CreateDocumentElement............................................................................................................ 3263
CreateDocumentType..................................................................................................................3264
GenFormattedXmlString.............................................................................................................3266
GenXmlFile.................................................................................................................................3266
GenXmlString............................................................................................................................. 3267
GetElementsByTagName............................................................................................................3268
LoadIBContent............................................................................................................................3269
ParseXmlFromURL.................................................................................................................... 3270
ParseXmlString........................................................................................................................... 3272
XmlDoc Properties............................................................................................................................3273
DocumentElement.......................................................................................................................3273
IsNull...........................................................................................................................................3273
XmlNode Class................................................................................................................................. 3273
XmlNode Class Methods.................................................................................................................. 3274
AddAttribute............................................................................................................................... 3274
AddAttributeNS.......................................................................................................................... 3275
AddCDataSection........................................................................................................................3276
AddComment.............................................................................................................................. 3277
AddElement................................................................................................................................ 3278
AddElementNS........................................................................................................................... 3279
AddEntityReference....................................................................................................................3280
AddNode..................................................................................................................................... 3281
AddProcessInstruction................................................................................................................ 3282
AddText.......................................................................................................................................3283
CopyNode................................................................................................................................... 3284
FindNode.....................................................................................................................................3285
FindNodes................................................................................................................................... 3286

Copyright © 1988, 2024, Oracle and/or its affiliates. cxxiii

Contents

GenXmlString............................................................................................................................. 3288
GetAttributeName.......................................................................................................................3288
GetAttributeValue....................................................................................................................... 3289
GetCDataValue............................................................................................................................3289
GetCDataValues.......................................................................................................................... 3290
GetChildNode............................................................................................................................. 3291
GetElement..................................................................................................................................3292
GetElements................................................................................................................................ 3292
GetElementsByTagName............................................................................................................3293
GetElementsByTagNameNS.......................................................................................................3294
InsertCDataSection..................................................................................................................... 3295
InsertComment............................................................................................................................3297
InsertElement.............................................................................................................................. 3298
InsertElementNS......................................................................................................................... 3299
InsertEntityReference..................................................................................................................3300
InsertNode...................................................................................................................................3301
InsertProcessInstruction.............................................................................................................. 3303
InsertText.................................................................................................................................... 3304
RemoveAllChildNode.................................................................................................................3305
RemoveChildNode......................................................................................................................3306
XmlNode Class Properties................................................................................................................3307
AttributesCount...........................................................................................................................3307
ChildNodeCount......................................................................................................................... 3308
Index........................................................................................................................................... 3308
IsNull...........................................................................................................................................3308
LocalName.................................................................................................................................. 3309
NamespaceURI........................................................................................................................... 3309
NextSibling................................................................................................................................. 3309
NodeName.................................................................................................................................. 3309
NodePath.....................................................................................................................................3309
NodeType.................................................................................................................................... 3310
NodeValue...................................................................................................................................3310
ParentNode..................................................................................................................................3311
Prefix...........................................................................................................................................3311
PreviousSibling........................................................................................................................... 3311
Using the XmlDocFactory Class...................................................................................................... 3311
XmlDocFactory Class Methods........................................................................................................3312
GetNextXmlDoc......................................................................................................................... 3312
SetNamespaceString................................................................................................................... 3314
SetStringToParse.........................................................................................................................3315
Chapter 62: Quick Reference for PeopleCode Classes...................................................................... 3317
PeopleCode Syntax Quick Reference...............................................................................................3317
Desupported Items and PeopleCode No Longer Supported.............................................................3321
Desupported Products and Classes............................................................................................ 3322
Desupported Functions, Methods, and Properties......................................................................3323
Chart Items No Longer Supported.............................................................................................3328
Desupported BI Publisher Items................................................................................................ 3328
BI Publisher Items No Longer Supported................................................................................. 3329
Desupported Mobile Application Platform Items...................................................................... 3339
Desupported Messaging PeopleCode Functions, Methods and Properties................................ 3352
Functions No Longer Supported................................................................................................ 3356

cxxiv Copyright © 1988, 2024, Oracle and/or its affiliates.

 Contents

Desupported Built-in Functions from Prior to PeopleTools 8.0................................................ 3358

Mapping PeopleTools 8.1 Objects to New Objects................................................................... 3361

Copyright © 1988, 2024, Oracle and/or its affiliates. cxxv

Contents

cxxvi Copyright © 1988, 2024, Oracle and/or its affiliates.

Preface

Understanding the PeopleSoft Online Help and PeopleBooks

The PeopleSoft Online Help is a website that enables you to view all help content for PeopleSoft
applications and PeopleTools. The help provides standard navigation and full-text searching, as well as
context-sensitive online help for PeopleSoft users.

Hosted PeopleSoft Online Help

You can access the hosted PeopleSoft Online Help on the Oracle Help Center. The hosted PeopleSoft
Online Help is updated on a regular schedule, ensuring that you have access to the most current
documentation. This reduces the need to view separate documentation posts for application maintenance
on My Oracle Support. The hosted PeopleSoft Online Help is available in English only.

To configure the context-sensitive help for your PeopleSoft applications to use the Oracle Help Center,
see Configuring Context-Sensitive Help Using the Hosted Online Help Website.

Locally Installed PeopleSoft Online Help

If you’re setting up an on-premises PeopleSoft environment, and your organization has firewall
restrictions that prevent you from using the hosted PeopleSoft Online Help, you can install the online help
locally. Installable PeopleSoft Online Help is made available with selected PeopleSoft Update Images and
with PeopleTools releases for on-premises installations, through the Oracle Software Delivery Cloud.

Your installation documentation includes a chapter with instructions for how to install the online help
for your business environment, and the documentation zip file may contain a README.txt file with
additional installation instructions. See PeopleSoft 9.2 Application Installation for your database platform,
“Installing PeopleSoft Online Help.”

To configure the context-sensitive help for your PeopleSoft applications to use a locally installed online
help website, see Configuring Context-Sensitive Help Using a Locally Installed Online Help Website.

Downloadable PeopleBook PDF Files

You can access downloadable PDF versions of the help content in the traditional PeopleBook format on
the Oracle Help Center. The content in the PeopleBook PDFs is the same as the content in the PeopleSoft
Online Help, but it has a different structure and it does not include the interactive navigation features that
are available in the online help.

Common Help Documentation

Common help documentation contains information that applies to multiple applications. The two main
types of common help are:

• Application Fundamentals

Copyright © 1988, 2024, Oracle and/or its affiliates. cxxvii

Preface

• Using PeopleSoft Applications

Most product families provide a set of application fundamentals help topics that discuss essential
information about the setup and design of your system. This information applies to many or all
applications in the PeopleSoft product family. Whether you are implementing a single application, some
combination of applications within the product family, or the entire product family, you should be familiar
with the contents of the appropriate application fundamentals help. They provide the starting points for
fundamental implementation tasks.

In addition, the PeopleTools: Applications User's Guide introduces you to the various elements of the
PeopleSoft Pure Internet Architecture. It also explains how to use the navigational hierarchy, components,
and pages to perform basic functions as you navigate through the system. While your application or
implementation may differ, the topics in this user’s guide provide general information about using
PeopleSoft applications.

Field and Control Definitions

PeopleSoft documentation includes definitions for most fields and controls that appear on application
pages. These definitions describe how to use a field or control, where populated values come from, the
effects of selecting certain values, and so on. If a field or control is not defined, then it either requires
no additional explanation or is documented in a common elements section earlier in the documentation.
For example, the Date field rarely requires additional explanation and may not be defined in the
documentation for some pages.

Typographical Conventions
The following table describes the typographical conventions that are used in the online help.

Typographical Convention Description

Key+Key Indicates a key combination action. For example, a plus sign

(+) between keys means that you must hold down the first key
while you press the second key. For Alt+W, hold down the Alt
key while you press the W key.

. . . (ellipses) Indicate that the preceding item or series can be repeated any
number of times in PeopleCode syntax.

{ } (curly braces) Indicate a choice between two options in PeopleCode syntax.

Options are separated by a pipe ( | ).

[ ] (square brackets) Indicate optional items in PeopleCode syntax.

& (ampersand) When placed before a parameter in PeopleCode syntax,

an ampersand indicates that the parameter is an already
instantiated object.

Ampersands also precede all PeopleCode variables.

cxxviii Copyright © 1988, 2024, Oracle and/or its affiliates.

 Preface

Typographical Convention Description

⇒ This continuation character has been inserted at the end of a

line of code that has been wrapped at the page margin. The
code should be viewed or entered as a single, continuous line
of code without the continuation character.

ISO Country and Currency Codes

PeopleSoft Online Help topics use International Organization for Standardization (ISO) country and
currency codes to identify country-specific information and monetary amounts.

ISO country codes may appear as country identifiers, and ISO currency codes may appear as currency
identifiers in your PeopleSoft documentation. Reference to an ISO country code in your documentation
does not imply that your application includes every ISO country code. The following example is a
country-specific heading: "(FRA) Hiring an Employee."

The PeopleSoft Currency Code table (CURRENCY_CD_TBL) contains sample currency code data. The
Currency Code table is based on ISO Standard 4217, "Codes for the representation of currencies," and
also relies on ISO country codes in the Country table (COUNTRY_TBL). The navigation to the pages
where you maintain currency code and country information depends on which PeopleSoft applications
you are using. To access the pages for maintaining the Currency Code and Country tables, consult the
online help for your applications for more information.

Region and Industry Identifiers

Information that applies only to a specific region or industry is preceded by a standard identifier in
parentheses. This identifier typically appears at the beginning of a section heading, but it may also appear
at the beginning of a note or other text.

Example of a region-specific heading: "(Latin America) Setting Up Depreciation"

Region Identifiers
Regions are identified by the region name. The following region identifiers may appear in the PeopleSoft
Online Help:

• Asia Pacific

• Europe

• Latin America

• North America

Industry Identifiers
Industries are identified by the industry name or by an abbreviation for that industry. The following
industry identifiers may appear in the PeopleSoft Online Help:

• USF (U.S. Federal)

Copyright © 1988, 2024, Oracle and/or its affiliates. cxxix

Preface

• E&G (Education and Government)

Translations and Embedded Help

PeopleSoft 9.2 software applications include translated embedded help. With the 9.2 release, PeopleSoft
aligns with the other Oracle applications by focusing our translation efforts on embedded help. We
are not planning to translate our traditional online help and PeopleBooks documentation. Instead we
offer very direct translated help at crucial spots within our application through our embedded help
widgets. Additionally, we have a one-to-one mapping of application and help translations, meaning that
the software and embedded help translation footprint is identical—something we were never able to
accomplish in the past.

Using and Managing the PeopleSoft Online Help

Select About This Help in the left navigation panel on any page in the PeopleSoft Online Help to see
information on the following topics:

• Using the PeopleSoft Online Help.

• Managing hosted Online Help.

• Managing locally installed PeopleSoft Online Help.

PeopleTools Related Links

PeopleTools 8.61 Home Page

PeopleSoft Search and Insights Home Page

“PeopleTools Product/Feature PeopleBook Index” (Getting Started with PeopleTools)

PeopleSoft Online Help

PeopleSoft Information Portal

PeopleSoft Spotlight Series

PeopleSoft Training and Certification | Oracle University

My Oracle Support

Oracle Help Center

Contact Us
Send your suggestions to [email protected].

Please include the applications update image or PeopleTools release that you’re using.

cxxx Copyright © 1988, 2024, Oracle and/or its affiliates.

 Preface

Follow Us

Icon Link

Watch PeopleSoft on YouTube

Follow @PeopleSoft_Info on X.

Read PeopleSoft Blogs

Connect with PeopleSoft on LinkedIn

Copyright © 1988, 2024, Oracle and/or its affiliates. cxxxi

Chapter 1

Activity Guide Classes

Understanding the Activity Guide Classes

Activity guides are a PeopleTools feature that allow you to define guided procedures for a user or group
of users to complete. Users are presented with a list of actions, or tasks, that need to be completed
to finish the procedure. The activity guide classes documented in these topics provide you with a
programmatic interface to manage and manipulate activity guide templates, activity guide instances,
action items, participants, and so on. In addition, some of these activity guide classes can be used to
customize and extend your implementation of activity guides.

Related Links
“Understanding Activity Guides” (Portal Technology)
“Enhancing Activity Guides” (Portal Technology)

Importing Activity Guide Classes

The activity guide classes are application classes, not built-in classes, like Rowset, Field, Record, and
so on. Before you can use these classes in your PeopleCode program, you must import them into your
program.

An import statement either names a particular application class or imports all the classes in a package.

Using the asterisks after the package name makes all the application classes directly contained in the
named package available. Application classes contained in subpackages of the named package are not
made available.

Activity Guide Classes Reference

This reference section documents the following classes from the PTAI_ACTION_ITEMS application
package:

• List class

• ActionItem class

• Member class

• ContextData class

Copyright © 1988, 2024, Oracle and/or its affiliates. 133

Activity Guide Classes Chapter 1

List Class
This section provides an overview of the List class and discusses:

• List class methods.

• List class properties.

The List class is used to manage an activity guide template or an activity guide instance.

Typically, activity guides are defined by the properties and characteristics of activity guide templates.
An activity guide template provides a reusable definition of the important aspects of an activity guide: its
properties, participants, contextual data, list of action items and to whom they are assigned, and so on.
Then, at run time, an activity guide instance can be created from the definitions stored in the template.
The instance will be generated with the contextual data that uniquely differentiates one instance from
another. For example, for a benefits enrollment activity guide, the contextual data would likely include the
employee ID, the country and locale (state, province, and so on) where the employee works, and any other
key data required to initiate the benefits process.

Related Links
“Activity Guide Templates and Instances” (Portal Technology)
“Creating and Maintaining Activity Guide Templates” (Portal Technology)
“Managing Activity Guide Instances” (Portal Technology)

List Class Methods

In this section, the List class methods are presented in alphabetical order.

createInstance

Syntax
createInstance(instance_ID, title, &context_data)

Description
Use this method to create an activity guide instance by cloning the current activity guide template
including its action items, participants, and so on.

Parameters

Parameter Description

instance_ID Specifies the ID for the activity guide instance as a string.

134 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Parameter Description

title Specifies the title for the activity guide instance as a string.

Note: The title is also referred to as the Label property.

&context_data Specifies the contextual data for the activity guide instance as
a PTAI_COLLECTION:Collection object.

Returns
A List object.

Example
This is a code example of the CreateInstance method:
method CreateInstFromCtxtData
/+ &oCtxt as PTAI_COLLECTION:Collection +/
/+ Returns String +/
Local PTAI_ACTION_ITEMS:ContextData &ctxData;
Local PTAI_ACTION_ITEMS:List &newList = create PTAI_ACTION_ITEMS:List();
Local PTAI_COLLECTION:Collection &ctxDataColl = create PTAI_COLLECTION:Collectio⇒

n();
Local integer &i, &nbr;
Local string &label, &descr, &InstanceId;
try
For &i = 1 To &oCtxt.Count
&ctxData = (&oCtxt.Item(&i) As PTAI_ACTION_ITEMS:ContextData);
If &ctxData.ctxKey And
&ctxData.keyValue = "" Then
Return "";
End-If;
&ctxDataColl.InsertItem(&ctxData);
End-For;

&newList.open(&Template_Id);
SQLExec(SQL.PTAI_GET_INSTANCES, &newList.ListId, &nbr);
&nbr = &nbr + 1;
&label = &newList.Label | "-" | &nbr;
&InstanceId = &newList.createInstance(&label, &newList.DescrLong, &ctxDataCol⇒

l).ListId;
Return &InstanceId;
catch Exception &e
Return "";
end-try;

end-method;

Related Links
Label
ListId
ContextData Class

Copyright © 1988, 2024, Oracle and/or its affiliates. 135

Activity Guide Classes Chapter 1

getActionItems

Syntax
getActionItems()

Description
Use this method to return an array of all action item IDs for the current activity guide. This method
returns IDs for both summary and detail action items.

Parameters
None.

Returns
An array of string.

Related Links
getRootItems
ActionItem Class

GetContext

Syntax
GetContext()

Description
Use this method to get the contextual data for the current activity guide.

Parameters
None.

Returns
A PTAI_COLLECTION:Collection object.

Related Links
ContextData Class

136 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

getMembers

Syntax
getMembers()

Description
Use this method to return a PTAI_COLLECTION:Collection object representing participants for the
current activity guide.

Parameters
None.

Returns
A PTAI_COLLECTION:Collection object.

Related Links
Member Class

GetPgltBtn

Syntax
GetPgltBtn()

Description
Use this method to return a PTAI_COLLECTION:Collection representing the definitions for custom
navigation frame buttons for the current activity guide.

Parameters
None.

Returns
A PTAI_COLLECTION:Collection object.

getRootItems

Syntax
getRootItems()

Copyright © 1988, 2024, Oracle and/or its affiliates. 137

Activity Guide Classes Chapter 1

Description
Use this method to return an array of action item IDs for summary action items for the current activity
guide.

Note: This method does not return IDs for detail action items.

Parameters
None.

Returns
An array of string.

Related Links
getActionItems
ActionItem Class

new

Syntax
new(ID, portal, title)

Description
Use this method to generate a new activity guide.

Parameters

Parameter Description

ID Specifies the ID for the new activity guide as a string.

portal Specifies a portal for the activity guide as a string.

title Specifies the title for the activity guide as a string.

Note: The title is also referred to as the Label property.

Returns
None.

138 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Related Links
Label
ListId

open

Syntax
open(ID)

Description
Use this method to retrieve an activity guide definition from the database and sets all the properties.

Parameters

Parameter Description

ID Specifies the activity guide ID as a string.

Returns
None.

Related Links
ListId

save

Syntax
save()

Description
Use this method to save the current activity guide definition to the database. If this is a new activity
guide, then the definition is inserted into the database; otherwise, an existing definition is updated in the
database.

Parameters
None.

Returns
A Boolean value: True if the save is successful, False otherwise.

Copyright © 1988, 2024, Oracle and/or its affiliates. 139

Activity Guide Classes Chapter 1

SaveContext

Syntax
SaveContext(&context_data)

Description
Use this method to save the contextual data for the current activity guide to the database. Any existing
contextual data for this activity guide definition is deleted from the database first.

Parameters

Parameter Description

&context_data Specifies the contextual data for the activity guide as a PTAI_
COLLECTION:Collection object.

Returns
None.

Related Links
ContextData Class

saveMembers

Syntax
saveMembers(&members)

Description
Use this method to save the participants (members) for the current activity guide to the database. Any
existing participants for this activity guide definition are deleted from the database first.

Parameters

Parameter Description

&members Specifies the participants for the activity guide as a PTAI_

COLLECTION:Collection object.

Returns
None.

140 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Related Links
Member Class

SavePgltBtn

Syntax
SavePgltBtn(&pgltBtns)

Description
Use this method to save the definitions for the custom navigation frame buttons for the current activity
guide to the database. Any existing custom button definitions for this activity guide are deleted from the
database first.

Parameters

Parameter Description

&pgltBtns Specifies the custom navigation frame buttons for the activity
guide as a PTAI_COLLECTION:Collection object.

Returns
A PTAI_COLLECTION:Collection object.

List Class Properties

In this section, the List class properties are presented in alphabetical order.

AppClassID

Description
Use this property to set or return a string value representing the name of the application class that contains
the method to be invoked at activity guide instance creation.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath,
AppClassID, and AppClassMethod

This property is read/write.

Related Links
AppClassMethod
PackageRoot

Copyright © 1988, 2024, Oracle and/or its affiliates. 141

Activity Guide Classes Chapter 1

QualifyPath
“Defining Advanced Options” (Portal Technology)
“Initializing an Activity Guide Instance” (Portal Technology)

AppClassMethod

Description
Use this property to set or return a string value representing the name of the method to be invoked at
activity guide instance creation.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath,
AppClassID, and AppClassMethod

This property is read/write.

Related Links
AppClassID
PackageRoot
QualifyPath
“Defining Advanced Options” (Portal Technology)
“Initializing an Activity Guide Instance” (Portal Technology)

DescrLong

Description
Use this property to set or return the description for the activity guide as a string value.

This property is read/write.

Related Links
“Defining Activity Guide Template Properties” (Portal Technology)

Field1

Description
Use this property to set or return a string value representing the label for the first configurable text field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

142 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Field10

Description
Use this property to set or return a string value representing the label for the fifth configurable yes/no
field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

Field2

Description
Use this property to set or return a string value representing the label for the second configurable text
field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

Field3

Description
Use this property to set or return a string value representing the label for the third configurable text field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

Field4

Description
Use this property to set or return a string value representing the label for the fourth configurable text field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

Copyright © 1988, 2024, Oracle and/or its affiliates. 143

Activity Guide Classes Chapter 1

Field5

Description
Use this property to set or return a string value representing the label for the fifth configurable text field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

Field6

Description
Use this property to set or return a string value representing the label for the first configurable yes/no
field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

Field7

Description
Use this property to set or return a string value representing the label for the second configurable yes/no
field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

Field8

Description
Use this property to set or return a string value representing the label for the third configurable yes/no
field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

144 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Field9

Description
Use this property to set or return a string value representing the label for the fourth configurable yes/no
field.

This property is read/write.

Related Links
“Defining Advanced Options” (Portal Technology)

HomeUrl

Description
Use this property to set or return a string value representing the URL for the WorkCenter page (or starting
page) that incorporates this activity guide. This URL provides access from the Activity Guides - In
Progress homepage pagelet to the WorkCenter page.

This property is read/write.

Related Links
“Defining Activity Guide Template Properties” (Portal Technology)
“Accessing Instances from the Activity Guides - In Progress Pagelet” (Portal Technology)

isActive

Description
Use this property to set or return a Boolean value indicating whether the activity guide is active.

This property is read/write.

Related Links
“Defining Activity Guide Template Properties” (Portal Technology)

IsTemplate

Description
Use this property to set or return a Boolean value indicating whether the activity guide is a template.
When this property is False, the List object is an activity guide instance.

This property is read/write.

Copyright © 1988, 2024, Oracle and/or its affiliates. 145

Activity Guide Classes Chapter 1

Related Links
“Defining Activity Guide Template Properties” (Portal Technology)

Label

Description
Use this property to set or return a string representing the descriptive name (or title) of the activity guide.

This property is read/write.

Related Links
“Defining Activity Guide Template Properties” (Portal Technology)

ListId

Description
Use this property to return a string representing the ID for this activity guide.

This property is read-only.

Related Links
“Defining Activity Guide Template Properties” (Portal Technology)

PackageRoot

Description
Use this property to set or return a string value representing the name of the application package that
contains the method to be invoked at activity guide instance creation.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath,
AppClassID, and AppClassMethod

This property is read/write.

Related Links
AppClassID
AppClassMethod
QualifyPath
“Defining Advanced Options” (Portal Technology)
“Initializing an Activity Guide Instance” (Portal Technology)

146 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

ParentTemplate

Description
Use this property to set or return a string representing the ID of the template used to generate the activity
guide instance. If the List object represents an activity guide template, then this property will be Null.

Related Links
“Creating New Activity Guide Instances Manually” (Portal Technology)

pgltAppClass

Description
Use this property to set or return a string representing the name of the application class that contains the
method (or methods) to be invoked to create custom navigation frame buttons.

Note: The full path to the method is constructed from three properties: pgltPackageRoot, pgltQualifyPath,
and pgltAppClass.

This property is read/write.

Related Links
GetPgltBtn
SavePgltBtn
pgltPackageRoot
pgltQualifyPath
“Defining Navigation and Pagelet Options” (Portal Technology)

pgltPackageRoot

Description
Use this property to set or return a string representing the name of the application package that contains
the method (or methods) to be invoked to create custom navigation frame buttons.

Note: The full path to the method is constructed from three properties: pgltPackageRoot, pgltQualifyPath,
and pgltAppClass.

This property is read/write.

Related Links
GetPgltBtn
SavePgltBtn
pgltAppClass
pgltQualifyPath

Copyright © 1988, 2024, Oracle and/or its affiliates. 147

Activity Guide Classes Chapter 1

“Defining Navigation and Pagelet Options” (Portal Technology)

pgltProgressBarVisible

Description
Use this property to set or return a Boolean value indicating whether the progress bar will be displayed in
the activity guide pagelet on the WorkCenter page.

This property is read/write.

Related Links
“Defining Navigation and Pagelet Options” (Portal Technology)

pgltQualifyPath

Description
Use this property to set or return a string representing the names of each subpackage in the application
class hierarchy that define the location of the application class. Separate subpackage names by a colon. If
the class is defined in the top-level application package, use a colon only.

Note: The full path to the method is constructed from three properties: pgltPackageRoot, pgltQualifyPath,
and pgltAppClass.

This property is read/write.

Related Links
GetPgltBtn
SavePgltBtn
pgltAppClass
pgltPackageRoot
“Defining Navigation and Pagelet Options” (Portal Technology)

QualifyPath

Description
Use this property to set or return a string value representing the names of each subpackage in the
application class hierarchy that define the location of the application class. Separate subpackage names by
a colon. If the class is defined in the top-level application package, use a colon only.

Note: The full path to the method is constructed from four properties: PackageRoot, QualifyPath,
AppClassID, and AppClassMethod

This property is read/write.

148 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Related Links
AppClassID
AppClassMethod
PackageRoot
“Defining Advanced Options” (Portal Technology)
“Initializing an Activity Guide Instance” (Portal Technology)

Status

Description
Use this property to set or return the status of the instance, which determines whether the activity guide is
displayed in the Activity Guides - In Progress pagelet. The valid values are:

Value Description

CA Cancelled

CP Complete

IP In progress

This property is read/write.

Example
In the following example, the method sets the activity guide status to complete:
method CompleteStatus
/+ &list_id as String +/

Local PTAI_ACTION_ITEMS:List &ObjList;

&ObjList = create PTAI_ACTION_ITEMS:List();

&ObjList.open(&list_id);

Rem set the status of the template to Complete;

&ObjList.Status = "CP";
&return = &ObjList.save();

end-method;

ActionItem Class
This section provides an overview of the ActionItem class and discusses:

• ActionItem class methods.

Copyright © 1988, 2024, Oracle and/or its affiliates. 149

Activity Guide Classes Chapter 1

• ActionItem class properties.

The ActionItem class is used to manage action items.

Action items are the tasks that are assigned for completion within an activity guide. As an application
developer, you will refer to these as action items. To users, they are presented as tasks or steps.

Action items can be created and maintained within activity guide templates or within activity guide
instances. However, typically you will define action items and their details at the template level only.
Once an activity guide instance is created, updates to the action items themselves occur programmatically
or through actions of the user.

Related Links
“Creating and Maintaining Action Items” (Portal Technology)

ActionItem Class Methods

In this section, the ActionItem class methods are presented in alphabetical order.

delete

Syntax
delete()

Description
Use this method to delete the current action item.

Parameters
None.

Returns
A Boolean value: True if the deletion was successful, False otherwise.

getAssignments

Syntax
getAssignments()

Description
Use the getAssignments method to obtain the action item assignments (user/role) as a collection object.

150 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Note: While you can specify any user ID or role, only a user or role that has also been assigned
Contributor privileges on the template or instance Security page will be allowed to complete the action
item. The system will not validate your selection against the users or roles defined on the Security page.

Parameters
None.

Returns
A PTAI_COLLECTION:Collection object containing user or role assignments data for the action item.

Example
import PTAI_ACTION_ITEMS:ActionItem;
import PTAI_COLLECTION:Collection;

Local PTAI_ACTION_ITEMS:ActionItem &item;

Local PTAI_COLLECTION:Collection &oAssignmentColl = create PTAI_COLLECTION:Collecti⇒

on();

&item = create PTAI_ACTION_ITEMS:ActionItem();

/*Pass an action item id*/
&item.open(&item_id);
&oAssignmentColl = &item.getAssignments();

Related Links
saveAssignments

new

Syntax
new(item_ID, title, list_ID)

Description
Use this method to create and initialize a new action item.

Parameters

Parameter Description

item_ID Specifies the ID for the new action item as a string.

title Specifies the title for the new action item as a string.

Note: The title is also referred to as the Label property.

Copyright © 1988, 2024, Oracle and/or its affiliates. 151

Activity Guide Classes Chapter 1

Parameter Description

list_ID Specifies the activity guide to which the action item belongs as
a string.

Returns
None.

Related Links
ItemId
Label
ListId

nextAction

Syntax
nextAction()

Description
Use this method to return the next detail action item in the activity guide that is assigned and is not
cancelled or on hold.

Parameters
None.

Returns
An ActionItem object.

open

Syntax
open(item_ID)

Description
Use this method to retrieve the specified action item definition from the database and set the properties.

152 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Parameters

Parameter Description

item_ID Specifies the action item ID as a string.

Returns
None.

Related Links
ItemId

prevAction

Syntax
prevAction()

Description
Use this method to return the previous detail action item in the activity guide that is assigned and is not
cancelled or on hold.

Parameters
None.

Returns
An ActionItem object.

save

Syntax
save()

Description
Use this method to save the current action item definition to the database. If this is a new activity guide,
then the definition is inserted into the database; otherwise, an existing definition is updated in the
database.

Parameters
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 153

Activity Guide Classes Chapter 1

Returns
A Boolean value: True if the save is successful, False otherwise.

saveAssignments

Syntax
saveAssignments(&AssignmentColl)

Description
Use the saveAssignments method to save or update action item assignments. If you are adding new
user assignments to an action item, use the getAssignments method to get the existing assignments as a
collection object, insert new assignments to the returned collection object, and call the saveAssignments
method with the updated collection object as input.

Note: While you can specify any user ID or role, only a user or role that has also been assigned
Contributor privileges on the template or instance Security page will be allowed to complete the action
item. The system will not validate your selection against the users or roles defined on the Security page.

Parameters

Parameter Description

&AssignmentColl Specifies the user or role assignment data for the action item as
a PTAI_COLLECTION:Collection object.

Returns
None.

Example
import PTAI_ACTION_ITEMS:ActionItem;
import PTAI_COLLECTION:Collection;
import PTAI_ACTION_ITEMS:ActionItemAssignments;
import PTAI_COLLECTION:Collectable;

Local PTAI_ACTION_ITEMS:ActionItem &item;

Local PTAI_COLLECTION:Collection &oAssignmentColl = create PTAI_COLLECTION:Collecti⇒

on();
Local PTAI_ACTION_ITEMS:ActionItemAssignments &oAssignment = create PTAI_ACTION_ITE⇒

MS:ActionItemAssignments();
&oAssignment.AssignType = "USER";
&oAssignment.AssignValue = %OperatorId;

&oAssignmentColl.InsertItem(&oAssignment As PTAI_COLLECTION:Collectable);

&item = create PTAI_ACTION_ITEMS:ActionItem();

/*Pass an action item id*/
&item.open(&item_id);

154 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

&item.saveAssignments(&oAssignmentColl);

Related Links
getAssignments

ActionItem Class Properties

In this section, the ActionItem class properties are presented in alphabetical order.

AppClassID

Description
Use this property to set or return a string value representing the name of the application class that contains
the ItemPostProcess method to be invoked for post-processing of this action item.

Note: The full path to the ItemPostProcess method is constructed from three properties: PackageRoot,
QualifyPath, and AppClassID

This property is read/write.

Related Links
PackageRoot
QualifyPath
“Configuring Related Data” (Portal Technology)
“Performing Pre-Processing for Action Items” (Portal Technology)

AssignedToOprid

Description
The AssignedToOprid property is desupported in PeopleTools 8.58 and will be ignored.

Related Links
“Defining Action Item Details” (Portal Technology)
“Defining Activity Guide Template Security” (Portal Technology)

AssignType

Description
The AssignType property is desupported in PeopleTools 8.58 and will be ignored.

Copyright © 1988, 2024, Oracle and/or its affiliates. 155

Activity Guide Classes Chapter 1

Related Links
“Defining Action Item Details” (Portal Technology)
“Defining Activity Guide Template Security” (Portal Technology)

CurrentStep

Description
Use this property to set or return a Boolean value indicating whether the current step is the active step
currently being worked in the activity guide.

This property is read/write.

DescrLong

Description
Use this property to set or return the description for the action item as a string value.

This property is read/write.

Related Links
“Defining Action Item Details” (Portal Technology)

DueDate

Description
Use this property to set or return a Date value representing the date portion of the due date and time.

This property is read/write.

Related Links
DueTm
“Defining Action Item Details” (Portal Technology)

DueTm

Description
Use this property to set or return a Time value representing the time portion of the due date and time.

This property is read/write.

Related Links
DueDate

156 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

“Defining Action Item Details” (Portal Technology)

EndDttm

Description
Use the EndDttm property to set the completion of a step or instance in a guided process as a DateTime
value.

Note: You can use the EndDttm property only within the context of reporting the duration of step or
instance for analytics.

This property is read/write.

Field1

Description
Use this property to set or return a string value representing the application data for the first configurable
text field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Field10

Description
Use this property to set or return a string value representing the application data for the fifth configurable
yes/no field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Field2

Description
Use this property to set or return a string value representing the application data for the second
configurable text field to be used in execution of the transaction.

This property is read/write.

Copyright © 1988, 2024, Oracle and/or its affiliates. 157

Activity Guide Classes Chapter 1

Related Links
“Configuring Related Data” (Portal Technology)

Field3

Description
Use this property to set or return a string value representing the application data for the third configurable
text field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Field4

Description
Use this property to set or return a string value representing the application data for the fourth
configurable text field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Field5

Description
Use this property to set or return a string value representing the application data for the fifth configurable
text field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Field6

Description
Use this property to set or return a string value representing the application data for the first configurable
yes/no field to be used in execution of the transaction.

This property is read/write.

158 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Related Links
“Configuring Related Data” (Portal Technology)

Field7

Description
Use this property to set or return a string value representing the application data for the second
configurable yes/no field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Field8

Description
Use this property to set or return a string value representing the application data for the third configurable
yes/no field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Field9

Description
Use this property to set or return a string value representing the application data for the fourth
configurable yes/no field to be used in execution of the transaction.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

ItemId

Description
Use this property to return a string representing the ID for this action item.

This property is read-only.

Copyright © 1988, 2024, Oracle and/or its affiliates. 159

Activity Guide Classes Chapter 1

Related Links
“Defining Action Item Details” (Portal Technology)

Label

Description
Use this property to set or return a string representing the descriptive name (or title) of the action item.

This property is read/write.

Related Links
“Defining Action Item Details” (Portal Technology)

ListId

Description
Use this property to set or return a string value representing the ID for the activity guide containing the
current action item.

This property is read/write.

Related Links
ListId

PackageRoot

Description
Use this property to set or return a string value representing the name of the application package that
contains the ItemPostProcess method to be invoked for post-processing of this action item.

Note: The full path to the ItemPostProcess method is constructed from three properties: PackageRoot,
QualifyPath, and AppClassID

This property is read/write.

Related Links
AppClassID
QualifyPath
“Configuring Related Data” (Portal Technology)
“Performing Pre-Processing for Action Items” (Portal Technology)

160 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

ParentId

Description
Use this property to set or return the ID of the summary (or parent) action item. If there is no parent action
item, the value returned is ROOT.

This property is read/write.

PercCompl

Description
Use this property to set or return a Number value indicating the percentage completion for this action
item.

This property is read/write.

Related Links
“Defining Action Item Details” (Portal Technology)

Priority

Description
Use this property to set or return a string value representing the priority for this action item. The valid
values are:

Value Description

1 Low

2 Medium

3 High

This property is read/write.

QualifyPath

Description
Use this property to set or return a string value representing the names of each subpackage in the
application class hierarchy that define the location of the application class. Separate subpackage names by
a colon. If the class is defined in the top-level application package, use a colon only.

Copyright © 1988, 2024, Oracle and/or its affiliates. 161

Activity Guide Classes Chapter 1

Note: The full path to the ItemPostProcess method is constructed from three properties: PackageRoot,
QualifyPath, and AppClassID

This property is read/write.

Related Links
AppClassID
PackageRoot
“Configuring Related Data” (Portal Technology)
“Performing Pre-Processing for Action Items” (Portal Technology)

Remarks

Description
Use this property to set or return the progress remarks for this action item.

This property is read/write.

Related Links
“Configuring Related Data” (Portal Technology)

Required

Description
Use this property to set or return a Boolean value indicating whether the action item is required.

This property is read/write.

Related Links
“Defining Action Item Details” (Portal Technology)

Sequence

Description
Use this property to set or return a Number value representing the sequence number for the action item.

This property is read/write.

Related Links
“Understanding Creation and Maintenance of Action Items” (Portal Technology)
“Defining Action Item Details” (Portal Technology)

162 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

ServiceId

Description
Use this property to set or return a string value representing the ID for the related content service that will
be executed when the user clicks this action item in the activity guide pagelet.

This property is read/write.

Related Links
Type
“Defining Action Item Details” (Portal Technology)

StartDt

Description
Use this property to set or return a Date value representing the date portion of the start date and time.

This property is read/write.

Related Links
StartTm
“Defining Action Item Details” (Portal Technology)

StartTm

Description
Use this property to set or return a Time value representing the time portion of the start date and time.

This property is read/write.

Related Links
StartDt
“Defining Action Item Details” (Portal Technology)

Status

Description
Use this property to set or return a string value representing the status of the current action item. Valid
values are:

Copyright © 1988, 2024, Oracle and/or its affiliates. 163

Activity Guide Classes Chapter 1

Value Description

0 Not assigned

1 Assigned

2 In progress

3 On hold

4 Completed

5 Cancelled

This property is read/write.

Related Links
“Defining Action Item Details” (Portal Technology)

Summary

Description
Use this property to set or return a Boolean value indicating whether the action item is a summary action
item. When this property is False, the action item is a detail action item.

This property is read/write.

Related Links
“Defining Action Item Details” (Portal Technology)

Type

Description
Use this property to set or return a string value representing the type of the related content service that
will be executed when the user clicks this action item in the activity guide pagelet. The valid values are:

Value Description

A Application class URL

C PeopleSoft component

164 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Value Description

N Non-PeopleSoft URL

Q PeopleSoft query

S PeopleSoft script

This property is read/write.

Related Links
ServiceId
“Defining Action Item Details” (Portal Technology)

ActionItemAssignments Class
This section provides an overview of the ActionItemAssignments class and discusses:

• ActionItemAssignments class methods.

• ActionItemAssignments class properties.

The ActionItemAssignments class is used to manage action item user/role assignments data for action
items in an activity guide template and instance. You can use the ActionItemAssignments class properties
to create action item assignment object and add/update the action item user or role assignment data.

If you are adding new user assignments to an action item, use the getAssignments method to get the
existing assignments as a collection object, insert new assignments to the returned collection object, and
call the saveAssignments method with the updated collection object as input.

ActionItemAssignments Class Methods

In this section, the ActionItemAssignments class method is presented:

IsEqual

Syntax
IsEqual(&object)

Description
Use this method to evaluate the equivalency of an object with the current ActionItemAssignments object.
Equivalency is established based on the value of two properties: &AssignType and &AssignValue.

Copyright © 1988, 2024, Oracle and/or its affiliates. 165

Activity Guide Classes Chapter 1

Parameters

Parameter Description

&object Specifies the object to be compared as a PTAI_

COLLECTION:Collectable object.

Returns
A Boolean value: True if the objects are equivalent, False otherwise.

ActionItemAssignments Class Properties

In this section, the ActionItemAssignments class properties are presented in alphabetic order

AssignType

Description
Use the AssignType property to set or return the assignment as a String. The value can be either USER or
ROLE.

This property is read/write.

AssignValue

Description
Use the AssignValue property to set or return the user or role assignment value as a String.

This property is read/write.

Member Class
This section provides an overview of the Member class and discusses:

• Member class methods.

• Member class properties.

The Member class is used to manage activity guide participants.

Related Links
“Defining Activity Guide Template Security” (Portal Technology)

166 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Member Class Methods

In this section, the Member class methods are presented in alphabetical order.

IsEqual

Syntax
IsEqual(&object)

Description
Use this method to evaluate the equivalency of an object with the current member. Equivalency is
established based on the value of two properties: the object's Name and the Type.

Parameters

Parameter Description

&object Specifies the object to be compared as a PTAI_

COLLECTION:Collectable object.

Returns
A Boolean value: True if the objects are equivalent, False otherwise.

Related Links
Name
Type

Member

Syntax
Member(name, type)

Description
Use this constructor method to initialize a Member object with the specified name and type.

Copyright © 1988, 2024, Oracle and/or its affiliates. 167

Activity Guide Classes Chapter 1

Parameters

Parameter Description

name Specifies the participant’s name as a string value.

type Specifies the participant type (role or user) as a string value.

Returns
None.

Member Class Properties

In this section, the Member class properties are presented in alphabetical order.

Name

Description
Use this property to return the participant’s name as a string value.

This property is read-only.

PrivilegeSetID

Description
Use this property to set or return the privilege level assigned to this participant as a string value.

This property is read/write.

Example
Set or return a value for the PrivilegeSetID property using the Constants class:

Constant Value Description

&PTAI_CONSTANTS.PRIVSET_ADMIN Administrator

&PTAI_CONSTANTS.PRIVSET_CONTRIBUTOR Contributor

&PTAI_CONSTANTS.PRIVSET_VIEWER Viewer

168 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

For example:
import PTAI_ACTION_ITEMS:*;

Local PTAI_ACTION_ITEMS:Constants &PTAI_CONSTANTS;

Local PTAI_ACTION_ITEMS:Member &member;

&PTAI_CONSTANTS = create PTAI_ACTION_ITEMS:Constants();

&member = create PTAI_ACTION_ITEMS:Member(&name, &type);

&member.PrivilegeSetID = &PTAI_CONSTANTS.PRIVSET_ADMIN;

Type

Description
Use this property to return the participant type (user or role) as a string value.

This property is read-only.

ContextData Class
This section provides an overview of the ContextData class and discusses:

• ContextData class methods.

• ContextData class properties.

The ContextData class is used to manage contextual data for activity guide templates and instances.

You can define contextual data that will be passed to the activity guide instance when it is created.
Contextual data defined as key fields will be used to uniquely identify each activity guide instance. For
example, if the employee ID were defined as a key contextual field, then each activity guide instance
will be created for a specific employee ID. Contextual data defined as non-key fields is not used to
differentiate an instance, but can be passed to the instance nevertheless. For example, non-key data can be
displayed in the activity guide pagelet by specifying the Context Visible option for the field. In this way,
instead of displaying the employee ID, you could display the employee name in the pagelet.

Related Links
“Defining Advanced Options” (Portal Technology)

ContextData Class Methods

In this section, the ContextData class methods are presented in alphabetical order.

Copyright © 1988, 2024, Oracle and/or its affiliates. 169

Activity Guide Classes Chapter 1

ContextData

Syntax
ContextData(rec_name, field_name, label, value, isKey, isVisible)

Description
Use this constructor method to initialize one row of contextual data for an activity guide.

Parameters

Parameter Description

rec_name Specifies the record name that is the source for the contextual
field as a string value.

field_name Specifies the name of the source contextual field as a string

value.

label Specifies an optional label for the contextual field as a string

value. This label can be displayed along with the data value in
the activity guide pagelet on the WorkCenter page.

value Specifies the contextual data value as a string.

isKey Specifies a Boolean value indicating whether the contextual

field is a key field.

isVisible Specifies a Boolean value indicating whether to display the

contextual data and labels in the activity guide pagelet on the
WorkCenter page.

Returns
None.

IsEqual

Syntax
IsEqual(&object)

170 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 1 Activity Guide Classes

Description
Use this method to evaluate the equivalency of an object with the current ContextData object.
Equivalency is established based on the value of five properties: recname, fieldname, keyLabel, keyValue,
and ctxKey.

Parameters

Parameter Description

&object Specifies the object to be compared as a PTAI_

COLLECTION:Collectable object.

Returns
A Boolean value: True if the objects are equivalent, False otherwise.

ContextData Class Properties

In this section, the ContextData class properties are presented in alphabetical order.

ctxKey

Description
Use this property to set or return a Boolean value indicating whether the contextual field is a key field.

This property is read/write.

ctxVisible

Description
Use this property to set or return a Boolean value indicating whether to display the contextual data and
labels in the activity guide pagelet on the WorkCenter page.

This property is read/write.

fieldname

Description
Use this property to set or return the name of the source contextual field as a string value.

This property is read/write.

Copyright © 1988, 2024, Oracle and/or its affiliates. 171

Activity Guide Classes Chapter 1

keyLabel

Description
Use this property to set or return an optional label for the contextual field as a string value. This label can
be displayed along with the data value in the activity guide pagelet on the WorkCenter page.

This property is read/write.

keyValue

Description
Use this property to set or return the contextual data value as a string.

This property is read/write.

recname

Description
Use this property to set or return the record name that is the source for the contextual field as a string
value.

This property is read/write.

172 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 2

AESection Class

Understanding the AESection Class

Before PeopleTools 8, users could perform SQL directly on the Application Engine tables, thereby
changing their SQL and Application Engine "flow" in a dynamic manner, prior to running their
applications. Some applications, for example, let the user input their "rules" in a user-friendly application,
then convert these rules, at save time, into Application Engine constructs.

With PeopleTools 8, Application Engine programs should not perform SQL directly on the Application
Engine tables, as they are system tables, and are cached. SQL on the Application Engine tables may not
be accurately reflected when the applications are executed, because of the caching mechanism.

To overcome this problem, developers have two basic operations that let them modify their Application
Engine programs from their online pages:

• Ability to modify SQL definitions, which are referenced within Application Engine SQL using the
PeopleCode SQL class and the meta-SQL function %SQL.

• Ability to dynamically change the execution flow of a given Application Engine section.

Use the AESection class to do the latter. This section object is used to modify the steps and SQL
associated with a given section by using PeopleCode.

Before describing the specifics of the AESection class, the following are some general terms to
understand:

• base section

The base section represents the Application Engine section you are working on. This is the section
that you are changing in PeopleCode. In other words, it’s the target section.

• template section

The template section represents the Application Engine section that is the source, or "model" for the
section you're building. You copy from the template section to the base section.

The template must exist in the database before you can use it.

If the base section you specify doesn’t exist, a new base section is created. This enables you to
dynamically create sections as needed.

You can copy steps (and their attributes) from the template to the base. The only attribute of the step you
can modify is the SQL statement that gets executed.

Warning! When you open or get an AESection object, (that is, the base section) any existing steps in the
section are deleted. You must add a new step to the section before you can modify it.

Copyright © 1988, 2024, Oracle and/or its affiliates. 173

AESection Class Chapter 2

The main assumption for this class is that your rules are dynamic primarily in the SQL that they execute,
but that the structure of the rules are static, or at least defined well enough that a standard template can be
applied.

Note that you can't update the Application Engine actions that are not SQL-related (that is, PeopleCode,
Call Section, or Log Message). In other words, you can’t change the PeopleCode associated with a
PeopleCode action within a step. You can add a step containing a PeopleCode action to your new section,
but you can't change the PeopleCode dynamically.

Related Links
Understanding SQL Class
“%SQL” (PeopleCode Language Reference)
“Adding Steps” (Application Engine)

How an AESection is Accessed

When an AESection is opened (or accessed), the system first checks if it exists with the given input
parameters.

If the base section you specify doesn’t exist, a new base section is created. This enables you to
dynamically create sections as needed. In addition, if the target section doesn't exist, all section-level
attributes are copied from the template to the target section. If the target exists, it retains its attribute
settings.

If an effective date is specified (with EffDt), but there is no match using that effective date, the AESection
is opened using the base effective date of ‘1900-01-01’.

The market defined for the current component is used for the section to be open. If no section with this
market exists, the default GBL is used.

If you open an AESection object from within a running Application Engine program, the market value is
set to the value of the current process.

The database platform you’re currently running is used as the database platform for the section to be
opened. If no section with this database platform exists, the default "none" is used.

To find the correct section to open, the precedence is:

1. Market

2. Database platform

3. Effective date

When a section is closed and its changes are saved, the market and database platform from the system that
performed the changes is used as the market and database platform for the modified section.

Let’s take an example. Assume that you’re running on DB2 for OS/390 and z/OS, and your current
market is set to ‘MKT’. Assume that you want to open a section called Sect1 in an Application Engine
program called TestAppl, and that your data looks something like this:

174 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 2 AESection Class

Number Application Application Market Platform Effective Date

Engine Program Engine Section

1 TestAppl Sect1 USA DB2 1990-01-01

2 TestAppl Sect1 USA None 1900-01-01

3 TestAppl Sect1 GBL None 1900-01-01

If you use:
&SECTION.Open("TestAppl", "Sect1", "1998-12-14");

Then the third section in the previous list is used, because the market takes highest precedence. When the
section is saved, the values for market and platform are updated to the current system values.

Warning! When you open or get an AESection object, (that is, any base section) any existing steps in the
section are deleted. You must add a new step to the section before you can modify it.
The other attributes of the section, however, are retained, with the exceptions noted previously.

AESection Example
Assume that you have a template section called TEMPLATE in the Application Engine program called
MY_APPL. The template looks like this:

Steps Actions

NewStep1 DO When

DO Select

SQL

NewStep2 DO Select

CallSection

Also, assume that you have a base section called DYN_SECT in the Application Engine program called
RULES. When you start, this section looks like this:

Steps Actions

Step1 DO Select

Call Section

DO Unit

Copyright © 1988, 2024, Oracle and/or its affiliates. 175

AESection Class Chapter 2

Steps Actions

Step2 Call Section

Here’s the PeopleCode:

Local AESection &Section;
&Section = GetAESection("RULES", "DYN_SECT");
/* Open the base section */
&Section.SetTemplate("MY_APPL", "TEMPLATE");
/* Set the template section */
&Section.AddStep("NewStep2");
/* Insert NewStep2 */
/* Do some SQL stuff here */
&Section.SetSQL("DO_SELECT", &MySql);
/* Modify the SQL in the added step */
&Section.Save();
&Section.Close();
/* Save and close */

The base section looks like this after execution:

Steps Actions

NewStep2 DO Select

Call Section

Note: The existing steps in the base section have been overwritten by the new step from the template
section.

Data Type of an AESection Object

You should declare an AESection object as type AESection. For example:
Local AESection &SECTION;

Scope of an AESection Object

An AESection object can only be instantiated from PeopleCode.

The AESection Object is designed for use within online pages. Typically, dynamic sections should be
constructed in response to an end-user action.

Note: Do not call an AESection object from an Application Engine PeopleCode Action. If you need to
access another section, use CallSection Actions instead.

Related Links
“Specifying Actions” (Application Engine)

176 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 2 AESection Class

AESection Class Built-in Function

“GetAESection” (PeopleCode Language Reference)

AESection Class Methods

In this section, we discuss each AESection class method, in alphabetical order.

AddStep

Syntax
AddStep(ae_step_name [, NewStepName])

Description
The given step name from the template section is added as the next step into the base section, and named
the existing step name.

Note: When you open or get a section, all the existing steps are deleted. The first time you execute
AddStep, you add the first step. The second time you execute AddStep, you add the second step, and so
on.

All attributes of the step are copied, including all of its actions. The only changeable attribute of a step are
its SQL statements, which can be modified using the SetSQL method. SetSQL is run on the current step,
that is, the step most recently added.

You can also change the name of the step by using the optional parameter NewStepName.

If the step named does not exist in the template, an error occurs. Likewise, if you have not opened or set
the template for the section, you receive an error.

Parameters

Parameter Description

ae_step_name Specify the step name from the template to be added as the
next step in the base section. This parameter takes a string
value.

NewStepName Specify a new name for the step to be added. This parameter is
optional, and takes a string value.

Returns
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 177

AESection Class Chapter 2

Example
See AESection Example.

Related Links
SetSQL

Close

Syntax
Close()

Description
Close closes the AESection object. Any unsaved changes to the section are discarded.

Parameters
None.

Returns
None.

Example
See AESection Example.

Related Links
Save
Open
“GetAESection” (PeopleCode Language Reference)

Open

Syntax
Open(ae_applid, ae_section, [effdt])

Description
The Open method associates the AESection object with the given Application Engine section, based on
the ae_applid and ae_section. If the effdt is specified, this is also used to get the section object. In other
words, the Open method sets the base section.

178 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 2 AESection Class

Warning! When you open or get an AESection object, (that is, the base section) any existing steps in the
section are deleted.

Note: If the base section you specify doesn’t exist, a new base section is created. This enables you to
dynamically create sections as needed. In addition, if the target section doesn't exist, all section-level
attributes are copied from the template to the target section. If the target exists, it retains its attribute
settings.

If the AESection is still open when you issue the Open method, the previously opened object is discarded
and none of the changes saved. To prevent accidentally discarding your changes, you can use the IsOpen
property to verify if a section is already open.

The AESection is open based on the Market and database type of your current system.

Parameters

Parameter Description

ae_applid Specify the application ID of the section you want to access.

This parameter takes a string value.

ae_section Specify the section name of the section you want to access.
This parameter takes a string value.

effdt Specify the effective date of the section you want to access
(optional). This parameter takes a string value.

Returns
An AESection object.

Example
Local AESection &SECTION;

&SECTION = GetAESection("RULES1", "DYN_SECT");

/* do some processing */

&SECTION.Close();

&SECTION.Open("RULES2", "DYN_SECT");

/* do additional processing */

Related Links
IsOpen
“GetAESection” (PeopleCode Language Reference)

Copyright © 1988, 2024, Oracle and/or its affiliates. 179

AESection Class Chapter 2

Save

Syntax
Save()

Description
The Save method saves the section to the database. The AESection object remains open after you use this
method. To close the object, you must use the Close method.

You must commit all database changes prior to using this method. This is to avoid locking critical Tools
tables and hence freezing all other users. You receive a runtime error message if you try to use this
method when there are pending database updates, and your PeopleCode program terminates. You need
to commit any database updates prior to using this method. Use the CommitWork function to commit
database updates.

Parameters
None.

Returns
None.

Example
See AESection Example.

Related Links
Close
Open
“CommitWork” (PeopleCode Language Reference)

SetSQL

Syntax
SetSQL(action_type_string, string)

Description
The SetSQL method replaces the SQL associated with the given action type in the current step in the
base section with the SQL in string. The current step is the latest step that was added using AddStep. The
action types are:

• DO_WHEN

• DO_WHILE

180 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 2 AESection Class

• DO_SELECT

• SQL

• DO_UNTIL

Note: All action types must be passed in as strings with quotation marks.

If the action specified does not exist in the current step, an error occurs.

You can use a SQL object as string.

&SECTION.SetSQL("SQL", &SQL);

Parameters

Parameter Description

action_type Specifies the action type of the current step that should be
changed. This parameter takes a string value.

string Specifies the SQL to be used to replace the SQL in the current
step.

Returns
None.

Example
See AESection Example.

Related Links
AddStep
Understanding SQL Class

SetTemplate

Syntax
SetTemplate(ae_applid, ae_section)

Description
The SetTemplate method sets the template to be used with an AESection object, as identified by
ae_applid and ae_section.

Copyright © 1988, 2024, Oracle and/or its affiliates. 181

AESection Class Chapter 2

The rules for assigning a template section are similar to the rules for selecting a base section. The
selection of market and database platform are done exactly the same. However, the effective date of the
template is always set based on the effective date of ‘1900-01-01’.

You must set the template before you can use any of the other methods.

Parameters

Parameter Description

ae_applid Specify the name of the Application Engine program that

contains the section to be used as the template.

ae_section Specify the name of the Application Engine section in the

program to be used as the section template.

Returns
None.

Example
See AESection Example.

Related Links
Open
How an AESection is Accessed
“GetAESection” (PeopleCode Language Reference)

AESection Class Property

In this section, we discuss the IsOpen AESection property.

IsOpen

Description
If this property is True, the section object is already open. If you try to open a section object that is
already open, the open section object is closed and all the changes that haven’t been saved are discarded
before the object is re-opened.

Example
If Not(&MYSECTION.IsOpen) Then
&MYSECTION.Open(MYAPPLID, SECTION2);
End-If;

182 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3

Analytic Calculation Engine Classes

Understanding the Analytic Calculation Engine Classes

PeopleSoft Analytic Calculation Engine comprises a calculation engine plus several PeopleTools features
which enable application developers to define both the calculation rules and the display of calculated data
within PeopleSoft applications for the purposes of multi-dimensional reporting, data editing and analysis.

More specifically, developers create analytic models in order to define the rules which are used to
calculate data. Developers also create PeopleSoft Pure Internet Architecture pages with analytic grids in
order to display the data within PeopleSoft applications. End users view, analyze and make changes to
this data. When end users save their changes, PeopleSoft Analytic Calculation Engine recalculates the
data and saves the calculated data to the database.

PeopleCode enables developers to manipulate analytic calculation data as follows:

• Use the Analytic Calculation Engine classes to either retrieve or specify data in an instance of an
analytic model loaded into the system, and also to calculate (or recalculate) cube values.

• Use the Analytic Calculation Engine metadata classes to manipulate an analytic model definition. For
example, you can add cubes to a cube collection or rename an existing user function for a model.

• Use the Analytic Grid classes to manipulate the display of analytic calculation data on a page.

• Use the Analytic Type classes to manipulate an analytic type definition. For example, you can specify
a new analytic model for an analytic type definition.

Important! The Analytic Calculation Engine classes are not supported on IBM z/OS and Linux for IBM
System z platforms.

Related Links
Understanding the Analytic Calculation Engine Classes
AnalyticGrid Class Reference
AnalyticType Classes Example
Understanding the Analytic Calculation Engine Classes

Using the Analytic Calculation Engine Classes with Application Engine

All Application Engine programs run on the application engine server. This means your program runs on
the application engine server, not the analytic server.

PeopleSoft recommends that you put each of the following methods into its own step when you're
creating an analytic calculation using a Application Engine program:

• AnalyticInstance Load method

Copyright © 1988, 2024, Oracle and/or its affiliates. 183

Analytic Calculation Engine Classes Chapter 3

• AnalyticInstance Unload method

• AnalyticInstance Copy method

• AnalyticInstance Delete method (in case of any readable/writable records in the analytic type)

• AnalyticModel Recalculate method

• CubeCollection SetData method

Also, with the Recalculate method, you should use the Commit after step option.

Running Synchronously
Some of the methods and functions associated with these classes have the option of being run
asynchronously. When you run these asynchronously, and not from a Application Engine program, these
methods and functions have additional functionality, that is, if the RenServer is configured, a window
displays the PeopleSoft Analytic Calculation Engine execution status.

Using Trees
PeopleSoft Analytic Calculation Engine uses trees to establish hierarchies of a dimension's parent-child
relationships. PeopleSoft Analytic Calculation Engine uses these hierarchies to:

• Calculate and display aggregated data to end users.

• Enable end users to navigate through data by performing such actions as expanding and collapsing
nodes.

• Enable end users to drill down and drill up through data.

It is important to understand that PeopleSoft trees and hierarchies differ in the following manner: You
create one tree for each dimension that requires a hierarchy. The analytic model uses that tree to create
one hierarchy for one dimension.

Use the AttachTree method to attach a tree to a dimension, and use the DetachTree method to detach the
tree from the dimension.

You should be aware of the following restrictions:

• Because the AttachTree method attaches a specific tree to an analytic instance, the system throws an
error if the tree's name, setID or effective date is incorrect.

• You can attach only one tree to one dimension at a time.

• If the analytic instance is already loaded into the analytic server, the tree isn't attached until the
analytic model is loaded.

• No aggregate data is displayed to the user after you use the DetachTree method.

184 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

• If your application loads the analytic model after the tree has been detached, the analytic model
doesn't create a hierarchy for the dimension.

• If the analytic instance is already loaded into the analytic server, the DetachTree method isn't applied
to the tree until the next time your application loads the analytic instance.

You can only attach a tree to an analytic model before the analytic instance

No aggregate data displayed to user after detach tree.

Related Links
“Understanding the Relationship of PeopleSoft Trees to Analytic Models” (Analytic Calculation Engine)

Error Handling
All the Analytic Calculation Engine classes throw PeopleCode exceptions for any fatal error that occurs
in the execution of the operation. PeopleSoft recommends enclosing your analytic model programs in try-
catch statements. This way, if your program catches the exception, the message set and message number
that are associated with the exception object indicate the error.

Using the Messages Property

Use the Messages property to determine whether any errors occurred. The Messages property returns a
multi-dimensional array. You can use the Len property of the array class to determine the length of the
array. If the array has a length of 0, there are no errors.

Data Types for Analytic Calculation Engine Classes

Every PeopleSoft Analytic Calculation Engine object is declared as its own data type, that is,
AnalyticModel objects are declared as type AnalyticModel, CubeCollection objects are declared as type
CubeCollection, and so on.

The following are the data types for the PeopleSoft Analytic Calculation Engine classes:

• AnalyticInstance

• AnalyticModel

• CubeCollection

Scope of Analytic Calculation Engine Classes

The Analytic Calculation Engine objects can only be instantiated from PeopleCode.

These objects can be used anywhere you have PeopleCode, that is, in a Application Engine program, an
application class, record field PeopleCode, and so on.

Copyright © 1988, 2024, Oracle and/or its affiliates. 185

Analytic Calculation Engine Classes Chapter 3

Analytic Calculation Engine objects can be of scope Local, Component, or Global.

Analytic Calculation Engine Classes Built-in Functions

“CreateAnalyticInstance” (PeopleCode Language Reference)

“GetAnalyticInstance” (PeopleCode Language Reference)

AnalyticInstance Class Methods

In this section, we discuss the AnalyticInstance methods. The methods are discussed in alphabetical order.

CheckAsyncStatus

Syntax
CheckAsyncStatus(OperationID)

Description
Use the CheckAsyncStatus method to determine the current state of the asynchronous methods, as well as
the Load method when executed asynchronously.

Parameters

Parameter Description

OperationID Specify the operation ID of the asynchronous operation.

This operation ID is returned when one of the asynchronous
operations is executed.

Returns
This method returns one of the following values:

Value Description

Less than 0 The operation completed with errors.

0 The operation has not completed yet.

Greater than 0 The operation completed successfully.

186 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Related Links
CheckStatus
Load
Unload

CheckStatus

Syntax
CheckStatus()

Description
Use the CheckStatus method to determine the current state of the analytic calculation engine.

Parameters
None.

Returns
This method returns one of the following values:

Value Description

%AnalyticInstance_NotLoaded The analytic instance has not been loaded into the application
server.

%AnalyticInstance_Loading The analytic instance is being loaded.

%AnalyticInstance_Idle The analytic instance is idle, that is, not currently running.

%AnalyticInstance_Busy The analytic instance is currently running.

%AnalyticInstance_ Inaccessible The analytic instance is currently inaccessible.

%AnalyticInstance_ Terminating The analytic instance is currently ending.

Related Links
Load
Unload

Copyright © 1988, 2024, Oracle and/or its affiliates. 187

Analytic Calculation Engine Classes Chapter 3

Copy

Syntax
Copy(NewID, ForceDelete&Record)

Description
Use the Copy method to copy all the data and metadata to a new analytic instance from the current
analytic instance.

If the specified NewID exists, or any data for NewID exists, the data is not copied unless ForceDelete has
been specified as true.

If a tree is attached to the existing analytic instance, all tree data is also copied to the new analytic
instance.

In addition, the analytic instance and the tree information are not copied unless the record specified with
the &Record parameter is populated with the existing analytic instance ID.

Parameters

Parameter Description

NewID Specify the new analytic instance ID as a string.

ForceDelete If the specified NewID exists, and ForceDelete is specified as

false, the copy is cancelled.

If the specified NewID exists, and ForceDelete is specified as

true, the analytic instance specified by NewID is deleted, and a
new analytic instance is created from the current ID.

&Record Specify an already instantiated record object to pass in values

to the Copy application package method that's defined with the
specified analytic type definition.

Returns
None.

Example
&ai.Copy("MYTESTCOPY", True, &MyRecord);

Related Links
Delete
Load
Unload

188 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

“Understanding Analytic Type Definitions” (Optimization Framework)

Delete

Syntax
Delete(ForceUnload, &RecordRef)

Description
Use the Delete method to remove all the metadata related to the given analytic instance.

Every analytic type definition is defined with an application package that contains three methods: Create,
Delete, and Copy. The values in &RecordRef are passed to the Delete method.

This method does not delete the analytic instance if the analytic instance is currently loaded. Specify
ForceUnload as true to unload the analytic instance before deleting it.

Parameters

Parameter Description

ForceUnload Specify whether to force the deletion of the analytic instance.

This parameter takes a Boolean value. If the analytic instance
is currently loaded, specifying true for this parameter forces
the analytic instance to be unloaded before it is deleted.

&RecordRef Specify a record to pass in values to the application package

Delete class that's associated with the analytic type definition.

Returns
None.

Example
&ai.Delete(TRUE, &Record);

Related Links
Unload
“Understanding Analytic Type Definitions” (Optimization Framework)

GetAnalyticModel

Syntax
GetAnalyticModel(AnalyticModel.ModelName)

Copyright © 1988, 2024, Oracle and/or its affiliates. 189

Analytic Calculation Engine Classes Chapter 3

Description
Use the GetAnalyticModel method to return a reference to an AnalyticModel object.

Parameters

Parameter Description

AnalyticModel.ModelName Specify the name of the analytic model for which you want to
return a reference. The model definition must already exist in
Application Designer.

Returns
A reference to an AnalyticModel object or Null.

Related Links
AnalyticModel Class Methods

Load

Syntax
Load(Sync, IdleTimeOut, Message.messagename)

Description
Use the Load method to load the AnalyticInstance object executing the method into the analytic server.

If this analytic instance is already loaded, this method fails.

When the analytic instance is loaded, if there are fields in the analytic type definition that haven't been
selected but are mapped to a cube or dimension, an error message is logged to the analytic server log and
the analytic instance load fails.

If there is a record in the analytic type definition that has none of its fields mapped to a cube or
dimension, a warning message is logged to the analytic server log.

Parameters

Parameter Description

Sync Specify whether the analytic instance should be run

synchronously or asynchronously. This parameter takes a
Boolean value: true if it should be run synchronously, false
otherwise.

See Running Synchronously.

190 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Parameter Description

IdleTimeOut Specify, in minutes, the idle time out value. A value of 0 is

an infinite time out. A value of -1 indicates that it should use
the value specified in the default configuration for the analytic
server.

Note: When loading an analytic grid, you should always

specify a value of -1.

See “Loading and Unloading Analytic Instances” (Analytic

Calculation Engine).

Message. MessageName Specify an application message that should be sent if the

analytic server crashes while the analytic instance is loaded.

Note: The message is sent when the analytic server process

restarts itself after crashing.

Returns
A string. For asynchronous loads, this string is passed to the CheckAsyncStatus method.

This method returns one of the following values:

Value Description

%AnalyticInstance_NotLoaded The analytic instance has not been loaded into the analytic
server.

%AnalyticInstance_Loading The analytic instance is being loaded.

%AnalyticInstance_Idle The analytic instance is idle, that is, not currently running.

%AnalyticInstance_Busy The analytic instance is currently running.

%AnalyticInstance_ Inaccessible The analytic instance is currently inaccessible.

%AnalyticInstance_ Terminating The analytic instance is currently terminating.

Related Links
CheckAsyncStatus
Unload

Copyright © 1988, 2024, Oracle and/or its affiliates. 191

Analytic Calculation Engine Classes Chapter 3

RunAsync

Syntax
RunAsync()

Description
Use the RunAsync method to specify if the analytic instance executing the method should be run in an
asynchronous manner.

This method is used only to define the transaction in the analytic type definition in optimization.
PeopleSoft Analytic Calculation Engine programs uses the Load method for defining synchronous or
asynchronous operation.

Parameters
None.

Returns
None.

Related Links
“Creating Analytic Type Definitions” (Optimization Framework)

RunSync

Syntax
RunSync()

Description
Use the RunSync method to specify if the analytic instance executing the method should be run in a
synchronous manner.

This method is used only to define the transaction in the analytic type definition in optimization.
PeopleSoft Analytic Calculation Engine programs uses the Load method for defining synchronous or
asynchronous operation.

Parameters
None.

Returns
None.

192 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Related Links
“Creating Analytic Type Definitions” (Optimization Framework)

Terminate

Syntax
Terminate()

Description
Use the Terminate method to force the termination of an analytic instance loaded in an analytic server.

This method should only be used from PeopleCode running in a Application Engine program to cause an
analytic instance loaded in an analytic server to be terminated.

Attempting to terminate an analytic instance that is not loaded or is loaded in a Application Engine
process results in a PeopleCode exception.

Although the Terminate method returns instantly, it may take up to a minute before the analytic instance is
actually terminated.

Parameters
None.

Returns
None.

Related Links
Load
Unload

Unload

Syntax
Unload()

Description
Use the Unload method to unload the analytic instance executing the method from the analytic server.
After unloading the analytic instance, the analytic server process is restarted.

Parameters
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 193

Analytic Calculation Engine Classes Chapter 3

Returns
None.

Example
&ai.UnLoad();

Related Links
Load

AnalyticInstance Class Properties

In this section, we discuss the AnalyticInstance properties. The properties are discussed in alphabetical
order.

AnalyticType

Description
This property returns the name of the analytic type definition for this AnalyticInstance object as a string.

This property is read-only.

ID

Description
This property returns the analytic instance ID of this AnalyticInstance object as an integer.

This property is read-only.

Messages

Description
This property returns a multi-dimensional array of any, containing the messages that occurred.

The first dimension contains the message set number. The second dimension contains the message
number. The third dimension contains the number of parameters in that message. The subsequent
dimensions contain the values for the parameters. The maximum number of possible dimensions is 8.

After you access this property, only new messages are returned, that is, messages are only returned once.

This property is read-only.

194 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Related Links
RunSync

AnalyticModel Class Methods

In this section, we discuss the AnalyticModel methods. The methods are discussed in alphabetical order.

AddMember

Syntax
AddMember(DimName, MemberName)

Description
Use the AddMember method to add the specified dimension member to the specified dimension.

Parameters

Parameter Description

DimName Specify the dimension to which you want to add the member.

MemberName Specify the name of the member that you want to add to the
specified dimension.

Returns
None.

Related Links
GetMembers
RenameMember

AttachTree

Syntax
AttachTree(DimName, TreeName, setID, UserKeyValue, EffDt, NodeName, OverrideRecord,⇒

DetailStartLvl, TreeDiscardLvl)

Copyright © 1988, 2024, Oracle and/or its affiliates. 195

Analytic Calculation Engine Classes Chapter 3

Description
Use the AttachTree method to attach a tree to a dimension. Only one tree can be attached to a dimension
at a time. You can only attach a tree before the analytic instance is loaded.

Parameters

Parameter Description

DimName Specify the name of the dimension that you want to attach a
tree to.

TreeName Specify the name of the tree that you want to attach to the
dimension.

setID Specify the table indirection key for the tree. This parameter
takes a string value. If the tree structure the tree is based on
has its IndirectionMethod specified as "S", you must specify a
setID.

If the tree structure doesn’t have its IndirectionMethod

specified as "S", you must enter a Null string (that is, two
quotation marks with no blank space between them ("")) for
this parameter.

UserKeyValue Specify the User Key Value for the tree. This parameter takes
a string value. If the tree structure the tree is based on has its
IndirectionMethod specified as "U" or "B", you must specify a
User Key Value.

If the tree structure doesn’t have its IndirectionMethod

specified as "U" or "B", you must enter a Null string (that is,
two quotation marks with no blank space between them (""))
for this parameter

EffDt Specify an effective date for this tree. This parameter takes a
string value.

NodeName Specify the tree node used as the dimension hierarchy root.
This can be different from the tree root, that is, you can pick a
subtree.

OverrideRecord Specify the name of a record to be used for overriding the

aggregate.

See “Working with Overrides” (Analytic Calculation Engine).

196 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Parameter Description

DetailStartLvl Specify the tree level number (such as 1 for the node hierarchy
root specified by the NodeName parameter) at which detail
nodes start.

If you specify a value other than 0, any nodes at this level

or greater than this level are considered details node, and
any nodes with levels less than the start level are considered
aggregate nodes

If you specify 0, detail nodes are nodes that don't have parents
(a node can be a parent either by having children or by having
child ranges).

TreeDiscardLvl Specify the tree level number (such as 1 for the node hierarchy
root specified by the NodeName parameter) at which to stop
loading the tree. Nodes at this level or at levels greater are
discarded. This parameter is only used if it has a value other
than 0, and if it has a value greater than DetailStartLvl.

Returns
None.

Related Links
DetachTree
GetTree
Understanding Tree Classes
“Understanding the Relationship of PeopleSoft Trees to Analytic Models” (Analytic Calculation Engine)

CalculateCube

Syntax
CalculateCube(CubeName[, Sync])

Description
Use the CalculateCube method to calculate the named cube in synchronous mode.

Parameters

Parameter Description

CubeName Specify the name of the cube that you want to calculate.

Copyright © 1988, 2024, Oracle and/or its affiliates. 197

Analytic Calculation Engine Classes Chapter 3

Parameter Description

Sync This parameter is optional and is not used. It is only being

included for previous releases. This parameter takes a Boolean
value. The value of this parameter is ignored. The cube is
always calculated in synchronous mode.

Returns
None.

Related Links
Running Synchronously
Recalculate

DetachTree

Syntax
DetachTree(DimName)

Description
Use the DetachTree method to detach a tree from the specified dimension.

You can only attach a tree when the analytic instance is not loaded. This method fails if you try to detach
a tree while the analytic instance is loaded.

Parameters

Parameter Description

DimName Specify the name of the dimension from which you want to
detach a tree.

Returns
None.

Related Links
AttachTree
GetTree
Understanding Tree Classes

198 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

GetCubeCollection

Syntax
GetCubeCollection(CubeCollName)

Description
Use the GetCubeCollection method to return a reference to a CubeCollection object.

Parameters

Parameter Description

CubeCollName Specify the name of the cube collection to which you want a
reference.

Returns
A CubeCollection object if successful.

Related Links
CubeCollection Class

GetCellProperties

Syntax
GetCellProperties(CubeName, &Node)

Description
Use the GetCellProperties method to get information about a cell.

Parameters

Parameter Description

CubeName Specify the name of the cube that contains the cell you want
information about.

&Node Specify an already instantiated array of array of string (a two-

dimensional array of string) containing name-value pairs of the
node name and the node detail.

Copyright © 1988, 2024, Oracle and/or its affiliates. 199

Analytic Calculation Engine Classes Chapter 3

Returns
An array of string.

The four strings returned in the array are:

1. Cell type. Values are “Aggregate” or “Detail”

2. User function.

3. Dimension for aggregation, the dimension name.

4. Aggregation reason. Values are: “Dimension Level Override”, “Member Level Override”, “Cube
Dimension Level Override”, “None.”

Related Links
Understanding Arrays

GetMembers

Syntax
GetMembers(DimName, DimFilter)

Description
Use the GetMembers method to return the names of the members in the specified dimension. You can
specify a user function to be used as a filter for the dimension using DimFilter.

When filtering hierarchy nodes, if the parent member is filtered, all the child nodes are also filtered.

In order to filter the parent member if all of its children are filtered, the user function should be written
such that for the parent node, apply the condition on all of its children, using the FORCHILDREN built-in
function. If none of the children satisfy the condition, return zero from the user function, which filters the
parent node.

Parameters

Parameter Description

DimName Specify the name of the dimension from which you want to get
the members.

DimFilter Specify a user function that you want to use to filter the
dimension.

Returns
A two-dimensional array of any.

200 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

The first dimension contains the member names. The second dimension contains the parent of the
member. The members are sorted in the hierarchy order.

If the dimension does not have a hierarchy, all members are returned as level one.

For example, if the dimension has the following members:

ALLREGIONS
NORTH AMERICA
USA
CANADA
MEXICO
EUROPE
FRANCE
GERMANY
ENGLAND
ASIA
JAPAN
CHINA

The GetMembers method returns the following:

Member Name Level

ALLREGIONS Null

NORTHAMERICA ALLREGIONS

USA NORTHAMERICA

CANADA NORTHAMERICA

MEXICO NORTHAMERICA

EUROPE ALLREGIONS

FRANCE EUROPE

ENGLAND EUROPE

GERMANY EUROPE

ASIA ALLREGIONS

JAPAN ASIA

CHINA ASIA

If the total member is present in the metadata, it is returned as level zero.

Copyright © 1988, 2024, Oracle and/or its affiliates. 201

Analytic Calculation Engine Classes Chapter 3

Related Links
AddMember
RenameMember

GetTree

Syntax
GetTree(DimName)

Description
Use the GetTree method to return an array of string that contains information about the tree that is
attached to the specified dimension.

Parameters

Parameter Description

DimName Specify the name of the dimension to which a tree is attached.

Returns
An array of string.

The array items have the following format:

1. TreeName

2. setID

3. UserKeyValue

4. EffDt

5. BranchName

6. Override record name

7. DetailStartLvl

8. TreeDiscardLvl

Related Links
AttachTree
DetachTree
Understanding Tree Classes

202 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Recalculate

Syntax
Recalculate(Sync)

Description
Use the Recalculate method to recalculates the loaded analytic model. If Sync is true, the transaction is
synchronous, else it is performed asynchronously.

The Recalculate method always writes any changes to readable, readable and writable, as well as writable
records to the database as specified by the analytic type definition.

If you are running in asynchronous mode, this method returns an optional string that contains the
operation ID to be used with the CheckAsyncStatus property.

Parameters

Parameter Description

Sync Specify whether the recalculation should be run synchronously

or asynchronously. This parameter takes a Boolean value: true
if it should be run synchronously, false otherwise.

Returns
A string.

Related Links
CalculateCube
CheckAsyncStatus
AnalyticModelDefn

RenameMember

Syntax
RenameMember(DimName, OrigMemberName, NewMemberName)

Description
Use the RenameMember method to rename a member in the specified dimension.

Copyright © 1988, 2024, Oracle and/or its affiliates. 203

Analytic Calculation Engine Classes Chapter 3

Parameters

Parameter Description

DimName Specify the dimension that contains the member you want to
rename.

OrigMemberName Specify the name of the member that you want to rename.

NewMemberName Specify the new name for the member specified by

OrigMemberName.

Returns
None.

Related Links
AddMember
GetMembers

AnalyticModel Class Property

In this section, we discuss the AnalyticModel class property.

Messages

Description
This property returns a multi-dimensional array of any containing the messages that occurred during
execution of the Recalculate method.

The first dimension contains the message set number. The second dimension contains the message
number. The third dimension contains the number of parameters in that message. The subsequent
dimensions contain the values for the parameters. The maximum number of possible dimensions is 8.

After you access this property, only new messages are returned, that is, messages are only returned once.

This property is read only.

Related Links
Recalculate

204 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

CubeCollection Class
Instantiate a CubeCollection object using the AnalyticModel class GetCubeCollection method.

In cube collections, the total member behaves just as the root of the hierarchy. If it's present, it's displayed
first in the list.

Filtering of members in a dimension in the cube collection is similar to filtering members using the
AnalyticModel class GetMembers method. If you filter the parent node, the children of that node are
filtered as well.

See GetCubeCollection.

CubeCollection Class Methods

In this section we discuss the CubeCollection class methods. The methods are described in alphabetical
order.

CollapseNode

Syntax
CollapseNode(DimName, &Node)

Description
Use the CollapseNode method to collapse a node in the dimension specified by DimName.

Parameters

Parameter Description

DimName Specify the name of the dimension that contains the node you
want to collapse.

&Node Specify an already instantiated array of array of string (a two-

dimensional array of string) containing name-value pairs of the
node name and the node detail. For example:

PRODUCTS Fax Modem

REGION East

Returns
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 205

Analytic Calculation Engine Classes Chapter 3

Related Links
ExpandNode

DrillIntoNode

Syntax
DrillIntoNode(DimName, &Node)

Description
Use the DrillIntoNode method to display more data for the specified node and dimension. This is very
similar to expanding, except that when you expand a node, the top level (node) is still present. When you
drill into a node, the top level or levels are no longer displayed.

Parameters

Parameter Description

DimName Specify the name of the dimension that contains the node that
you want to drill into.

&Node Specify an already instantiated array of array of string (a two-

dimensional array of string) containing name-value pairs of the
node name and the node detail. For example:

PRODUCTS Fax Modem

REGION East

Returns
None.

Related Links
DrillOutOfNode

DrillOutOfNode

Syntax
DrillOutOfNode(DimName, &Node)

Description
Use the DrillOutOfNode method to collapse the data that you just expanded.

206 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Parameters

Parameter Description

DimName Specify the name of the dimension that contains the node you
want to drill out of.

&Node Specify an already instantiated array of array of string (a two-

dimensional array of string) containing name-value pairs of the
node name and the node detail. For example:

PRODUCTS Fax Modem

REGION East

Returns
None.

Related Links
DrillIntoNode

ExpandNode

Syntax
ExpandNode(DimName, &Nodes, ExpandAll)

Description
Use the ExpandNode method to expand the nodes in the specified dimension.

Parameters

Parameter Description

DimName Specify the name of the dimension contains the node that you
want to expand.

&Nodes Specify an already instantiated array of array of string (a two-

dimensional array of string) containing name-value pairs of the
node name and the node detail.

ExpandAll Specify whether to expand the sub-nodes or not. This

parameter takes a Boolean value; true to expand the nodes,
false to not expand the nodes.

Copyright © 1988, 2024, Oracle and/or its affiliates. 207

Analytic Calculation Engine Classes Chapter 3

Returns
None.

Example
In the following example, both the Accounts and Dept dimensions have hierarchies.
Account Dept

All Acoounts All Depts

| ---- 100 | - ---- A
| |
| ---- 200 |------ B -| ---D
| |
| | --- E
| ---- 300

When the data is displayed, it will be as follows:

All Accounts
All Depts
100
All Depts
200
All Depts
300
All Depts

When you want to expand All Depts under Account 100 , use the following PeopleSoft Analytic
Calculation Engine code:
BAMCoordinate coord;
coord.SetValue( "Account", "100");
coord.SetValue("Dept" , "All Depts")
ExpandNode("Dept", coord, false)

The result of this will have the following:

All Accounts
All Depts
100
All Depts
A
B
200
All Depts
300
All Depts

Related Links
CollapseNode

GetData

Syntax
GetData(&DataRowset, StartRow, EndRow[, NetChanges])

208 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Description
Use the GetData method to populate a rowset with data from the cube collection.

DataRowset is the rowset into which is put the data. If you specify an already instantiated rowset, the
given rowset is populated with the data. If you specify a rowset that has not been instantiated, a new
rowset is created, with the record field definition of the desired cube collection.

Parameters

Parameter Description

&DataRowset Specify the rowset into which to put the data. If you specify an
already instantiated rowset, the given rowset is populated with
the data. If you specify a rowset that has not been instantiated,
a new rowset is created, with the record field definition of the
desired cube collection.

StartRow Specify the first row of data to be retrieved, as an integer.

EndRow Specify the last row of data to be retrieved, as an integer. If

you specify a zero for this parameter, all rows are retrieved.

NetChanges Specify whether all values within the range are returned, or
whether just values changed since the last time the Recalculate
method was used. This parameter takes a Boolean value: true,
return all values, false, return just the changed values. The
default value is false.

Returns
None.

Related Links
SetData
Messages
Understanding Rowset Class

GetDimFilter

Syntax
GetDimFilter(DimName)

Description
Use the GetDimFilter method to return the name of the current user function (filter) used with the
specified dimension.

Copyright © 1988, 2024, Oracle and/or its affiliates. 209

Analytic Calculation Engine Classes Chapter 3

Parameters

Parameter Description

DimName Specify the name of the dimension for which you want the
associated user function (filter).

Returns
A string containing the name of the user function. If there is no filter applied to the dimension, this
method returns an empty string.

Related Links
SetDimFilter

GetDimSort

Syntax
GetDimSort(DimName)

Description
Use the GetDimSort to return the current sort settings on the specified dimension.

Parameters

Parameter Description

DimName Specify the name of the dimension for which you'd like the
sort settings.

Returns
An array of any. The array contains the same structure as the signature for the SetDimSort method.

Value Description

Array index 1 IsAscending as Boolean

Array index 2 Key1 as string

Array index 3 IsAscending2 as Boolean

210 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Value Description

Array index 4 Key2 as string

Array index 5 IsAscending3 as Boolean

Array index 6 Key3 as string

Related Links
SetDimSort

GetLayout

Syntax
GetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray)

Description
Use the GetLayout method to return the current layout for the three axes, (slice, row, and column) on the
specified dimension.

Parameters

Parameter Description

&SlicerArray Specify an already instantiated array of string containing the

list of fields used on the slice axis.

&RowAxisArray Specify an already instantiated array of string containing the

list of fields used on the row axis.

&ColumnAxisArray Specify an already instantiated array of string containing the

list of fields used on the column axis.

Returns
None.

GetRowCount

Syntax
GetRowCount()

Copyright © 1988, 2024, Oracle and/or its affiliates. 211

Analytic Calculation Engine Classes Chapter 3

Description
Use the GetRowCount method to return the total number of rows in the cube collection.

The number of rows is a function of the hierarchy, that is, what is shown or not shown, and filtered
values.

Parameters
None.

Returns
An integer.

Related Links
GetDimension

GetSlice

Syntax
GetSlice(&SliceRecord)

Description
Use the GetSlice method to return the current slice values of all the dimensions.

Parameters

Parameter Description

&SliceRecord Specify an already instantiated record object to hold the values

of the slicer record.

Returns
None.

Related Links
SetSlice

SetData

Syntax
SetData(&DataRowset)

212 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Description
Use the SetData method to populate the data in the cube collection with the data in the specified rowset.

The system extracts only changed values from the rowset, that is, values marked as updated. .

SetData method also writes the changes to the database for any record marked as writable or readable and
writable in the analytic type definition, and mapped to the specified cube collection.

Parameters

Parameter Description

&DataRowset Specify the rowset object that contains the data you want to
use to populate the cube collection.

Returns
None.

Related Links
GetData
IsChanged
Understanding Rowset Class

SetDimensionOrder

Syntax
SetDimensionOrder(&FieldNames)

Description
Use the SetDimensionOrder method to specify the order of dimensions for this cube collection.

Parameters

Parameter Description

&FieldNames Specify an already instantiated array of string containing the

field names that are the dimensions in the cube collection, in
the order you want the dimensions.

Returns
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 213

Analytic Calculation Engine Classes Chapter 3

Related Links
SetDimSort

SetDimFilter

Syntax
SetDimFilter(DimName, DimFilter)

Description
Use the SetDimFilter method to set a dimension filter for the specified dimension in the cube collection.

Parameters

Parameter Description

DimName Specify the name of the dimension for which you want to
specify a dimension filter.

DimFilter Specify the name of the dimension filter (user function) that
you want to use the dimension.

Returns
None.

Related Links
“Understanding Dimensions” (Analytic Calculation Engine)

SetDimSort

Syntax
SetDimSort(DimName, IsAscending [, Key1, IsAscending2, Key2, IsAscending3, Key3])

Description
Use the SetDimSort method to specify the sorting order for the cube collection.

Key1, Key2and Key3 are optional parameters. If they are not specified, the sorting works as a name sort,
that is, it sorts by the name of members in the given dimension, either in ascending or descending order.

If keys are specified, the keys values refer to the names of the cubes to be used as they key. The method
orders the members of the dimension based on the value of the cubes for each member. The Boolean
parameter IsAscending defines whether sorting should be in ascending or descending order. Up to three

214 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

sort keys may be specified. Key1 is the primary sort key. Key2 is used to sub-sort any members that have
the same key value under Key1, and so on.

The scope of this method is the same as the scope of the AnalyticModel object created in PeopleCode,
that is, if the AnalyticModel object was declared with scope Global, this method would have a global
scope as well, if it was declared as Local, it would have Local, and so on.

Specifying a null string for DimName or for keys one through three removes the current value as a sort
value.

Parameters

Parameter Description

DimName Specify the dimension name that you would like sorted.

IsAscending Specify if the sort order is ascending or descending. This

parameter takes a Boolean value: true if the sort is ascending,
false if it's descending.

Key1 Specify the name of a key field by which the sort should be
ordered. If you do not specify keys, the sort is ordered by the
names of the members in the given dimensions. If you do
specify keys, the sort is order by the keys.

IsAscending2 Specify if the sort order for Key1is ascending or descending.

This parameter takes a Boolean value: true if the sort is
ascending, false if it's descending.

Key2 Specify the name of a key field to be used to sub-sort the

primary key field Key1.

IsAscending3 Specify if the sort order for Key2is ascending or descending.

This parameter takes a Boolean value: true if the sort is
ascending, false if it's descending.

Key3 Specify the name of a key field to be used to sub-sort the

primary key field Key2.

Returns
None.

SetSlice

Syntax
SetSlice(&SliceRecord)

Copyright © 1988, 2024, Oracle and/or its affiliates. 215

Analytic Calculation Engine Classes Chapter 3

Description
Use the SetSlice method to specify a slice record for this cube collection.

Parameters

Parameter Description

&SliceRecord Specify an already instantiated record as the record to be used

for the slice for the cube collection.

Returns
None.

Related Links
GetSlice

ShowHierarchy

Syntax
ShowHierarchy(DimName, Show, ExpandToLevel)

Description
Use the ShowHierarchy method to either hide or display the cube collection hierarchy.

If there is a tree attached to the dimension, and Show is false, only the detail level members are shown in
the Analytic grid. If Show is true, all members including nodes are shown.

When the hierarchy is hidden, the GetData method returns only leaf values. When the hierarchy is
displayed, GetData returns node values and leaf values.

The ExpandToLevel parameter expands the hierarchy to the level specified. Level indexes start from 0 ,
the root level.

For example, if you specify ExpandToLevel as 1, the grid displays the total (root member) and all the
detail members in a dimension with no tree attached.

In the following example, if you specify ExandToLevel as 2, the hierarchy would be displayed only to the
quarter level, and not to the month level.
ALL_TIME
2003
Q1
Jan
Feb
Mar
Q2
Apr
May

216 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

Jun
Q3
. . .
. . .
Q4
2004
Q1
Q2
Q3
Q4

Parameters

Parameter Description

DimName Specify the name of the dimension for which you want to
either display or hide the hierarchy.

Show Specify whether to display or hide the hierarchy. This

parameter takes a Boolean value; true to display the hierarchy,
false to hide it.

ExpandToLevel Specify to what level to expand the hierarchy, as a number.

Returns
None.

Related Links
CollapseNode
ExpandNode
GetData

UnsetDimFilter

Syntax
UnsetDimFilter(DimName)

Description
Use the UnsetDimFilter method to remove the filter on the specified dimension for the cube collection.

Parameters

Parameter Description

DimName Specify the name of the dimension from which you want to
remove the filter.

Copyright © 1988, 2024, Oracle and/or its affiliates. 217

Analytic Calculation Engine Classes Chapter 3

Returns
None.

Related Links
SetDimFilter

UnsetDimSort

Syntax
UnsetDimSort(DimName)

Description
Use the UnsetDimSort method to remove the sorting on the specified dimension for a cube collection.
After using this method, the members are returned in the global member order as specified in the analytic
model definition.

Parameters

Parameter Description

DimName Specify the name of the dimension from which you want to
remove sorting.

Returns
None.

Related Links
SetDimSort

CubeCollection Class Property

In this section we discuss the CubeCollection class property.

Messages

Description
This property returns a multi-dimensional array of any containing the messages that occurred during
execution of the GetData, SetData, and CalculateCube methods.

218 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 3 Analytic Calculation Engine Classes

The first dimension contains the message set number. The second dimension contains the message
number. The third dimension contains the number of parameters in that message. The subsequent
dimensions contain the values for the parameters. The maximum number of possible dimensions is 8.

After you access this property, only new messages are returned, that is, messages are only returned once.

This property is read-only.

Related Links
GetData
SetData
CalculateCube

Copyright © 1988, 2024, Oracle and/or its affiliates. 219

Analytic Calculation Engine Classes Chapter 3

220 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4

Analytic Calculation Engine Metadata

Classes

Understanding the PeopleSoft Analytic Calculation Engine

Metadata Classes
PeopleSoft Analytic Calculation Engine comprises a calculation engine plus several PeopleTools features
which enable application developers to define both the calculation rules and the display of calculated data
within PeopleSoft applications for the purposes of multi-dimensional reporting, data editing and analysis.

More specifically, developers create analytic models in order to define the rules which are used to
calculate data. Developers also create PeopleSoft Pure Internet Architecture pages with analytic grids in
order to display the data within PeopleSoft applications. End users view, analyze and make changes to
this data. When end users save their changes, PeopleSoft Analytic Calculation Engine recalculates the
data and saves the calculated data to the database.

PeopleCode enables developers to manipulate analytic calculation data as follows:

• Use the Analytic Calculation Engine classes to either retrieve or specify data in an instance of an
analytic model loaded into the system, and also to calculate (or recalculate) cube values.

• Use the Analytic Calculation Engine metadata classes to manipulate an analytic model definition. For
example, you can add cubes to a cube collection or rename an existing user function for a model.

• Use the Analytic Grid classes to manipulate the display of analytic calculation data on a page.

• Use the Analytic Type classes to manipulate an analytic type definition. For example, you can specify
a new analytic model for an analytic type definition.

Important! The Analytic Calculation Engine Metadata classes are not supported on IBM z/OS and Linux
for IBM System z platforms.

Related Links
Understanding the Analytic Calculation Engine Classes
AnalyticGrid Class Methods
Using the Analytic Type Classes

Using the Analytic Calculation Engine Metadata Classes

You can create analytic model definitions using Application Designer. PeopleSoft provides the Analytic
Calculation Engine Metadata classes for accessing these definitions at runtime.

Copyright © 1988, 2024, Oracle and/or its affiliates. 221

Analytic Calculation Engine Metadata Classes Chapter 4

You can also create an analytic model definition in PeopleCode, using the Create method, then saving it
to the database using the Save method. After you save the definition, you can access it using Application
Designer.

All of the primary objects (dimensions, cube collections, cubes, and so on) are instantiated from an
analytic model object, so you only need to create an instance of the analytic model. You can also build a
rule as an object instead of as a string.

Inserting and Deleting Objects

If you insert or delete an object from a group of objects, any existing object references are no longer valid.
For example, if you use the DeleteCube method, any existing references to cube objects are no longer
valid. You need to create any object references after using any insert or delete method.

Building a Rule as an Object

The RuleExpressions subpackage contains several classes. Each of these classes represents the
different parts of the analytic calculation engine rule grammar. These objects are created using the
Create built-in function and the constructor for that class, then added to the RuleDefn object with the
AddRuleExpression method.

The following example creates a cube that uses the Analytic Calculation Engine built-in function AT.
Function AT_Cube
/** AT Cube Rule **/
&Expected = "AT(GENERAL2, [GENERAL2:4], LOOKUPVALUES)";
&CubeName = "AT";

&FunCall = create PT_ANALYTICMODELDEFN:RuleExpressions:FunctionCall(&Constants.F⇒

uncCall_Type_Builtin, &Constants.FuncCall_Builtin_AT);

&Constant = create PT_ANALYTICMODELDEFN:RuleExpressions:Constant(&Constants.Cons⇒

tant_Type_Literal, "GENERAL2");
&FunCall.AddArgument(&Constant);

&MemberRefArgument = create PT_ANALYTICMODELDEFN:RuleExpressions:MemberReference⇒

("GENERAL2", "4");
&FunCall.AddArgument(&MemberRefArgument);

&CubeArgument = create PT_ANALYTICMODELDEFN:RuleExpressions:Cube("LOOKUPVALUES")⇒

;
&FunCall.AddArgument(&CubeArgument);

&RuleDefn = create PT_ANALYTICMODELDEFN:RuleDefn("");

&CubeDefn = &Model.GetCube(&CubeName);
&RuleDefn.AddRuleExpression(&FunCall);
&RuleDefn.GenerateRule();
&CubeDefn.SetRule(&RuleDefn);
If ( Not (Exact(&RuleDefn.RuleString, &Expected))) Then
&Model.Save();
Error ("Rule Experession API Failed [Cube " | &CubeName | " Rule]");
End-If;
End-Function;

222 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Error Handling
All the Analytic Calculation Engine Metadata classes throw PeopleCode exceptions for any fatal error
that occurs in the execution of the operation. PeopleSoft recommends enclosing your analytic model
programs in try-catch statements. This way, if your program catches the exception, the message set and
message number that are associated with the exception object indicate the error.

Related Links
Try-Catch Blocks

Data Types of the Analytic Calculation Engine Metadata Objects

Every PeopleSoft Analytic Calculation Engine metadata object is declared as its own data type, that is,
AnalyticModelDefn objects are declared as type AnalyticModelDefn, CubeDefn objects are declared as
type CubeDefn, and so on.

Scope of Analytic Calculation Engine Metadata Objects

The Analytic Calculation Engine Metadata objects can only be instantiated from PeopleCode.

These objects can be used anywhere you have PeopleCode, that is, in a Application Engine program, an
application class, record field PeopleCode, and so on.

Analytic Calculation Engine Metadata objects can be of scope Local, Component or Global.

How to Import the Analytic Calculation Engine Metadata Classes

The Analytic Calculation Engine metadata classes are not built-in classes, like Rowset, Field, Record, and
so on. They are application classes. Before you can use these classes in your PeopleCode program, you
must import them to your program.

An import statement names either all the classes in a package or one particular application class. For
importing the Analytic Calculation Engine metadata classes, PeopleSoft recommends that you import all
the classes in the application package.

The application package PT_ANALYTICMODELDEFN contains the following subclasses:

• AnalyticModelDefn

• CubeCollectionDefn

• CubeDefn

• DimensionDefn

• ExplicitDimSet

Copyright © 1988, 2024, Oracle and/or its affiliates. 223

Analytic Calculation Engine Metadata Classes Chapter 4

• OrganizerDefn

• RuleDefn

• UserFunctionDefn

Additionally, there is a sub-application package, RuleExpressions, that contains classes used to build a
rule as object instead of as a simple string. This package contains the following classes:

• Assignment

• Comparison

• Constant

• Constants

• Cube

• ExpressionBlock

• FunctionCall

• MemberReference

• Operation

• RuleExpression

• Variable

The import statements that you should use should be as follows:

import PT_ANALYTICMODELDEFN:*;
import PT_ANALYTICMODELDEFN:RuleExpressions:*;

Using the asterisks after the package name makes all the application classes directly contained in the
named package available.

Related Links
Understanding Application Classes

How to Create an Analytic Calculation Engine Metadata Class

Object
After you've imported the Analytic Calculation Engine metadata classes, you need to instantiate an
instance of the AnalyticModelDefn class, using the constructor for that class and the Create function.
After you create the object, you must populate it using either the Get or Create method.

The following example creates an AnalyticModelDefn object from the QE_ALLFUNCTION analytic
model definition.
import PT_ANALYTICMODELDEFN:*;

224 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Local AnalyticModelDefn &Model;

&Model = create AnalyticModelDefn("QE_ALLFUNCTION");

Related Links
Analytic Calculation Engine Metadata Classes Constructor

Analytic Calculation Engine Metadata Classes Constructor

You must use the constructor for the AnalyticModelDefn class to instantiate an instance of that class. All
other metadata objects are instantiated from this class.

AnalyticModelDefn

Syntax
AnalyticModelDefn(ModelName)

Description
Use the AnalyticModelDefn constructor to create an AnalyticModelDefn object.

Once the AnalyticModelDefn object is created, you can then execute either the Get or Create methods to
‘instantiate’ the model.

Note: The Delete and Rename methods can only be executed before a model is ‘instantiated’.

Parameters

Parameter Description

ModelName Specify the name of an analytic model definition.

Returns
An AnalyticModelDefn object.

Example
&Model = create AnalyticModelDefn("QE_ALLFUNCTION");

Related Links
AnalyticModelDefn Class

Copyright © 1988, 2024, Oracle and/or its affiliates. 225

Analytic Calculation Engine Metadata Classes Chapter 4

AnalyticModelDefn Class
Use the AnalyticModelDefn class to view or manipulate an analytic model definition that's already been
created in Application Designer, or to create a new definition.

Related Links
AnalyticModel Class Methods

AnalyticModelDefn Class Methods

The following section discusses the AnalyticModelDefn class methods. The methods are discussed in
alphabetical order.

AddCube

Syntax
AddCube(CubeName)

Description
Use the AddCube method to add a new cube to the analytic model definition. This method fails if the
cube specified by CubeName already exists.

Parameters

Parameter Description

CubeName Specify the name of a new cube that you want to add to the
analytic model.

Returns
A CubeDefn object.

Related Links
CopyCube
DeleteCube
GetCube
GetCubeNames
RenameCube
CubeDefn Class

226 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

AddCubeCollection

Syntax
AddCubeCollection(CubeCollectionName)

Description
Use the AddCubeCollection method to add a new cube collection to the analytic model definition. This
method fails if CubeCollectionName already exists.

Parameters

Parameter Description

CubeCollectionName Specify the name of a new cube collection that you want to
add to the analytic model definition.

Returns
A CubeCollectionDefn object.

Related Links
CopyCubeCollection
DeleteCubeCollection
GetCubeCollection
RenameCubeCollection

AddDimension

Syntax
AddDimension(DimName)

Description
Use the AddDimension method to add a new dimension to the analytic model. This method fails if the
specified dimension already exists.

When you add a dimension to a cube, the dimension is also automatically added to any cube collections
that already contain the cube.

Copyright © 1988, 2024, Oracle and/or its affiliates. 227

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters

Parameter Description

DimName Specify the name of the dimension you want to add. This must
be a new dimension.

Returns
A DimensionDef object.

Related Links
CopyDimension
DeleteDimension
GetDimension
DimensionDefn Class

AddExplicitDimensionSet

Syntax
AddExplicitDimensionSet(ExplicitDimSetName)

Description
Use the AddExplicitDimensionSet method to add a new explicit dimension set to the analytic model. This
method fails if the specified explicit dimension set already exists.

Parameters

Parameter Description

ExplicitDimSetName Specify the name of the explicit dimension you want to add.
This must be a new explicit dimension.

Returns
An ExplicitDimensionSet object.

Related Links
GetExplicitDimensionSet
DeleteExplicitDimensionSet
CopyExplicitDimensionSet
GetExplicitDimensionSetNames
RenameExplicitDimensionSet

228 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

AddOrganizer

Syntax
AddOrganizer(OrganizerName)

Description
Use the AddOrganizer method to add a new organizer to the analytic model. This method fails if the
organizer specified by OrganizerName already exists.

Parameters

Parameter Description

OrganizerName Specify the name of the organizer you want to add.

Returns
An OrganizerDefn object.

Related Links
DeleteOrganizer
GetOrganizer
GetOrganizerNames
RenameOrganizer
OrganizerDefn Class

AddUserFunction

Syntax
AddUserFunction(UserFunctionName)

Description
Use the AddUserFunction method to add a new user function to the analytic model. This method fails if
the user function specified by UserFunction already exists.

Parameters

Parameter Description

UserFunctionName Specify the name of the new user function that you want to
add.

Copyright © 1988, 2024, Oracle and/or its affiliates. 229

Analytic Calculation Engine Metadata Classes Chapter 4

Returns
A UserFunction object.

Related Links
CopyUserFunction
DeleteUserFunction
GetUserFunction
GetUserFunctionNames
RenameUserFunction
UserFunctionDefn Class

CopyCube

Syntax
CopyCube(CubeName, NewCubeName)

Description
Use the CopyCube method to copy the specified cube to the new cube. This method fails if the cube
specified by CubeName already exists.

Parameters

Parameter Description

CubeName Specify the name of the cube that you want to copy.

NewCubeName Specify the name of the new cube that you want to create.

Returns
A CubeDefn object.

Related Links
AddCube
AddCube
GetCube
GetCubeNames
RenameCube
CubeDefn Class

230 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

CopyCubeCollection

Syntax
CopyCubeCollection(CubeCollectionName, NewCubeCollectionName)

Description
Use the CopyCubeCollection method to copy the specified cube collection to a new collection. If the new
cube collection specified by NewCubeCollectionName already exists, this method fails.

Parameters

Parameter Description

CubeCollectionName Specify the name of the cube collection that you want to copy.

NewCubeCollectionName Specify the name you want for the new cube collection.

Returns
A CubeCollectionDefn object.

Related Links
AddCubeCollection
DeleteCubeCollection
GetCubeCollection
GetCubeCollectionNames
RenameCubeCollection
CubeCollectionDefn Class

CopyDimension

Syntax
CopyDimension(DimName, NewDimName)

Description
Use the CopyDimension method to copy the dimension specified by DimName to a new dimension. If the
dimension specified by NewDimName already exists, this method fails.

Copyright © 1988, 2024, Oracle and/or its affiliates. 231

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters

Parameter Description

DimName Specify the name of the dimension that you want to copy.

NewDimName Specify the name of the new dimension that you want the data
copied to.

Returns
A DimensionDefn object.

Related Links
AddDimension
DeleteDimension
RenameDimension

CopyExplicitDimensionSet

Syntax
CopyExplicitDimensionSet(ExplicitDimSetName, NewExplicitDimSetName)

Description
Use the CopyExplicitDimensionSet method to copy the explicit dimension set specified by
ExplicitDimSetName to a new explicit dimension set. If the explicit dimension set specified by
NewExplicitDimSetName already exists, this method fails.

Parameters

Parameter Description

ExplicitDimSetName Specify the name of the explicit dimension set that you want to
copy.

NewExplicitDimSetName Specify the name of the new explicit dimension set that you
want the data copied to.

Returns
An ExplicitDimensionSet object.

232 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Related Links
RenameExplicitDimensionSet
AddExplicitDimensionSet
DeleteExplicitDimensionSet
GetExplicitDimensionSet
GetExplicitDimensionSetNames

CopyTo

Syntax
CopyTo(NewModelName)

Description
Use the CopyTo method to copy the AnalyticModelDefn object to a new analytic model specified by
NewModelName. If the model set specified by NewModelName already exists, this method fails.

Parameters

Parameter Description

NewModelName Specify the name of a new analytic model definition that you
want to create.

Returns
An AnalyticModelDefn object.

Related Links
Create
Delete
Get
Rename
Save

CopyUserFunction

Syntax
CopyUserFunction(UserFunctionName, NewUserFunctionName)

Description
Use the CopyUserFunction method to copy the user function specified by UserFunctionName to a new
user function. If the user function specified by NewUserFunctionName already exists, this method fails.

Copyright © 1988, 2024, Oracle and/or its affiliates. 233

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters

Parameter Description

UserFunctionName Specify the name of the user function that you want to copy.

NewUserFunctionName Specify the name of the new user function that you want to
add.

Returns
A UserFunctionDefn object.

Related Links
AddUserFunction
DeleteUserFunction
GetUserFunction
GetUserFunctionNames
RenameUserFunction
UserFunctionDefn Class

Create

Syntax
Create()

Description
Use the Create method to create, and instantiate, a new model. If you save the new model after you create
it, you can then access it in Application Designer as an analytic model definition.

If the model already exists, an exception is thrown.

Parameters
None.

Returns
None.

Related Links
CopyTo
Delete
Get

234 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Rename

Delete

Syntax
Delete()

Description
Use the Delete method to delete the analytic model executing the method.

You can only use this method on a closed analytic model definition, that is, before you use a Get or Create
method.

Warning! The delete occurs immediately, that is, the analytic model definition is removed from the
database. Only use this method if you're certain you want to delete the definition.

If this model is used by any existing analytic type definition, this method fails.

Parameters
None.

Returns
None.

Related Links
CopyTo
Create
Get
Rename
Save

DeleteCube

Syntax
DeleteCube(CubeName, ForceDelete)

Description
Use the DeleteCube method to delete the cube specified by CubeName.

Copyright © 1988, 2024, Oracle and/or its affiliates. 235

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters

Parameter Description

CubeName Specify the name of the cube you want to delete from the
analytic model.

ForceDelete Specify if the cube should always be deleted. This parameter

takes a Boolean value. If you specify ForceDelete as false, and
the cube is used by another part (such as a cube collection) this
method fails. If you specify ForceDelete as true, and the cube
is used by another part, the cube is still deleted.

Returns
None.

Related Links
AddCube
GetCube
GetCubeNames
RenameCube
CubeCollectionDefn Class

DeleteCubeCollection

Syntax
DeleteCubeCollection(CubeCollectionName, ForceDelete)

Description
Use the DeleteCubeCollection method to delete the cube collection specified by CubeCollectionName.

Parameters

Parameter Description

CubeCollectionName Specify the name of the cube collection that you want to delete
from the analytic model.

ForceDelete Specify if the cube collection should always be deleted. This

parameter takes a Boolean value. If you specify ForceDelete
as false, and the cube collection is used by another part (such
as an Organizer), this method fails. If you specify ForceDelete
as true, and the cube collection is used by another part, the
cube collection is still deleted.

236 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Returns
None.

Related Links
AddCubeCollection
GetCubeCollection
GetCubeCollectionNames
RenameCubeCollection
CubeCollectionDefn Class

DeleteDimension

Syntax
DeleteDimension(DimensionName, ForceDelete)

Description
Use the DeleteDimension method to delete the dimension specified by DimensionName.

Parameters

Parameter Description

DimensionName Specify the name of the dimension you want to delete.

ForceDelete Specify if the dimension should always be deleted. This

parameter takes a Boolean value. If you specify ForceDelete
as false, and the dimension is used by another part (such as a
cube), this method fails. If you specify ForceDelete as true,
and the dimension is used by another part, the dimension is
still deleted.

Returns
None.

Related Links
AddDimension
CopyDimension
GetDimension
GetDimensionNames
RenameDimension
DimensionDefn Class

Copyright © 1988, 2024, Oracle and/or its affiliates. 237

Analytic Calculation Engine Metadata Classes Chapter 4

DeleteExplicitDimensionSet

Syntax
DeleteExplicitDimensionSet(ExplicitDimensionSetName, ForceDelete)

Description
Use the DeleteExplicitDimensionSet method to delete the explicit dimension set specified by
ExplicitDimensionSetName.

Parameters

Parameter Description

ExplicitDimensionSetName Specify the name of the explicit dimension set you want to
delete.

ForceDelete The value of this parameter is ignored in the current release.

Returns
None.

Related Links
AddExplicitDimensionSet
CopyExplicitDimensionSet
GetExplicitDimensionSet
GetExplicitDimensionSetNames
RenameExplicitDimensionSet

DeleteOrganizer

Syntax
DeleteOrganizer(OrganizerName, ForceDelete)

Description
Use the DeleteOrganizer method to delete the organizer specified by OrganizerName.

238 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Parameters

Parameter Description

OrganizerName Specify the name of the organizer you want to delete.

ForceDelete This value is ignored in the current release.

Returns
None.

Related Links
AddOrganizer
GetOrganizer
GetOrganizerNames
RenameOrganizer
OrganizerDefn Class

DeleteUserFunction

Syntax
DeleteUserFunction(UserFunctionName, ForceDelete)

Description
Use the DeleteUserFunction method to delete the user function specified by UserFunctionName.

Parameters

Parameter Description

UserFunctionName Specify the name of the user function you want to delete.

ForceDelete Specify if the user function should always be deleted. This

parameter takes a Boolean value. If you specify ForceDelete
as false, and the user function is used by another part, this
method fails. If you specify ForceDelete as true, and the
user function is used by another part, the user function is still
deleted.

Returns
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 239

Analytic Calculation Engine Metadata Classes Chapter 4

Related Links
AddUserFunction
CopyUserFunction
GetUserFunction
GetUserFunctionNames
RenameUserFunction
UserFunctionDefn Class

Get

Syntax
Get()

Description
Use the Get method to instantiate an instance of the analytic model.

If the model doesn't exist, an exception is thrown.

Parameters
None.

Returns
None.

Related Links
CopyTo
Create
Delete
Rename
Save

GetCube

Syntax
GetCube(CubeName)

Description
Use the GetCube method to return a reference to the cube specified by CubeName. This method fails if
the cube specified by CubeName doesn't exist.

240 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Parameters

Parameter Description

CubeName Specify the name of the cube that you want a reference to.

Returns
A CubeDefn object.

Related Links
AddCube
CopyCube
DeleteCube
GetCubeNames
RenameCube
CubeCollectionDefn Class

GetCubeCollection

Syntax
GetCubeCollection(CubeCollectionName)

Description
Use the GetCubeCollection method to return a reference to a cube collection. This method fails if the
cube collection specified by CubeCollectionName doesn't exist.

Parameters

Parameter Description

CubeCollection Specify the name of the cube collection you want a reference
to.

Returns
A CubeCollectionDefn object.

Related Links
AddCubeCollection
CopyCubeCollection
DeleteCubeCollection
GetCubeCollection

Copyright © 1988, 2024, Oracle and/or its affiliates. 241

Analytic Calculation Engine Metadata Classes Chapter 4

GetCubeCollectionNames
RenameCubeCollection
CubeCollectionDefn Class

GetCubeCollectionNames

Syntax
GetCubeCollectionNames()

Description
Use the GetCubeCollectionNames method to return an array of strings containing all the names of the
cube collections associated with this analytic model.

Parameters
None.

Returns
An array of string.

Related Links
AddCubeCollection
CopyCubeCollection
DeleteCubeCollection
GetCubeCollection
RenameCubeCollection
CubeCollectionDefn Class
Understanding Arrays

GetCubeNames

Syntax
GetCubeNames()

Description
Use the GetCubeNames method to return an array of strings containing all the names of the cubes
associated with this analytic model.

Parameters
None.

242 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Returns
An array of string.

Related Links
AddCube
CopyCube
DeleteCube
GetCube
RenameCube
CubeCollectionDefn Class
Understanding Arrays

GetDimension

Syntax
GetDimension(DimName)

Description
Use the GetDimension method to return a reference to the dimension specified by DimName. This method
fails if the dimension specified by DimName doesn't exist.

Parameters

Parameter Description

DimName Specify the name of the dimension that you want a reference
to.

Returns
A DimensionDefn object.

Related Links
AddDimension
CopyDimension
DeleteDimension
GetDimensionNames
RenameDimension
DimensionDefn Class

Copyright © 1988, 2024, Oracle and/or its affiliates. 243

Analytic Calculation Engine Metadata Classes Chapter 4

GetDimensionNames

Syntax
GetDimensionNames()

Description
Use the GetDimensionNames method to return an array of string containing the names of all the
dimensions associated with the analytic model.

Parameters
None.

Returns
An array of string.

Related Links
AddDimension
CopyDimension
DeleteDimension
DeleteDimension
GetDimension
RenameDimension
DimensionDefn Class
Understanding Arrays

GetExplicitDimensionSet

Syntax
GetExplicitDimensionSet(ExplicitDimSetName)

Description
Use the GetExplicitDimensionSet method to return a reference to the explicit dimension set specified by
ExplicitDimSetName. This method fails if the explicit dimension set specified by ExplicitDimSetName
doesn't exist.

244 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Parameters

Parameter Description

ExplicitDimSetName Specify the name of the explicit dimension set that you want a
reference to.

Returns
An ExplicitDimensionSet object.

Related Links
AddExplicitDimensionSet
CopyExplicitDimensionSet
DeleteExplicitDimensionSet
GetExplicitDimensionSetNames

GetExplicitDimensionSetNames

Syntax
GetExplicitDimensionSetNames()

Description
Use the GetExplicitDimensionSetNames method to return an array of string containing the names of all
the explicit dimension sets associated with the analytic model.

Parameters
None.

Returns
An array of strings.

Related Links
ExplicitDimensionSet Class

GetOrganizer

Syntax
GetOrganizer(OrganizerName)

Copyright © 1988, 2024, Oracle and/or its affiliates. 245

Analytic Calculation Engine Metadata Classes Chapter 4

Description
Use the GetOrganizer method to return a reference to the organizer specified by OrganizerName. This
method fails if the organizer specified by OrganizerName doesn't exist.

Parameters

Parameter Description

OrganizerName Specify the name of the organizer you want a reference to.

Returns
An OrganizerDefn object.

Related Links
AddOrganizer
DeleteOrganizer
GetOrganizerNames
RenameOrganizer
OrganizerDefn Class

GetOrganizerNames

Syntax
GetOrganizerNames()

Description
Use the GetOrganizerNames method to return an array of string containing the names of all the organizers
associated with the analytic model.

Parameters
None.

Returns
An array of string.

Related Links
AddOrganizer
DeleteOrganizer
GetOrganizer
RenameOrganizer

246 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

OrganizerDefn Class
Understanding Arrays

GetUserFunction

Syntax
GetUserFunction(UserFunctionName)

Description
Use the GetUserFunction method to return a reference to the user function specified by
UserFunctionName. This method fails if the user function specified by UserFunctionName doesn't exist.

Parameters

Parameter Description

UserFunctionName Specify the name of a user function that you want a reference
to.

Returns
A UserFunctionDefn object

Related Links
AddUserFunction
CopyUserFunction
DeleteUserFunction
GetUserFunctionNames
RenameUserFunction
UserFunctionDefn Class

GetUserFunctionNames

Syntax
GetUserFunctionNames()

Description
Use the GetUserFunctionNames method to return an array of string containing the names of all the user
functions associated with the analytic model.

Copyright © 1988, 2024, Oracle and/or its affiliates. 247

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters
None.

Returns
An array of string.

Related Links
AddUserFunction
CopyUserFunction
DeleteUserFunction
GetUserFunction
RenameUserFunction
UserFunctionDefn Class
Understanding Arrays

Rename

Syntax
Rename(NewModelName)

Description
Use the Rename method to rename the analytic model.

You can only use this method on a closed analytic model definition, that is, before you use a Get or Create
method.

Parameters

Parameter Description

NewModelName Specify the new name of the model.

Returns
None.

Related Links
Create
Get
Save

248 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

RenameCube

Syntax
RenameCube(CubeName, NewCubeName, ForceRename)

Description
Use the RenameCube method to rename the cube specified by CubeName to NewCubeName.

Parameters

Parameter Description

CubeName Specify the name of the cube you want to rename.

NewCubeName Specify the new name for the cube.

ForceRename Specify if the cube should always be renamed. This parameter

takes a Boolean value. If you specify ForceRename as false,
and the cube is used by another part (such as a cube collection)
this method fails. If you specify ForceRename as true, and the
cube is used by another part, the cube is still renamed.

Returns
None.

Related Links
AddCube
CopyCube
DeleteCube
GetCube
GetCubeNames
CubeDefn Class

RenameCubeCollection

Syntax
RenameCubeCollection(CubeCollectionName, NewCubeCollectionName, ForceRename

Description
Use the RenameCubeCollection method to rename the cube collection specified by CubeCollectionName
to the new name NewCubeCollectionName

Copyright © 1988, 2024, Oracle and/or its affiliates. 249

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters

Parameter Description

CubeCollectionName Specify the name of the cube collection that you want to
rename.

NewCubeCollectionName Specify the new name of the cube collection.

ForceRename Specify if the cube collection should always be renamed. This

parameter takes a Boolean value. If you specify ForceRename
as false, and the cube collection is used by another part (such
as an organizer) this method fails. If you specify ForceRename
as true, and the cube collection is used by another part, the
cube collection is still renamed.

Returns
None.

Related Links
AddCubeCollection
CopyCubeCollection
DeleteCubeCollection
GetCubeCollection
GetCubeCollectionNames
GetCubeCollectionNames

RenameDimension

Syntax
RenameDimension(DimName, NewDimName, ForceRename)

Description
Use the RenameDimension method to rename the dimension specified by DimName to the new name
NewDimName.

Parameters

Parameter Description

DimName Specify the name of the dimension you want to rename.

NewDimName Specify the new name of the dimension.

250 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Parameter Description

ForceRename Specify if the dimension should always be renamed. This

parameter takes a Boolean value. If you specify ForceRename
as false, and the dimension is used by another part (such as a
cube) this method fails. If you specify ForceRename as true,
and the dimension is used by another part, the dimension is
still renamed.

Returns
None.

Related Links
AddDimension
CopyDimension
DeleteDimension
GetDimension
GetDimensionNames
DimensionDefn Class

RenameExplicitDimensionSet

Syntax
RenameExplicitDimensionSet(ExplicitDimSetName, NewExplicitDimSetName, ForceRename)

Description
Use the RenameExplicitDimensionSet method to rename the explicit dimension set specified by
ExplicitDimSetName to the new name NewExplicitDimSetName.

Parameters

Parameter Description

ExplicitDimSetName Specify the name of the explicit dimension set you want to
rename.

NewExplicitDimSetName Specify the new name of the explicit dimension set.

ForceRename The value for this parameter is ignored in the current release.

Returns
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 251

Analytic Calculation Engine Metadata Classes Chapter 4

Related Links
AddExplicitDimensionSet
CopyExplicitDimensionSet
DeleteExplicitDimensionSet
GetExplicitDimensionSet
RenameExplicitDimensionSet

RenameOrganizer

Syntax
RenameOrganizer(OrganizerName, NewOrganizerName, ForceRename)

Description
Use the RenameOrganizer method to rename the organizer specified by OrganizerName to the new name
NewOrganizerName.

Parameters

Parameter Description

OrganizerName Specify the name of the organizer you want to rename.

NewOrganizerName Specify the new name for the organizer.

ForceRename The value for this parameter is ignored in the current release.

Returns
None.

Related Links
AddOrganizer
DeleteOrganizer
GetOrganizer
GetOrganizerNames
OrganizerDefn Class

RenameUserFunction

Syntax
RenameUserFunction(UserFunctionName, NewUserFunctionName, ForceRename)

252 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Description
Use the RenameUserFunction method to rename the user function specified by UserFunctionName to the
new name NewUserFunctionName.

Parameters

Parameter Description

UserFunctionName Specify the name of the user function you want to rename.

NewUserFunctionName Specify the new name for the user function.

ForceRename Specify if the user function should always be renamed. This

parameter takes a Boolean value. If you specify ForceRename
as false, and the user function is used by another part this
method fails. If you specify ForceRename as true, and the
user function is used by another part, the user function is still
renamed.

Returns
None.

Related Links
AddUserFunction
CopyUserFunction
DeleteUserFunction
GetUserFunction
GetUserFunctionNames
UserFunctionDefn Class

Save

Syntax
Save()

Description
Use the Save method to save any changes to the analytic model definition to the database. If the saved
model is valid, the value of the IsValid property is set to true, if it is not valid, it is set to false.

The Messages property is populate with messages from the validation that occurs with the save.

Copyright © 1988, 2024, Oracle and/or its affiliates. 253

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters
None.

Returns
None.

Related Links
Create
Validate
IsValid
Messages

Validate

Syntax
Validate()

Description
Use the Validate method to validate the analytic model definition. This method returns true if the model
successfully validates. If this method returns false, the detailed error messages are available through the
Messages property.

The IsValid property is not set with this method. The Save method sets the IsValid property.

Parameters
None.

Returns
A Boolean value: true if the analytic model definition validates successfully, false otherwise.

Related Links
Create
Save
Messages
IsValid

AnalyticModelDefn Properties
The following section discusses the AnalyticModelDefn class properties. The properties are discussed in
alphabetical order.

254 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

CircularFormulaWarn

Description
Use this property to specify whether warnings occur when there are circular dependencies as rules are
added. This property takes a Boolean value: true if warnings should occur, false otherwise. The default
value for this property is false.

This property is read/write.

Description

Description
Use this property to specify the description of the analytic model. This property takes a string value.

This property is read/write.

IsValid

Description
This property indicates if the analytic model is valid, that is, if it would successfully load.

This property is read-only.

Related Links
Validate
Save
“Validating Analytic Models” (Analytic Calculation Engine)

LongDescription

Description
Use this property to specify the long description of the analytic model definition. This property takes a
string value.

This property is read/write.

MaxDelta

Description
This property specifies the maximum number of value changes for the analytic model

This property takes a float value. The default value is 0.

Copyright © 1988, 2024, Oracle and/or its affiliates. 255

Analytic Calculation Engine Metadata Classes Chapter 4

This property is read/write.

Related Links
“Understanding the Analytic Model Definition Creation Process” (Analytic Calculation Engine)

MaxIterations

Description
Use this property to specify the maximum number of iterations for the analytic model.

This property take an integer value. The default value is 100.

This property is read/write.

Related Links
Understanding the Analytic Calculation Engine Classes

Messages

Description
This property returns a multi-dimensional array of any that contains the messages that occurred during
execution of the Validate or Save methods. This array is only populated after the Validate or Save method
has completed successfully.

The first dimension contains the message set number. The second dimension contains the message
number. The third dimension contains the number of parameters in that message. The subsequent
dimensions contain the values for the parameters. The maximum number of possible dimensions is 8.

This property is read-only.

Related Links
Validate
Save

Name

Description
This property indicates the name of the analytic model.

This property is read-only.

Related Links
Rename

256 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

ResolveCircularDeps

Description
Use this property to specify if the analytic model should resolve circular dependencies through iteration.
This property takes a Boolean value: true if the dependencies should be resolved, false otherwise. The
default value is false.

This property is read/write.

DimensionDefn Class
Use the DimensionDefn class to access a dimension that's associated with an analytic model. You
instantiate an object of this class using the following AnalyticModelDefn methods:

• AddDimension

• CopyDimension

• GetDimension

DimensionDefn Class Properties

The following section discusses the DimensionDefn class properties. The properties are discussed in
alphabetical order.

AggregateSequence

Description
This property indicates the sequence number of this dimension used during aggregation of the analytic
model

This property is read-only..

AggregationUserFunction

Description
Use this property to specify the name of a user function that can be used to override the default
aggregation for this dimension.

This property is read/write.

Copyright © 1988, 2024, Oracle and/or its affiliates. 257

Analytic Calculation Engine Metadata Classes Chapter 4

Comments

Description
Use this property to specify additional notes about the dimension.

This property is read/write.

Name

Description
This property indicates the name of the dimension.

This property is read-only.

Related Links
GetDimensionNames
RenameDimension

TotalMemberName

Description
Use this property to specify a field value that is used at runtime to host the total value for this dimension.
If a total isn't applicable, this property has no value.

This property is read/write.

ExplicitDimensionSet Class
Use the ExplicitDimensionSet class to access an explicit dimension set associated with an analytic model.
You instantiate an object of this class using one of the following AnalyticModelDefn methods:

• AddExplicitDimensionSet

• CopyExplicitDimensionSet

• GetExplicitDimensionSet

You can also use the GetExplicitDimensionSetNames to return an array containing the names of all the
explicit dimension sets associated with the analytic model.

258 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

ExplicitDimensionSet Methods
The following section discusses the ExplicitDimensionSet class methods. The methods are discussed in
alphabetical order.

AttachDimension

Syntax
AttachDimension(DimName)

Description
Use the AttachDimension method to attach a dimension to an explicit dimension set.

Parameters

Parameter Description

DimName Specify the name of the dimension you want to attach.

Returns
None.

Related Links
DetachDimension

DetachDimension

Syntax
DetachDimension(DimName)

Description
Use the DetachDimension method to detach a dimension from an explicit dimension set.

Parameters

Parameter Description

DimName Specify the name of the dimension that you want to detach.

Copyright © 1988, 2024, Oracle and/or its affiliates. 259

Analytic Calculation Engine Metadata Classes Chapter 4

Returns
None.

Related Links
AttachDimension

GetDimensionNames

Syntax
GetDimensionNames()

Description
Use the GetDimensionNames method to return an array of string that contains the names of all the
dimensions associated with the ExplicitDimensionSet.

Parameters
None.

Returns
An array of string.

Related Links
AttachDimension
DetachDimension

ExplicitDimensionSet Properties
The following section discusses the ExplicitDimensionSet class properties. The properties are discussed
in alphabetical order.

Name

Description
The Name property returns the name of the explicit dimension set as a string.

This property is read-only.

260 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

SequenceNumber

Description
This property returns the sequence number of the explicit dimension set.

This property is read-only.

CubeDefn Class
Use the CubeDefn class to access a cube associated with an analytic model. You instantiate an object of
this class using the following AnalyticModelDefn methods:

• AddCubeDefn

• CopyCubeDefn

• GetCubeDefn

CubeDefn Class Methods

The following section discusses the CubeDefn class methods. The methods are discussed in alphabetical
order.

AttachDimension

Syntax
AttachDimension(DimName)

Description
Use the AttachDimension method to attach an existing dimension specified by DimName to the cube.

Parameters

Parameter Description

DimName Specify the name of the dimension that you want to add.

Returns
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 261

Analytic Calculation Engine Metadata Classes Chapter 4

Related Links
DetachDimension
GetDimensionNames
UsesDimension
AddDimension
DimensionDefn Class

DetachDimension

Syntax
DetatchDimension(DimName)

Description
Use the DetachDimension method to detach the dimension specified by DimName from the cube.

Parameters

Parameter Description

DimName Specify the name of the dimension that you want to detach
from the cube.

Returns
None.

Related Links
AttachDimension
GetDimensionNames
UsesDimension
AddDimension
DimensionDefn Class

GetCauses

Syntax
GetCauses(CauseType)

Description
Any cube that affects another cube is a cause of that cube. Use the GetCauses method to return a list of all
the other cubes that are the causes for this cube.

262 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

The cube names are returned in an array of string.

Parameters

Parameter Description

CauseType Specify the type of causes you want returned.

Value Description

AnalyticModel_DirectCauses Only return direct causes.

AnalyticModel_AllCauses Return all cubes that are causes for this cube, both direct and
indirect.

AnalyticModel_AllInputs Return all cubes that have input to this cube.

Returns
An array of string.

Related Links
GetEffects
GetCircularDeps
“Understanding Causes and Inputs” (Analytic Calculation Engine)

GetCircularDeps

Syntax
GetCircularDeps(DimName)

Description
Use the GetCircularDeps method to return all cubes that have circular dependencies based on the
dimension specified by DimName.

The cube names are returned in an array of string.

Copyright © 1988, 2024, Oracle and/or its affiliates. 263

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters

Parameter Description

DimName Specify the name of the dimension that you want to find
circular dependencies for.

Returns
An array of string.

Related Links
GetCauses
GetEffects

GetDimensionAggregate

Syntax
GetDimensionAggregate(DimName)

Description
Use the GetDimensionAggregate method to return the name of the user function used for the aggregate
for the dimension specified by DimName.

Parameters

Parameter Description

DimName Specify the name of the dimension that you want the aggregate
user function.

Returns
A string.

Related Links
SetDimensionAggregate
GetUserFunctionNames
UserFunctionDefn Class

264 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

GetEffects

Syntax
GetEffects(EffectType)

Description
Any cube that is affected by another cube is an effect of that cube. Use the GetEffects method to return a
list of all the cubes affected by this cube.

The list of cubes is returned as an array of string.

Parameters

Parameter Description

EffectType Specify the type of effects you want returned.

Value Description

AnalyticModel_DirectEffects Only return cubes that are a direct effect on this cube.

AnalyticModel_AllEffects Return all cubes that are an effect on this cube.

Returns
An array of string.

Related Links
GetCauses
GetCircularDeps
CubeDefn Class Properties

GetDimensionNames

Syntax
GetDimensionNames()

Description
Use the GetDimensionNames method to return an array of string containing the names of all the
dimensions associated with the cube.

Copyright © 1988, 2024, Oracle and/or its affiliates. 265

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters
None.

Returns
An array of string.

Related Links
AttachDimension
DetachDimension
Understanding Arrays

GetRule

Syntax
GetRule()

Description
Use the GetRule method to get a reference to a RuleDefn object that represents the rule for this cube.

Parameters
None.

Returns
A RuleDefn object.

Related Links
RuleDefn Class
SetRule

SetDimensionAggregate

Syntax
SetDimensionAggregate(DimName, UserFunctionName)

Description
Use the SetDimensionAggregate method to specify the user function to be used for the aggregate for the
dimension DimName.

266 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Parameters

Parameter Description

DimName Specify the name of the dimension for which you want to set
the aggregate.

UserFunctionName Specify the name of the user function to be used as the

aggregate function.

Returns
None.

Related Links
GetDimensionAggregate

SetRule

Syntax
SetRule(&RuleDefn)

Description
Use the SetRule method to specify a RuleDefn object to be used as the rule for this cube.

Parameters

Parameter Description

&RuleDefn Specify an already instantiated RuleDefn object that you want

to associate with this cube.

Returns
None.

Related Links
GetRule
RuleDefn Class

Copyright © 1988, 2024, Oracle and/or its affiliates. 267

Analytic Calculation Engine Metadata Classes Chapter 4

UsesDimension

Syntax
UsesDimension(DimName)

Description
Use the UsesDimension method to determine if the dimension specified by DimName is used by this
cube.

Parameters

Parameter Description

DimName Specify the name of the dimension that you want to check for.

Returns
A Boolean value: true if the dimension is used, false otherwise.

Related Links
AttachDimension
DetachDimension
GetDimensionNames

CubeDefn Class Properties

The following section discusses the CubeDefn class properties. The properties are discussed in
alphabetical order.

CalcAggregates

Description
Use this property to specify if the aggregate is calculated for this cube. This property takes a Boolean
value: true if the aggregate is calculated, false otherwise.

This property is read/write.

Comments

Description
Use this property to specify additional notes about the cube.

268 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

This property is read/write.

DimensionCount

Description
This property indicates the number of dimensions associated with this cube.

This property is read-only.

FormatType

Description
Use this property to specify the format of the cube. The values are:

Value Description

AnalyticModel_Format_Number The format is of type number.

AnalyticModel_Format_Date The format is of type date.

AnalyticModel_Format_ Member The format is of type member.

AnalyticModel_Format_Text The format is of type text.

This property is read/write.

IsVirtual

Description
Use this property to specify if the cube is a virtual cube, that is, if it doesn't store data. This property takes
a Boolean value: true if the cube is a virtual cube, false otherwise.

This property is read/write.

Name

Description
This property specifies the name of the cube.

This property is read-only.

Copyright © 1988, 2024, Oracle and/or its affiliates. 269

Analytic Calculation Engine Metadata Classes Chapter 4

ValueDimensionName

Description
Use this property to specify the dimension name for cubes that have a format of member.

This property is only valid when a cube has a format of member.

This property is read/write.

Related Links
FormatType
AnalyticModelDefn Properties

CubeCollectionDefn Class
Use the CubeCollectionDefn class to access cube collections associated with an analytic model. You
instantiate an object of this class using the following AnalyticModelDefn class methods:

• AddCubeCollection

• CopyCubeCollection

• GetCubeCollection

CubeCollectionDefn Class Methods

The following section discusses the CubeCollectionDefn class methods. The methods are discussed in
alphabetical order.

AttachCube

Syntax
AttachCube(CubeName)

Description
Use the AttachCube method to attach the existing cube specified by CubeName to the cube collection.

You should only specify cube collections comprised of derived/work records as the main record for a
presentation cube collection.

270 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Parameters

Parameter Description

CubeName Specify the name of the cube you want to attach.

Returns
None.

Related Links
DetachCube
GetCubeNames
CubeDefn Class

DetachCube

Syntax
DetachCube(CubeName)

Description
Use the DetachCube to detach the cube specified by CubeName from the cube collection.

Parameters

Parameter Description

CubeName Specify the name of the cube that you want to detach.

Returns
None.

Related Links
CubeDefn Class
GetCubeNames
CubeDefn Class

Copyright © 1988, 2024, Oracle and/or its affiliates. 271

Analytic Calculation Engine Metadata Classes Chapter 4

GetAggregateMapping

Syntax
GetAggregateMapping(PartName, IsCube)

Description
Use the GetAggregateMapping method to return the aggregate mapping field specified by the part
PartName.

Parameters

Parameter Description

PartName Specify the part name for which you want the aggregate
mapping field name.

IsCube Specify whether the part is a cube or not. This parameter takes
a Boolean value, true if the part is a cube, false otherwise.

Returns
A string.

Related Links
GetFieldMapping
GetPersistAggregate
SetAggregateMapping
SetFieldMapping
SetPersistAggregate

GetCubeNames

Syntax
GetCubeNames()

Description
Use the GetCubeNames method to return an array of strings containing all the names of the cubes
associated with this cube collection.

Parameters
None.

272 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Returns
An array of string.

Related Links
AddCube
CopyCube
DeleteCube
GetCube
RenameCube
CubeDefn Class
Understanding Arrays

GetDimensionNames

Syntax
GetDimensionNames()

Description
Use the GetDimensionNames method to return an array of string containing the names of all the
dimensions associated with the cube collection.

The dimension names are returned in an array of string.

Parameters
None.

Returns
An array of string.

Related Links
AttachDimension
DetachDimension
DimensionDefn Class

GetDimSort

Syntax
GetDimSort(DimensionName)

Copyright © 1988, 2024, Oracle and/or its affiliates. 273

Analytic Calculation Engine Metadata Classes Chapter 4

Description
Use the GetDimSort method return the sorting keys used for the dimension.

The sorting keys are returned as an array of any.

The first string is either true or false. If the first string is true it indicates that the dimension is sorted by
the names of the members in the dimension.

The second string then is either true or false, indicating whether the sort is ascending (or descending).
If the first string is false it indicates that the dimension is sorted by keys, which are the specified by the
other strings in the array. The keys are names of cubes. The strings are as follows:

• Ascend1

• CubeName1

• Ascend2

• CubeName2

• Ascend3

• CubeName3

Parameters

Parameter Description

DimensionName Specify the name of the dimension for which you want the
sorting keys.

Returns
An array of any.

Related Links
SetDimSort
GetDimSort
SetDimSort

GetFieldMapping

Syntax
GetFieldMapping(PartName, IsCube)

274 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Description
Use the GetFieldMapping method to return the name of the mapped field name for the part specified by
PartName.

Parameters

Parameter Description

PartName Specify the name of the part for which you want the mapped
field name.

IsCube Specify whether this part is a cube or not. This parameter takes
a Boolean value: true if the part is a cube, false otherwise.

Returns
A string.

Related Links
GetAggregateMapping
SetFieldMapping
SetAggregateMapping

GetFilter

Syntax
GetFilter(DimensionName)

Description
Use the GetFilter method to return the name of the user function used as a filter for the dimension
specified by DimensionName.

Parameters

Parameter Description

DimensionName Specify the name of the dimension for which you want the
filter name.

Returns
A string.

Copyright © 1988, 2024, Oracle and/or its affiliates. 275

Analytic Calculation Engine Metadata Classes Chapter 4

Related Links
SetAggregateMapping
“Filter User Functions” (Analytic Calculation Engine)

GetPersistAggregate

Syntax
GetPersistAggregate(DimensionName)

Description
Use the GetPersistAggregate method to return the value for the persist aggregate for the dimension
specified by DimensionName.

Parameters

Parameter Description

DimensionName Specify the name of the dimension for which you want to find
the persist aggregate value.

Returns
An integer, which is one of the following values:

Value Description

AnalyticModel_AggrType_Root The persist aggregate type is Root, that is, only the root node's
data is saved to the database.

AnalyticModel_AggrType_All The persist aggregate type is All, that is, save all of the
dimension's aggregate data to the database.

AnalyticModel_AggrType_ None The persist aggregate type is None, that is, do not save any of
the dimension's aggregate data to the database.

Related Links
GetAggregateMapping
GetFieldMapping
SetAggregateMapping
SetFieldMapping
SetPersistAggregate

276 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

SetAggregateMapping

Syntax
SetAggregateMapping(PartName, IsCube, AggregateFieldName)

Description
Use the SetAggregateMapping method to specify an aggregate field for the part specified by PartName.

You can map a field to only one data cube or dimension within one cube collection.

Parameters

Parameter Description

PartName Specify the name of the part for which you want to add an
aggregate field.

IsCube Specify whether the part is a cube. This parameter takes a

Boolean value, true if the part is a cube, false otherwise.

AggregateFieldName Specify the name of the field to be used to hold the aggregate
value.

Returns
A string containing the name of the field that contains the aggregate value.

Related Links
SetPersistAggregate
GetFieldMapping
GetPersistAggregate
SetFieldMapping
SetPersistAggregate

SetDimSort

Syntax
SetDimSort(DimName, IsAscending [, CubeName1, IsAscending2, CubeName2,
IsAscending3, CubeName3])

Description
Use the SetDimSort method to specify the sorting order for the dimension.

Copyright © 1988, 2024, Oracle and/or its affiliates. 277

Analytic Calculation Engine Metadata Classes Chapter 4

If CubeName1 is an empty string, the dimension is sorted by the names of the members of the dimension,
and the other parameters are not used.

If CubeName1 is not an empty string, the dimension is sorted by cubes, as specified by the other
parameters.

The Boolean parameter IsAscending defines whether sorting should be in ascending or descending order.
Up to three sort keys may be specified. CubeName1 is the primary sort key. CubeName2 is used to sub-
sort any members that have the same key value under CubeName1, and so on.

Parameters

Parameter Description

DimensionName Specify the name of the dimension that you would like to
specify a sort order for.

IsAscending Specify if the dimension should be sorted in ascending or

descending order. This parameter takes a Boolean value: true if
the sort should be ascending, false if it should be descending.

CubeName1 Specify whether the dimension is to be sorted by members or

by cubes. If the dimension is to be sorted by members, specify
a null string for this parameter. If the dimension is to be sorted
by cubes, specify a cube name.

IsAscending2 Specify if the sort for CubeName1 is in ascending or

descending order. This parameter takes a Boolean value: true if
the sort is ascending, false if its descending.

CubeName2 Specify the name of a cube to be used to sub-sort the primary

sort specified by CubeName1.

IsAscending3 Specify if the sort for CubeName2 is in ascending or

descending order. This parameter takes a Boolean value: true if
the sort is ascending, false if its descending.

CubeName3 Specify the name of a cube to be used to sub-sort the primary

sort specified by CubeName2.

Returns
None.

Related Links
SetPersistAggregate
GetDimSort

278 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

SetFieldMapping

Syntax
SetFieldMapping(PartName, FieldName, IsCube)

Description
Use the SetFieldMapping method to specify the name of the main field used for mapping the part
specified by PartName.

You can map a field to only one data cube or dimension within one cube collection.

Parameters

Parameter Description

PartName Specify the name of the part for which you want to assign a
mapping field.

FieldName Specify the name of the field to be used for the field mapping.

IsCube Specify whether or not the part is a cube. This parameter takes
a Boolean value: true if the part is a cube, false otherwise.

Returns
None.

Related Links
GetAggregateMapping
GetFieldMapping
GetPersistAggregate
SetAggregateMapping
SetPersistAggregate

SetFilter

Syntax
SetFilter(DimensionName, UserFunctionName)

Description
Use the SetFilter method to specify the user function to be used as a filter for the dimension specified by
DimensionName.

Copyright © 1988, 2024, Oracle and/or its affiliates. 279

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters

Parameter Description

DimensionName Specify the name of the dimension for which you want to set a
filter.

UserFunctionName Specify the name of a user function to be used as a filter for

this dimension.

Returns
None.

Related Links
GetFilter
“Filter User Functions” (Analytic Calculation Engine)

SetPersistAggregate

Syntax
SetPersistAggregate(DimensionName, AggregateType)

Description
Use the SetPersistAggregate to specify the value for the persist aggregate for the dimension specified by
DimensionName.

Parameters

Parameter Description

DimensionName Specify the name of the dimension for which you want to set
the persist aggregate.

AggregateType Specify the aggregate type. Values are:

Value Description

AnalyticModel_AggrType_Root The persist aggregate type is Root, that is, only the root node's
data is saved to the database.

AnalyticModel_AggrType_All The persist aggregate type is All, that is, save all of the
dimension's aggregate data to the database.

280 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Value Description

AnalyticModel_AggrType_ None The persist aggregate type is None, that is, do not save any of
the dimension's aggregate data to the database.

Returns
None.

Related Links
GetAggregateMapping
GetFieldMapping
GetPersistAggregate
SetAggregateMapping
SetFieldMapping

UsesCube

Syntax
UsesCube(CubeName)

Description
Use the UsesCube method to determine if the cube collection uses the cube specified by CubeName.

Parameters

Parameter Description

CubeName Specify the name of the cube that you want to verify.

Returns
A Boolean value, true if the specified cube is part of the cube collection, false otherwise.

Related Links
AttachCube
DetachCube
GetCubeNames
CubeDefn Class

Copyright © 1988, 2024, Oracle and/or its affiliates. 281

Analytic Calculation Engine Metadata Classes Chapter 4

UsesDimension

Syntax
UsesDimension(DimensionName)

Description
Use the UsesDimension method to determine if the cube collection uses the dimension specified by
DimensionName.

Parameters

Parameter Description

DimensionName Specify the name of the dimension that you want to verify.

Returns
A Boolean value: true if the dimension is part of the cube collection, false otherwise.

Related Links
CubeDefn Class
DimensionDefn Class

CubeCollectionDefn Class Properties

The following section discusses the CubeCollectionDefn class properties. The properties are discussed in
alphabetical order.

AggregateRecName

Description
Use this property to specify the name of the aggregate record associated with this cube collection. This
property takes a string value.

This property is read/write.

Comments

Description
Use this property to specify additional notes about the cube collection.

282 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

This property is read/write.

CubeCount

Description
This property returns the number of cubes in the cube collection.

This property is read-only.

DimensionCount

Description
This property returns the number of dimensions associated with this cube collection.

This property is read-only.

Name

Description
This property returns the name of the cube collection as a string.

This property is read-only.

RecordName

Description
Use this property to specify the name of the main record associated with the cube collection. This
property takes a string value.

This property is read/write.

UserFunctionDefn Class
Use the UserFunctionDefn class to access the user functions that are associated with an analytic model.
You instantiate an object of this class using the following AnalyticModelDefn class methods:

• AddUserFunction

• CopyUserFunction

• GetUserFunction

Copyright © 1988, 2024, Oracle and/or its affiliates. 283

Analytic Calculation Engine Metadata Classes Chapter 4

UserFunctionDefn Class Methods

In this section we discuss the UserFunctionDefn class methods. They are described in alphabetical order.

GetRule

Syntax
GetRule()

Description
Use the GetRule method to return a RuleDefn object that represents the rule associated with this user
function.

Parameters
None.

Returns
A RuleDefn object.

Related Links
RuleDefn Class

SetRule

Syntax
SetRule(&Rule)

Description
Use the SetRule method to specify a rule defined by a RuleDefn object to be the rule for this user
function.

Parameters

Parameter Description

&Rule Specify an already instantiated RuleDefn object that you want

to use as the rule for this user function.

284 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Returns
None.

UserFunctionDefn Class Properties

The following section discusses the UserFunctionDefn class properties. The properties are discussed in
alphabetical order.

Comments

Description
Use this property to specify additional notes about the user function.

This property is read/write.

Name

Description
This property specifies the name of the user function.

This property is read-only.

OrganizerDefn Class
Use the OrganizerDefn class to access the organizers that are associated with an analytic model. You
instantiate an object of this class using the following AnalyticModelDefn class methods:

• AddOrganizer

• CopyOrganizer

• GetOrganizer

OrganizerDefn Class Methods

The following section discusses the OrganizerDefn class methods. The methods are discussed in
alphabetical order.

Copyright © 1988, 2024, Oracle and/or its affiliates. 285

Analytic Calculation Engine Metadata Classes Chapter 4

AttachPart

Syntax
AttachPart(PartName, PartType)

Description
Use the AttachPart method to attach the part specified by PartName to the organizer. The part must exist
in the analytic model.

Parameters

Parameter Description

PartName Specify the name of the part that you want to attach.

PartType Specify the type of part that you want to attach. Values are:

Value Description

AnalyticModel_Dimension Attach a dimension.

AnalyticModel_Cube Attach a cube.

AnalyticModel_ CubeCollection Attach a cube collection.

AnalyticModel_UserFunction Attach a user function.

Returns
None.

Related Links
DetachPart
GetPartNames
UsesPart

DetachPart

Syntax
DetachPart(PartName, PartType)

286 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Description
Use the DetachPart method to detach the part specified by PartName from the organizer.

Parameters

Parameter Description

PartName Specify the name of the part that you want to detach.

PartType Specify the type of the part that you want to detach. Valid
values are:

Value Description

AnalyticModel_Dimension Detach a dimension.

AnalyticModel_Cube Detach a cube.

AnalyticModel_ CubeCollection Detach a cube collection.

AnalyticModel_UserFunction Detach a user function.

Returns
None.

Related Links
AttachPart
GetPartNames
UsesPart

GetPartNames

Syntax
GetPartNames()

Description
Use the GetPartNames method to return a list of the names of the parts used by the organizer. The names
are returned as an array of string.

Copyright © 1988, 2024, Oracle and/or its affiliates. 287

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters
None.

Returns
An array of string.

Related Links
AttachPart
DetachPart
UsesPart

UsesPart

Syntax
UsesPart(PartName, PartType)

Description
Use the UsesPart method to determine if the organizer uses the part specified by PartName.

Parameters

Parameter Description

PartName Specify the name of the part that you want to verify.

PartType Specify the type of the part that you want to verify. Valid
values are:

Value Description

AnalyticModel_Dimension A dimension.

AnalyticModel_Cube A cube.

AnalyticModel_ CubeCollection A cube collection.

AnalyticModel_UserFunction A user function.

Returns
A Boolean value: true if the part is associated with the organizer, false otherwise.

288 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Related Links
AttachPart
DetachPart
GetPartNames

OrganizerDefn Class Properties

The following section discusses the OrganizerDefn class properties. The properties are discussed in
alphabetical order.

Comments

Description
Use this property to specify additional notes about the organizer.

This property is read/write.

Name

Description
This property specifies the name of the organizer.

This property is read-only.

RuleDefn Class
Use the RuleDefn class to access a rule that is associated with an analytic model. You instantiate an object
of this class using the GetRule method for both the CubeDefn and UserFunctionDefn classes.

RuleDefn Class Methods

In this section, we discuss the RuleDefn class methods. The methods are described in alphabetical order.

AddRuleExpression

Syntax
AddRuleExpression(&Expr)

Copyright © 1988, 2024, Oracle and/or its affiliates. 289

Analytic Calculation Engine Metadata Classes Chapter 4

Description
Use the AddRuleExpression method to add a rule expression to the rule. Use the classes in the
RuleExpression subpackage to create the expression specified by &Expr.

After you have finished adding rule expressions to the rule, you need to use the GenerateRule method to
generate the rule.

Parameters

Parameter Description

&Expr Specify the rule expression that you want added to the rule
definition.

Returns
None.

Related Links
GenerateRule
RuleExpressions Classes

GenerateRule

Syntax
GenerateRule()

Description
Use the GenerateRule method to create the rule string for the rule that represents the current rule
expressions that have been added using AddRuleExpression.

Parameters
None.

Returns
None.

Related Links
AddRuleExpression
RuleExpressions Classes

290 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

RuleDefn Class Property

The following describes the RuleDefn class property.

RuleString

Description
This property specifies a string representation of the rule.

After the rule is returned using the GetRule method, this string represents the existing rule cube or user
function.

After AddRuleExpression and GenerateRule are called, this is the string representation of the rule.

This property is read-only.

RuleExpressions Classes
The RuleExpressions classes represents the different parts of the analytic calculation engine rule grammar.
These objects are created using the Create built-in function and the constructor for that class, then added
to the RuleDefn object with the AddRuleExpression method.

The following are the RuleExpressions classes:

• Assignment

• Comparison

• Constant

• Constants

• Cube

• ExpressionBlock

• FunctionCall

• MemberReference

• Operation

• RuleExpression

• Variable

Note: The RuleExpression object is the object that the other objects are derived from. You should not
create or use this object directly.

Copyright © 1988, 2024, Oracle and/or its affiliates. 291

Analytic Calculation Engine Metadata Classes Chapter 4

Using the Constants Class

All of the constants used with the RuleExpression classes, such as FunctionCall, comparison, operation,
and so on, are actually properties of the constants class. You must always instantiate an object of the
constants class to use any constants in your program.

For example, the comparison class uses a constant to test whether two operands are equal. Use the
following code to create a comparison testing this:
&Comparison = create Comparison(&Constants.Comparison_Type_Equal);

All of the properties for the constants class are listed with the classes that use them.

Assignment Class
An assignment object represents an assignment statement in an analytic calculation rule.

Use the following to create an assignment object:

&Assignment = create Assignment();

Assignment Class Method

The following is the method for the assignment class.

GenerateRule

Syntax
GenerateRule()

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Returns
A string.

Related Links
AddRuleExpression

292 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

RuleExpressions Classes

Assignment Class Properties

In this section we discuss the assignment class properties. The properties are described in alphabetical
order.

Expression

Description
Use the Expression property to specify the right-hand side of the assignment statement.

This property is read/write.

Variable

Description
Use the Variable property to specify the left-hand side of the assignment statement.

This property is read/write.

Comparison Class
A comparison object represents a comparison statement in an analytic calculation rule.

Use the following to create a comparison class object:

&Comparison = create Comparison(&Constants.Comparison_Type);

Where Comparison_Type is one of the following:

Value Description

Comparison_Type_Equal Compare if the value of Operand1 equals Operand2.

Comparison_Type_Greater Compare if the value of Operand1 is greater than the value of

Operand2.

Comparison_Type_Less Compare if the value of Operand1 is less than the value of

Operand2.

Comparison_Type_GreaterEq Compare if the value of Operand1 is greater or equal to the

value of Operand2.

Copyright © 1988, 2024, Oracle and/or its affiliates. 293

Analytic Calculation Engine Metadata Classes Chapter 4

Value Description

Comparison_Type_LessEq Compare if the value of Operand1 is less than or equal to the

value of Operand2.

Comparison_Type_NotEq Compare if the value of Operand1 is not equal to the value of

Operand2.

Specify Operand1 and Operand2 with the Operand1 and Operand2 comparison class properties.

The following code example creates a rule that compares if the first operand is greater than or equal to the
second operand, then adds the rule using the AddArgument method.
&Comparison = create Comparison(&Constants.Comparison_Type_GreaterEq);
&Constant = create Constant(&Constants.Constant_Type_Literal, "1000");
&Comparison.Operand1 = &Constant;
&Constant = create Constant(&Constants.Constant_Type_Literal, "100");
&Comparison.Operand2 = &Constant;
&FunCall.AddArgument(&Comparison);

Comparison Class Method

The following is the comparison class method.

GenerateRule

Syntax
GenerateRule()

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Returns
A string.

Related Links
AddRuleExpression
RuleExpressions Classes

294 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Comparison Class Properties

In this section we discuss the comparison class properties. The properties are described in alphabetical
order.

Operand1

Description
Use this property to specify the RuleExpression object that is the first operand to be used in the
comparison.

This property is read/write.

Operand2

Description
Use this property to specify the RuleExpression object that is the second operand to be used in the
comparison.

This property is read/write.

Type

Description
This property returns the type of the comparison that was used to instantiate the comparison object.

The values are:

Value Description

Comparison_Type_Equal Compare if the value of Operand1 equals Operand2.

Comparison_Type_Greater Compare if the value of Operand1 is greater than the value of

Operand2.

Comparison_Type_Less Compare if the value of Operand1 is less than the value of

Operand2.

Comparison_Type_GreaterEq Compare if the value of Operand1 is greater than or equal to

the value of Operand2.

Comparison_Type_LessEq Compare if the value of Operand1 is less than or equal to the

value of Operand2.

Copyright © 1988, 2024, Oracle and/or its affiliates. 295

Analytic Calculation Engine Metadata Classes Chapter 4

Value Description

Comparison_Type_NotEq Compare if the value of Operand1 is not equal to the value of

Operand1.

This property is read-only.

Constant Class
A constant object represents a constant statement in an analytic calculation rule.

Note: This is not the same as the constants class.

A constant object exposes all the constants that are passed to the constructors of the various
RuleExpression objects.

Use the following to create a constant class object:

&Constant = create Constant(&Constants.Constant_Type, [&Constants.]Constant_Value);

where Constant_Type is one of the following:

Value Description

Constant_Type_Builtin The Constant_Value is an analytic calculation engine built-in

function. In this instance, the constant value must be prefaced
with an already instantiated constants object. For possible
values, see below.

Constant_Type_Number The Constant_Value is a number.

Constant_Type_Literal The Constant_Value is a string.

When the Constant_Type is Constant_Type_Builtin, the Constant_Value is one of the following:

• Constant_Builtin_ALL

• Constant_Builtin_BASE_E

• Constant_Builtin_DEFAULT

• Constant_Builtin_DETAILS

• Constant_Builtin_DIRECT

• Constant_Builtin_FALSE

• Constant_Builtin_FORWARD

• Constant_Builtin_PI

296 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

• Constant_Builtin_REVERSE

• Constant_Builtin_TRUE

The following code creates a PeopleSoft Analytic Calculation Engine built-in function to be used as a
constant:
&Constant = create Constant(&Constants.Constant_Type_Builtin, &Constants.Constan⇒

t_Builtin_REVERSE);

The following code creates a literal (string) constant:

&Constant = create Constant(&Constants.Constant_Type_Literal, "GENERAL");

The following code creates a number constant:

&Constant = create Constant(&Constants.Constant_Type_Number, "-1");

Constant Class Method

The following is the constant class method.

GenerateRule

Syntax
GenerateRule()

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Returns
A string.

Constant Class Properties

In this section we discuss the constant class properties. The properties are described in alphabetical order.

Copyright © 1988, 2024, Oracle and/or its affiliates. 297

Analytic Calculation Engine Metadata Classes Chapter 4

Type

Description
This property returns the value of the Constant Type that was used to instantiate the constant class object.

This property is read-only.

Related Links
Constant Class

Value

Description
This property returns the value of the Constant Value that was used to instantiate the constant class object.

This property is read-only.

Related Links
Constant Class

Constants Class
All of the constants used with the RuleExpression classes, such as FunctionCall, comparison, operation,
and so on, are actually properties of the constants class. You must always instantiate an object of the
constants class to use any constants in your program.

For example, the comparison class uses a constant to test whether two operands are equal. Use the
following code to create a comparison testing this:
&Comparison = create Comparison(&Constants.Comparison_Type_Equal);

All of the properties for the constants class are listed with the classes that use them.

Cube Class
A cube object represents a cube statement in an analytic calculate engine rule.

Use the following to create a cube object.

&Assignment = create Cube("CubeName");

298 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Cube Class Methods

In the following section, we discuss the cube class methods. The methods are described in alphabetical
order.

AddIndex

Syntax
AddIndex(&MemberReference)

Description
Use the AddIndex method to add a MemberReference object to the cube.

Parameters

Parameter Description

&MemberReference Specify an already instantiated MemberReference object to be

added to the cube.

Returns
None.

Related Links
MemberReference Class

GenerateRule

Syntax
GenerateRule()

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 299

Analytic Calculation Engine Metadata Classes Chapter 4

Returns
A string.

GetIndexes

Syntax
GetIndexes()

Description
Use the GetIndexes method to return an array of MemberReference’s (indexes) for this cube. These
MemberReferences are the MemberReferences that were added with the AddIndex method.

Parameters
None.

Returns
An array of MemberReference objects.

Related Links
MemberReference Class
AddIndex

Cube Class Property

The following is the cube class property.

Name

Description
This property indicates the name of the cube that was used to instantiate the cube object.

This property is read-only.

ExpressionBlock Class
For some function, you need multi-statement nested expressions. You need to use the ExpressionBlock
class to group these expressions. For example, all the statements inside of a FOR statement should be
included in an expression block.
FOR(&Index, 1, PERIOD,

300 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

SET(&Value, &Value + 1);

SET(&countPl4, &countPl4 + 4);
);

Use the following code to create an ExpressionBlock object:

&ExpressionBlock = create ExpressionBlock();

ExpressionBlock Methods
In the following section we discuss the ExpressionBlock class methods. The methods are described in
alphabetical order.

AddRuleExpression

Syntax
AddRuleExpression(&Expr)

Description
Use the AddRuleExpression method to add an expression to the expression block and the rule. Use the
classes in the RuleExpression subpackage to create the expression specified by &Expr.

Note: As the rule string is generated, the system adds a ";" after each RuleExpression, except the last.

Parameters

Parameter Description

&Expr Specify the rule expression that you want added to the
expression block.

Returns
None.

GetRuleExpressions

Syntax
GetRuleExpressions()

Description
Use the GetRuleExpressions to return an array of rule expression objects that have been added using the
AddRuleExpression method.

Copyright © 1988, 2024, Oracle and/or its affiliates. 301

Analytic Calculation Engine Metadata Classes Chapter 4

Parameters
None.

Returns
An array of RuleExpression objects.

FunctionCall Class
A FunctionCall object represents a function call statement in an analytic calculation engine rule.

Use the following code to create a FunctionCall object:

&Assignment = create FunctionCall(&Constants.Function_Call_Type, [&Constants.]Funct⇒

ion_Call_Name);

Where Function_Call_Type can be one of the following:

Value Description

FunctionCall_Type_Builtin Specifies that the function call is a PeopleSoft Analytic

Calculation Engine built-in functions. In this instance, the
function name must be prefaced with an already instantiated
constants object. For the built-in function values used with
Function_Call_Name, see below.

FunctionCall_Type_UserFunc Specifies that the function call is a user function. The value
specified for Function_Call_Name must be an already created
user function defined in this analytic model. Specify this value
as a string.

When the Function_Call_Type is specified as Function_Call_Type_Builtin, the Function_Call_Name

must be one of the following:

• FunctionCall_Builtin_ABS

• FunctionCall_Builtin_ACOS

• FunctionCall_Builtin_ARGUMENTS

• FunctionCall_Builtin_ASC

• FunctionCall_Builtin_ASIN

• FunctionCall_Builtin_AT

• FunctionCall_Builtin_ATAN

• FunctionCall_Builtin_BREAK

• FunctionCall_Builtin_CASE

302 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

• FunctionCall_Builtin_CHANGE

• FunctionCall_Builtin_CHILDCOUNT

• FunctionCall_Builtin_CHR

• FunctionCall_Builtin_CONSOL

• FunctionCall_Builtin_COS

• FunctionCall_Builtin_CUBEID

• FunctionCall_Builtin_CUBSUM

• FunctionCall_Builtin_CUMAVG

• FunctionCall_Builtin_DAVG

• FunctionCall_Builtin_DAY

• FunctionCall_Builtin_DCOUNT

• FunctionCall_Builtin_DDB

• FunctionCall_Builtin_DEC

• FunctionCall_Builtin_DLOOKUP

• FunctionCall_Builtin_DMAX

• FunctionCall_Builtin_DMIN

• FunctionCall_Builtin_DSUM

• FunctionCall_Builtin_E

• FunctionCall_Builtin_FIRST

• FunctionCall_Builtin_FOR

• FunctionCall_Builtin_FORCHILDREN

• FunctionCall_Builtin_FORMEMBERS

• FunctionCall_Builtin_FV

• FunctionCall_Builtin_GROUPAVG

• FunctionCall_Builtin_GROUPBY

• FunctionCall_Builtin_GROUPMAX

• FunctionCall_Builtin_GROUPMIN

• FunctionCall_Builtin_GROUPSUM

• FunctionCall_Builtin_GROW

Copyright © 1988, 2024, Oracle and/or its affiliates. 303

Analytic Calculation Engine Metadata Classes Chapter 4

• FunctionCall_Builtin_IF

• FunctionCall_Builtin_IFNPV

• FunctionCall_Builtin_INC

• FunctionCall_Builtin_INDICATE

• FunctionCall_Builtin_INPUT

• FunctionCall_Builtin_INSUBTREE

• FunctionCall_Builtin_INTERCEPT

• FunctionCall_Builtin_IRR

• FunctionCall_Builtin_ISINPUT

• FunctionCall_Builtin_LEFT

• FunctionCall_Builtin_LEN

• FunctionCall_Builtin_LN

• FunctionCall_Builtin_LOWER

• FunctionCall_Builtin_MATCH

• FunctionCall_Builtin_MAX

• FunctionCall_Builtin_MBR2TEXT

• FunctionCall_Builtin_MEDIAN

• FunctionCall_Builtin_MEMBER

• FunctionCall_Builtin_MID

• FunctionCall_Builtin_MIN

• FunctionCall_Builtin_MOD

• FunctionCall_Builtin_MONTH

• FunctionCall_Builtin_NEXT

• FunctionCall_Builtin_NPER

• FunctionCall_Builtin_NUM2TEXT

• FunctionCall_Builtin_NUMMEMBERS

• FunctionCall_Builtin_NPV

• FunctionCall_Builtin_PARAMETER

• FunctionCall_Builtin_PARENT

304 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

• FunctionCall_Builtin_PCT

• FunctionCall_Builtin_PERCENTILE

• FunctionCall_Builtin_PI

• FunctionCall_Builtin_PMT

• FunctionCall_Builtin_PREV

• FunctionCall_Builtin_PREVSELF

• FunctionCall_Builtin_PV

• FunctionCall_Builtin_QUARTILE

• FunctionCall_Builtin_RAND

• FunctionCall_Builtin_RATE

• FunctionCall_Builtin_REPLACE

• FunctionCall_Builtin_RETURN

• FunctionCall_Builtin_RIGHT

• FunctionCall_Builtin_ROUND

• FunctionCall_Builtin_SELF

• FunctionCall_Builtin_SET

• FunctionCall_Builtin_SIN

• FunctionCall_Builtin_SLN

• FunctionCall_Builtin_SLOPE

• FunctionCall_Builtin_SQRT

• FunctionCall_Builtin_STDEV

• FunctionCall_Builtin_SYD

• FunctionCall_Builtin_TAN

• FunctionCall_Builtin_TEXT2MBR

• FunctionCall_Builtin_TEXT2NUM

• FunctionCall_Builtin_THIS

• FunctionCall_Builtin_THISCUBE

• FunctionCall_Builtin_TRUNC

• FunctionCall_Builtin_UPPER

Copyright © 1988, 2024, Oracle and/or its affiliates. 305

Analytic Calculation Engine Metadata Classes Chapter 4

• FunctionCall_Builtin_VAR

• FunctionCall_Builtin_WHILE

• FunctionCall_Builtin_YEAR

The following code creates a function call using a PeopleSoft Analytic Calculation Engine built-in
function:
&FunCall = create FunctionCall(&Constants.FuncCall_Type_Builtin, &Constants.FuncCal⇒

l_Builtin_ABS);

Related Links
“Built-in Function Reference” (Analytic Calculation Engine)

FunctionCall Class Methods

In this section we discuss the FunctionCall class methods. The methods are described in alphabetical
order.

AddArgument

Syntax
AddArgument(&RuleExpression)

Description
Use the AddArgument method to add an argument to this function call.

Parameters

Parameter Description

&RuleExpression Specify an already instantiated rule expression object, such as

a cube object.

Returns
None.

GenerateRule

Syntax
GenerateRule()

306 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Returns
A string.

GetArguments

Syntax
GetArguments()

Description
Use the GetArguments method to return an array of RuleExpression objects associated with this
FunctionCall. These are the RuleExpression objects that were added using the AddArgument method.

Parameters
None.

Returns
An array of RuleExpression objects.

Related Links
AddArgument

FunctionCall Class Properties

In this section we discuss the FunctionCall class properties. The properties are described in alphabetical
order.

Name

Description
This property specifies the name of the function call used to instantiate the FunctionCall object.

Copyright © 1988, 2024, Oracle and/or its affiliates. 307

Analytic Calculation Engine Metadata Classes Chapter 4

This property is read-only.

Type

Description
This property specifies the type of the function call used to instantiate the FunctionCall object.

This property is read-only.

MemberReference Class
A MemberReference object represents a member in an analytic calculation engine rule.

Use the following code to create a MemberReference object:

&Member = create MemberReference(DimensionName, MemberName);

MemberReference Class Method

This section discusses the MemberReference class method.

GenerateRule

Syntax
GenerateRule()

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Returns
A string.

308 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

MemberReference Class Properties

In this section we discuss MemberReference class properties. The properties are described in alphabetical
order.

Dimension

Description
This property specifies the name of the dimension used to create the MemberReference object.

This property is read-only.

Member

Description
This property specifies the name of the member used to create the MemberReference object.

This property is read-only.

Operation Class
An operation object represents an operation in an analytic calculation engine rule. The operation is
generally some type of mathematical function performed between two operands. Specify the operands for
the operation using the Operand1 and Operand2 operation class properties.

Use the following code to create an operation object:

&Comparison = create Operation(&Constants.Operation_Type);

Where Operation_Type has a value of one of the following:

Value Description

Operation_Type_Plus The operation is addition.

Operation_Type_Minus The operation is subtraction.

Operation_Type_Mult The operation is multiplication.

Operation_Type_Div The operation is division.

Operation_Type_And Use a logical AND with the operation.

Copyright © 1988, 2024, Oracle and/or its affiliates. 309

Analytic Calculation Engine Metadata Classes Chapter 4

Value Description

Operation_Type_Or Use a logical OR with the operation.

Operation_Type_Not Use a logical NOT with the operation.

Operation_Type_Neg Use a mathematical negate with the operation.

Operation_Type_Exp Use a mathematical exponent with the operation.

The following code creates an operations that is a multiplication between two operands.
&operation = create Operation(&Constants.Operation_Type_Mult);
&Constant = create Constant(&Constants.Constant_Type_Literal, "PI");
&operation.Operand1 = &Constant;
&Constant = create Constant(&Constants.Constant_Type_Literal, "SLOPE");
&operation.Operand2 = &Constant;
&FunCall.AddArgument(&operation);

Operation Class Method

The following is the operation class method.

GenerateRule

Syntax
GenerateRule()

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Returns
A string.

310 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Operation Class Properties

In this section we discuss the operation class properties. The properties are described in alphabetical
order.

Operand1

Description
Use this property to specify the RuleExpression object that is the first operand to be used in the operation.

This property is read/write.

Operand2

Description
Use this property to specify the RuleExpression object that is the second operand to be used in the
operation.

This property is read/write.

Type

Description
This property returns the type of the operation used to instantiate the operation object.

The values for this property are:

Value Description

Operation_Type_Plus The operation is addition.

Operation_Type_Minus The operation is subtraction.

Operation_Type_Mult The operation is multiplication.

Operation_Type_Div The operation is division.

Operation_Type_And Use a logical AND for the operation.

Operation_Type_OR Use a logical OR for the operation.

Copyright © 1988, 2024, Oracle and/or its affiliates. 311

Analytic Calculation Engine Metadata Classes Chapter 4

Value Description

Operation_Type_Not Use a logical NOT for the operation.

Operation_Type_Neg Use a mathematical negate for the operation.

Operation_Type_Exp Use a mathematical exponent for the operation.

Variable Class
A variable object represents a variable in an analytic calculation engine rule.

Use the following code to create a variable object:

&Variable = create Variable(&Constants.Variable_Type, "Variable_Name");

Where Variable_Type is one of the following:

Value Description

Variable_Type_Auto Use a local variable.

Variable_Type_Expression The variable is in an expression. Specify an already

instantiated rule expression object for the Variable_Name.

Variable_Type_Dimension The variable is a dimension name. Specify a dimension name

for the Variable_Name.

The following code example creates a variable, then adds it to the rule.
&Variable = create Variable(&Constants.Variable_Type_Auto, "StartVal");
&FunCall.AddArgument(&Variable);

Variable Class Method

The following is the variable class method.

GenerateRule

Syntax
GenerateRule()

312 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

Description
Use the GenerateRule method to return a string that contains the rule for this object.

Generally you wouldn’t use this method on the individual RuleExpression objects, but instead would use
the GenerateRule method on the RuleDefn object.

Parameters
None.

Returns
A string.

Variable Class Properties

In this section we discuss the variable class properties. The properties are described in alphabetical order.

Name

Description
This property specifies the name of the variable that was used to create the variable object, passed in the
constructor.

This property is read-only.

Type

Description
This property specifies the type of the variable, passed in the constructor. The possible values are:

Value Description

Variable_Type_Auto A local variable.

Variable_Type_Expression The variable is an expression. Specify an already instantiated

rule expression object for the Variable_Name.

Variable_Type_Dimension The variable is a dimension name. Specify a dimension name

for the Variable_Name.

This property is read-only.

Copyright © 1988, 2024, Oracle and/or its affiliates. 313

Analytic Calculation Engine Metadata Classes Chapter 4

Analytic Model Metadata Classes Examples

The following are some examples of the most general cases of using the Analytic Model Metadata
classes.

Creating an Analytic Model Code Example

The following code creates an analytic model definition “from scratch” without retrieving an existing
definition from the Application Designer, adds parts such as dimensions, cubes, and cube collections, then
saves the definition.
import PT_ANALYTICMODELDEFN:*;

Function CreateGENXModel

Local PT_ANALYTICMODELDEFN:AnalyticModelDefn &Model;

Local PT_ANALYTICMODELDEFN:UserFunctionDefn &UserFunc;
Local PT_ANALYTICMODELDEFN:DimensionDefn &Dim;
Local PT_ANALYTICMODELDEFN:CubeDefn &Cube;
Local PT_ANALYTICMODELDEFN:CubeCollectionDefn &CubeColl;
Local array of string &arr;

&ACEMODELID = QE_ACE_META_WK.QE_ACE_MODELID.Value;

&Model = create PT_ANALYTICMODELDEFN:AnalyticModelDefn(&ACEMODELID);

&Model.Create();

/* Model Properties */

&Model.Description = QE_ACE_META_WK.DESCR;
&Model.LongDescription = QE_ACE_META_WK.DESCR200;
&Model.MaxDelta = QE_ACE_META_WK.QE_ACE_MAXDELTA_FL;
&Model.MaxIterations = QE_ACE_META_WK.QE_ACE_MAXITER_FLD;

If (QE_ACE_META_WK.QE_ACE_CIRCWARN_FL.Value = 0) Then
&Circ = True;
Else
&Circ = False;
End-If;

If (QE_ACE_META_WK.QE_ACE_RESOLVE_FLD.Value = 0) Then
&Resolve = True;
Else
&Resolve = False;
End-If;

&Model.ResolveCircularDeps = &Resolve;
&Model.CircularFormulaWarn = &Circ;

/* Add User Functions */

&UserFunction = &Model.AddUserFunction("FILTERPRODUCTS");
&Rule = &UserFunction.GetRule();
&Rule.RuleString = "IF( ((UNIT_COST = 0) .AND. (UNITS_SOLD = 0) .AND. (PROD_SALE⇒

S =0 )) , RETURN(0), RETURN(1))";
&UserFunction.SetRule(&Rule);

/* Add the Dimensions */

&Dim = &Model.AddDimension("MONTH");

314 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 4 Analytic Calculation Engine Metadata Classes

&Dim = &Model.AddDimension("PRODUCTS");
&Dim.TotalMemberName = "TOTAL";

&Dim = &Model.AddDimension("PROD_CAT");

&Dim = &Model.AddDimension("REGION");

/* Add the cubes */

&Cube = &Model.AddCube("PROD_SALES");
&Cube.FormatType = &Cube.AnalyticModel_Format_Number;
&Cube.IsVirtual = False;
&Cube.CalcAggregates = False;
&Cube.Rule = "UNIT_COST * UNITS_SOLD";
&Cube.AttachDimension("MONTH");
&Cube.AttachDimension("PRODUCTS");
&Cube.AttachDimension("REGION");

&Cube = &Model.AddCube("SALES");
&Cube.FormatType = &Cube.AnalyticModel_Format_Number;
&Cube.IsVirtual = False;
&Cube.CalcAggregates = False;

&Cube = &Model.AddCube("TGT_COST");
&Cube.FormatType = &Cube.AnalyticModel_Format_Number;
&Cube.IsVirtual = False;
&Cube.CalcAggregates = False;
&Cube.AttachDimension("PRODUCTS");

&Cube = &Model.AddCube("UNITS_SOLD");
&Cube.FormatType = &Cube.AnalyticModel_Format_Number;
&Cube.IsVirtual = False;
&Cube.CalcAggregates = False;
&Cube.AttachDimension("MONTH");
&Cube.AttachDimension("PRODUCTS");
&Cube.AttachDimension("REGION");

&Cube = &Model.AddCube("UNIT_COST");
&Cube.FormatType = &Cube.AnalyticModel_Format_Number;
&Cube.IsVirtual = False;
&Cube.CalcAggregates = False;
&Cube.AttachDimension("MONTH");
&Cube.AttachDimension("PRODUCTS");
&Cube.AttachDimension("REGION");

/* Add Cube Collections */

&CubeColl = &Model.AddCubeCollection("REG_SALES_IN");
&CubeColl.RecordName = "QE_BAM_FACT_TBL";
&CubeColl.AttachCube("PROD_SALES");
&CubeColl.AttachCube("UNITS_SOLD");
&CubeColl.AttachCube("UNIT_COST");
&CubeColl.SetFieldMapping("MONTH", "QE_BAM_MONTH_FLD", False);
&CubeColl.SetPersistAggregate("MONTH", &CubeColl.AnalyticModel_AggrType_None);
&CubeColl.SetDimSort("MONTH", False, "", False, "", False, "");
&CubeColl.SetFieldMapping("PRODUCTS", "QE_BAM_PRODUCT_FLD", False);
&CubeColl.SetPersistAggregate("PRODUCTS", &CubeColl.AnalyticModel_AggrType_None)⇒

;
&CubeColl.SetDimSort("PRODUCTS", False, "", False, "", False, "");
&CubeColl.SetFieldMapping("REGION", "QE_BAM_REGION_FLD", False);
&CubeColl.SetPersistAggregate("REGION", &CubeColl.AnalyticModel_AggrType_None);
&CubeColl.SetDimSort("REGION", False, "", False, "", False, "");
&CubeColl.SetFieldMapping("PROD_SALES", "QE_BAM_PRDSALES_FL", True);
&CubeColl.SetFieldMapping("UNITS_SOLD", "QE_BAM_SALES_FLD", True);
&CubeColl.SetFieldMapping("UNIT_COST", "QE_BAM_UNIT_FLD", True);

&CubeColl = &Model.AddCubeCollection("REG_SALES_PROD");
&CubeColl.RecordName = "QE_BAM_CCSMOKE";
&CubeColl.AttachCube("PROD_SALES");
&CubeColl.AttachCube("UNITS_SOLD");
&CubeColl.AttachCube("UNIT_COST");
&CubeColl.SetFieldMapping("MONTH", "QE_BAM_MONTH_FLD", False);

Copyright © 1988, 2024, Oracle and/or its affiliates. 315

Analytic Calculation Engine Metadata Classes Chapter 4

&CubeColl.SetPersistAggregate("MONTH", &CubeColl.AnalyticModel_AggrType_None);
&CubeColl.SetDimSort("MONTH", False, "", False, "", False, "");
&CubeColl.SetFieldMapping("PRODUCTS", "QE_BAM_PRODUCT_FLD", False);
&CubeColl.SetPersistAggregate("PRODUCTS", &CubeColl.AnalyticModel_AggrType_None)⇒

;
&CubeColl.SetFilter("PRODUCTS", "FILTERPRODUCTS");
&CubeColl.SetDimSort("PRODUCTS", False, "", False, "", False, "");
&CubeColl.SetFieldMapping("REGION", "QE_BAM_REGION_FLD", False);
&CubeColl.SetPersistAggregate("REGION", &CubeColl.AnalyticModel_AggrType_None);
&CubeColl.SetDimSort("REGION", False, "", False, "", False, "");
&CubeColl.SetFieldMapping("PROD_SALES", "QE_BAM_PRDSALES_FL", True);
&CubeColl.SetFieldMapping("UNITS_SOLD", "QE_BAM_SALES_FLD", True);
&CubeColl.SetFieldMapping("UNIT_COST", "QE_BAM_UNIT_FLD", True);

&CubeColl = &Model.AddCubeCollection("TGT_COST_PROD");
&CubeColl.RecordName = "QE_BAM_CC_TRGT";
&CubeColl.AttachCube("TGT_COST");
&CubeColl.SetFieldMapping("PRODUCTS", "QE_BAM_PRODUCT_FLD", False);
&CubeColl.SetPersistAggregate("PRODUCTS", &CubeColl.AnalyticModel_AggrType_None)⇒

;
&CubeColl.SetDimSort("PRODUCTS", False, "", False, "", False, "");
&CubeColl.SetFieldMapping("TGT_COST", "QE_BAM_TARGET_FLD", True);

&Model.Save();
/* &Valid = &Model.Validate(); */

QE_ACE_META_WK.QE_BAM_PCSTATUS = "The Model " | &ACEMODELID | " was created and ⇒

saved.";

End-Function;

316 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 5

Analytic Grid Classes

Understanding the Analytic Calculation Engine Classes

PeopleSoft Analytic Calculation Engine comprises a calculation engine plus several PeopleTools features
which enable application developers to define both the calculation rules and the display of calculated data
within PeopleSoft applications for the purposes of multi-dimensional reporting, data editing, and analysis.

More specifically, developers create analytic models in order to define the rules which are used to
calculate data. Developers also create PeopleSoft Pure Internet Architecture pages with analytic grids in
order to display the data within PeopleSoft applications. End users view, analyze, and make changes to
this data. When end users save their changes, PeopleSoft Analytic Calculation Engine recalculates the
data and saves the calculated data to the database.

PeopleCode enables developers to manipulate analytic calculation data as follows:

• Use the Analytic Calculation Engine classes to either retrieve or specify data in an instance of an
analytic model loaded into the system, and also to calculate (or recalculate) cube values.

• Use the Analytic Calculation Engine metadata classes to manipulate an analytic model definition. For
example, you can add cubes to a cube collection or rename an existing user function for a model.

• Use the Analytic Grid classes to manipulate the display of analytic calculation data on a page.

• Use the Analytic Type classes to manipulate an analytic type definition. For example, you can specify
a new analytic model for an analytic type definition.

Important! The analytic grid classes are not supported on IBM z/OS and Linux for IBM System z
platforms.

Related Links
Understanding the PeopleSoft Analytic Calculation Engine Metadata Classes
Understanding the Analytic Calculation Engine Classes
Understanding the Analytic Calculation Engine Classes

Using the Analytic Grid in PeopleCode

The PeopleCode AnalyticGrid object is a reference to a page runtime object for the analytic grid. These
particular page runtime objects aren’t present until the component is started.

Note: PeopleSoft builds a page grid one row at a time. Because the AnalyticGrid class applies to a
complete grid, you can’t attach PeopleCode that uses the AnalyticGrid class to events that occur before
the grid is built; the earliest event you can use is the page Activate Event.

Copyright © 1988, 2024, Oracle and/or its affiliates. 317

Analytic Grid Classes Chapter 5

If you’re using the analytic grid within a secondary page, the runtime object for the grid isn’t created
until the secondary page is run. The grid object can’t be obtained until then, which means that the earliest
PeopleCode event you can use to activate a grid that’s on a secondary page is the Activate event for the
secondary page.

The attributes you set for displaying an analytic grid remain in effect only while the page is active. When
you switch between pages in a component, you have to reapply those changes every time the page is
displayed.

In addition, the Activate event associated with a page fires every time the page is displayed. Any
PeopleCode associated with that Activate event runs, which may undo the changes you made when the
page was last active. For example, if you hide a grid column in the Activate event, then display it as part
of a user action, when the user tabs to another page in the component, then tabs back, the Activate event
runs again, hiding the grid column again.

If a user at runtime hides a column of a grid, tabs to another page in the component, then tabs back to the
first page, the page is refreshed and the grid column is displayed again.

You can use the rowset class methods and properties on analytic grid data. You can access the data loaded
by the analytic grid by accessing a rowset object after the grid is populated.

Use the analytic grid classes to manipulate the display of an analytic grid—that is, one associated with
PeopleSoft Analytic Calculation Engine data. If you want to manipulate a grid control, use the grid
classes.

Related Links
Grid Class Methods
GetRowset
“CreateRowset” (PeopleCode Language Reference)
“GetRowset” (PeopleCode Language Reference)
“Activate Event” (PeopleCode Developer’s Guide)

Using Freeze Column Mode

If you specify Freeze Column Mode for an analytic grid in Application Designer, the analytic grid isn't
populated from the component buffer by default. It is your responsibility to write your application code so
that it populates the rowset bound to the analytic grid.

Note: You should not be adding and deleting data from the analytic grid when you are not in Freeze
Column Mode; this is an unsupported feature and might cause unexpected behavior.

In addition, no layout information is available, and there is no slicer, row, or column axis.

The following is an example of populating the analytic grid with data from a normal grid in Freeze
Column Mode.
Local Rowset &RSAGRID;
Local Rowset &RSGrid;

/* Get the rowset associated with normal grid whose primary record is */
/* QE_BAM_FACTTBL */

318 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 5 Analytic Grid Classes

&RSGRID = GetLevel0()(1).GetRowset(Scroll.QE_BAM_FACTTBL);

/* Get the rowset associated with Analytic grid whose primary record is */
/* QE_BAM_CCSMOKE */
&RSAGRID = GetLevel0()(1).GetRowset(Scroll.QE_BAM_CCSMOKE);

/* Flush out existing Data from the Analytic Grid */

&RSAGRID.Flush();

/* Copy data from Normal Grid to Analytic Grid in Freeze Column Mode*/
&RSGRID.CopyTo(&RSAGRID, Record.QE_BAM_FACTTBL, Record. QE_BAM_CCSMOKE);

Do not use the following methods with an analytic grid that is in Freeze Column Mode:

• Analytic grid GetCubeCollection method

• Analytic grid LoadData method

• Analytic grid SetAnalyticInstance method

• Analytic grid SetLayout method

• Analytic grid SlicerVisible property

Error Handling
All the analytic type classes throw PeopleCode exceptions for any fatal error that occurs in the execution
of the operation. PeopleSoft recommends enclosing your analytic model programs in try-catch statements.
This way, if your program catches the exception, the message set and message number that are associated
with the exception object indicate the error.

Related Links
Try-Catch Blocks

Data Types of the Analytic Grid Objects

Analytic grids are declared using the AnalyticGrid data type. For example,
Local AnalyticGrid &MyAnalyticGrid;

Analytic grid columns are declared using the AnalyticGridColumn data type. For example:
Local AnalyticGridColumn &MYGRIDCOL;

Scope of Analytic Grid Objects

Both the AnalyticGrid and AnalyticGridColumn objects can be instantiated from PeopleCode only.

Copyright © 1988, 2024, Oracle and/or its affiliates. 319

Analytic Grid Classes Chapter 5

An AnalyticGrid is a control on a page. You generally use these objects only in PeopleCode programs that
are associated with an online process, not in an Application Engine program, a message notification, a
Component Interface, and so on.

AnalyticGrid objects can be of scope local, component or global.

AnalyticGrid Class Reference

This reference for the AnalyticGrid class includes:

• AnalyticGrid class built-in function.

• AnalyticGrid class methods.

• AnalyticGrid class properties.

AnalyticGrid Class Built-in Function

“GetAnalyticGrid” (PeopleCode Language Reference)

AnalyticGrid Class Methods

In this section, we discuss the AnalyticGrid class methods. The methods are described in alphabetic order.

GetColumn

Syntax
GetColumn(ColumnName)

Description
Use the GetColumn method to instantiate an AnalyticGridColumn object.

Note: The properties for an AnalyticGridColumn and a GridColumn are the same. Any differences are
indicated in the description for the GridColumn property.

Specify the grid column name in the page field properties for that field, consisting of any combination of
uppercase letters, digits and "#", "$", "@", and "_".

To specify a grid column name:

1. Open the page in Application Designer, select the analytic grid and access the Analytic Grid control
properties.

2. On the General tab, type the new grid name in Page Field Name.

320 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 5 Analytic Grid Classes

Parameters

Parameter Description

ColumnName Specify the name of the column that you want to access.

Returns
An AnalyticGridColumn object.

Note: The properties for an AnalyticGridColumn and a GridColumn are the same. Any differences are
indicated in the description for the GridColumn property.

Related Links
GridColumn Class

GetCubeCollection

Syntax
GetCubeCollection()

Description
Use the GetCubeCollection method to return a reference to the cube collection associated with the
analytic grid.

Note: Do not use this method with an analytic grid that is in Freeze Column Mode.

Parameters
None.

Returns
A CubeCollection object.

Related Links
Understanding the Analytic Calculation Engine Classes
CubeCollection Class

LoadData

Syntax
LoadData()

Copyright © 1988, 2024, Oracle and/or its affiliates. 321

Analytic Grid Classes Chapter 5

Description
Use the LoadData method to cause the system to get fresh data for the grid from the analytic calculation
engine. Generally, you would use this method after you perform some operation, such as SetLayout, that
might change the value or layout of the data.

Note: Do not use this method with an analytic grid that is in Freeze Column Mode.

Parameters
None.

Returns
None.

SetAnalyticInstance

Syntax
SetAnalyticInstance(ID)

Description
Use the SetAnalyticInstance method to specify the analytic instance to be associated with this analytic
grid.

An AnalyticGrid object can be bound only once to an analytic instance. If the SetAnalyticInstance method
is called after the analytic grid is bound to an instance, the method call has no effect.

Note: Do not use this method with an analytic grid that is in Freeze Column Mode.

Parameters

Parameter Description

ID Specify the analytic instance ID as a string.

Returns
None.

Related Links
Understanding the Analytic Calculation Engine Classes
Understanding the Analytic Calculation Engine Classes
AnalyticInstance Class Methods

322 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 5 Analytic Grid Classes

SetLayout

Syntax
SetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray)

Description
Use the SetLayout method to set the layout for the three axes, slice, row, and column.

Note: Do not use this method with an analytic grid that is in Freeze Column Mode.

If you specify No Drag drop mode for an analytic grid in Application Designer, the analytic grid has the
column axis, row axis and slicer axis, but the end user isn't allowed to change the layout by dragging and
dropping elements between axes. However, you can still change the layout using the SetLayout method.

Note: You can specify a null value ("") for all the required parameters for this method.

Parameters

Parameter Description

&SlicerArray Specify an already instantiated array of string containing the

list of fields to be put on the slice axis.

&RowAxisArray Specify an already instantiated array of string containing the

list of fields to be put on the row axis.

&ColumnAxisArray Specify an already instantiated array of string containing the

list of fields to be put on the column axis.

Note: The maximum number of columns that can be displayed

in an analytic grid is four.

Returns
None.

AnalyticGrid Class Properties

In this section we discuss the AnalyticGrid properties. The properties are described in alphabetic order.

Copyright © 1988, 2024, Oracle and/or its affiliates. 323

Analytic Grid Classes Chapter 5

Inactive

Description
Use this property to specify whether the analytic grid is inactive or active. This property takes a Boolean
value, true if the grid is inactive, false otherwise.

If you specify this property as true, the analytic grid is not displayed to the user and no data is fetched
from the database.

This property is read/write.

Label

Description
Use this property to specify the label that appears as the title of the grid.

Note: You can't use this property to set labels longer than 100 characters. If you try to set a label of more
than 100 characters, the label is truncated to 100 characters. Always put any changes to labels in the
Activate event for the page. This way the label is set every time the page is accessed.

This property is read/write.

ShowGridLines

Description
Use this property to specify whether grid lines are displayed with the analytic grid. This property takes a
Boolean value, true to show the lines, false otherwise.

This property is read/write.

SlicerVisible

Description
Use this property to specify whether the slicer is displayed with the analytic grid. This property takes a
Boolean value, true to show the slicer, false otherwise.

Note: Do not use this method with an analytic grid that is in Freeze Column Mode.

This property is read/write.

324 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 5 Analytic Grid Classes

SummaryText

Description
Use this property to set or return a string representing the summary text for the analytic grid.

Summary text enables you to provide a brief description of the functionality and content of the grid area.
This property is pertinent for users who access the application in screen reader mode.

This property is read/write.

Example
&MyAnGrid = GetAnalyticGrid(Page.PSMYPAGE, "PSMYPAGE");
&MyAnGrid.SummaryText = "This is the new summary text through PeopleCode";

Related Links
“Setting Analytic Grid Label Properties” (Analytic Calculation Engine)

Copyright © 1988, 2024, Oracle and/or its affiliates. 325

Analytic Grid Classes Chapter 5

326 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6

Analytic Type Classes

Understanding the Analytic Calculation Engine Classes

PeopleSoft Analytic Calculation Engine comprises a calculation engine plus several PeopleTools features
which enable application developers to define both the calculation rules and the display of calculated data
within PeopleSoft applications for the purposes of multi-dimensional reporting, data editing, and analysis.

More specifically, developers create analytic models in order to define the rules which are used to
calculate data. Developers also create PeopleSoft Pure Internet Architecture pages with analytic grids in
order to display the data within PeopleSoft applications. End users view, analyze and make changes to
this data. When end users save their changes, PeopleSoft Analytic Calculation Engine recalculates the
data and saves the calculated data to the database.

PeopleCode enables developers to manipulate analytic calculation data as follows:

• Use the Analytic Calculation Engine classes to either retrieve or specify data in an instance of an
analytic model loaded into the system, and also to calculate (or recalculate) cube values.

• Use the Analytic Calculation Engine metadata classes to manipulate an analytic model definition. For
example, you can add cubes to a cube collection or rename an existing user function for a model.

• Use the analytic grid classes to manipulate the display of analytic calculation data on a page.

• Use the analytic type metadata classes to manipulate an analytic type definition. For example, you can
specify a new analytic model for an analytic type definition.

Important! The analytic type classes are not supported on IBM z/OS and Linux for IBM System z
platforms.

Related Links
Understanding the Analytic Calculation Engine Classes
AnalyticGrid Class Reference
Understanding the Analytic Calculation Engine Classes

Using the Analytic Type Classes

You can create analytic type definitions using Application Designer. PeopleSoft provides the analytic type
classes for accessing these definitions at runtime.

You can also create an analytic type definition in PeopleCode, using the Create method, then saving it to
the database using the Save method. After you save the definition, you can access it using Application
Designer.

Copyright © 1988, 2024, Oracle and/or its affiliates. 327

Analytic Type Classes Chapter 6

You only need to create an instance of the analytic type. All other objects are instantiated from the
analytic type object.

Once the AnalyticTypeDefn object is created, you can then execute either the Get or Create methods to
“instantiate” the analytic type object.

Error Handling
All the analytic type classes throw PeopleCode exceptions for any fatal error that occurs in the execution
of the operation. PeopleSoft recommends enclosing your analytic model programs in try-catch statements.
This way, if your program catches the exception, the message set and message number that are associated
with the exception object indicate the error.

Related Links
Try-Catch Blocks

Data Types of the Analytic Type Objects

Every PeopleSoft analytic type object is declared as its own data type, that is, AnalyticTypeDefn
objects are declared as type AnalyticTypeDefn, AnalyticTypeModelDefn objects are declared as type
AnalyticTypeModelDefn, and so on.

The following are the data types for the PeopleSoft analytic type classes:

• AnalyticTypeDefn

• AnalyticTypeModelDefn

• AnalyticTypeRecordDefn

Scope of Analytic Type Objects

The analytic type objects can only be instantiated from PeopleCode.

These objects can be used anywhere you have PeopleCode, that is, in a Application Engine program, an
application class, record field PeopleCode, and so on.

Analytic type objects can be of scope Local, Component or Global.

How to Import the Analytic Type Classes

The analytic type classes are not built-in classes, like Rowset, Field, Record, and so on. They are
application classes. Before you can use these classes in your PeopleCode program, you must import them
to your program.

328 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

An import statement names either all the classes in a package or one particular application class. For
importing the analytic type classes, PeopleSoft recommends that you import all the classes in the
application package.

The application package PT_ANALYTICTYPEDEFN contains the following subclasses:

• AnalyticTypeDefn

• AnalyticTypeModelDefn

• AnalyticTypeRecordDefn

The import statement you should use should be as follows:

import PT_ANALYTICTYPEDEFN:*;

Using the asterisks after the package name makes all the application classes directly contained in the
named package available.

Related Links
Understanding Application Classes

How to Create an Analytic Type Class Object

After you've imported the analytic type classes, you need to instantiate an instance of the
AnalyticTypeDefn class, using the constructor for that class and the Create function. After you create the
object, you must populate it using either the Get or Create method.

The following example creates an AnalyticTypeDefn object from the QE_ACE_ALLFUNCTION analytic
type definition.
Local PT_ANALYTICTYPEDEFN:AnalyticTypeDefn &AnalyticType;

&AnalyticType = create PT_ ANALYTICTYPEDEFN:AnalyticTypeDefn("QE_ACE_ALLFUNCTION");

Related Links
Analytic Calculation Engine Metadata Classes Constructor

Analytic Type Classes Constructor

You must use the constructor for the AnalyticTypeDefn class to instantiate an instance of that class. All
other objects are instantiated from this class.

AnalyticTypeDefn

Syntax
AnalyticTypeDefn(TypeName)

Copyright © 1988, 2024, Oracle and/or its affiliates. 329

Analytic Type Classes Chapter 6

Description
Use the AnalyticTypeDefn constructor to create an AnalyticTypeDefn.

Once the AnalyticTypeDefn object is created, you can then execute either the Get or Create methods to
instantiate the model.

Note: The Delete and Rename methods can only be executed before a model is instantiated.

Parameters

Parameter Description

TypeName Specify the name of an analytic type definition.

Returns
An AnalyticTypeDefn object.

Example
&Model = create AnalyticTypeDefn("QE_ACE_ALLFUNCTION");

AnalyticTypeDefn Class Methods

This section describes the analytic type definition class methods. The methods are discussed in
alphabetical order.

AddModel

Syntax
AddModel(ModelName, ModelType)

Description
Use the AddModel method to add either an analytic model or optimization model to the analytic type
definition. If the model doesn't exist, this method fails.

Parameters

Parameter Description

ModelName Specify the name of an existing model.

330 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

Parameter Description

ModelType Specify the model type. Values are:

Value Description

%ModelType_ACE The model is an Analytic Calculation Engine.

%ModelType_OPT The model is an optimization.

Returns
The new AnalyticTypeModelDefn object.

Related Links
DeleteModel
GetModelNames
AnalyticTypeModelDefn Class Properties

AddRecord

Syntax
AddRecord(RecordName)

Description
Use the AddRecord method to add a record to the analytic type definition. If the record definition doesn't
exist in Application Designer, or if the record already exists in this analytic type definition, this method
fails.

Parameters

Parameter Description

RecordName Specify the name of the record that you want to add.

Returns
An AnalyticTypeRecordDefn object that represents the record.

Related Links
DeleteRecord

Copyright © 1988, 2024, Oracle and/or its affiliates. 331

Analytic Type Classes Chapter 6

GetRecordNames
AnalyticTypeRecordDefn Class Methods

Create

Syntax
Create()

Description
Use the Create method to create, and instantiate, a new analytic type. If the analytic type already exists, an
exception is thrown.

Parameters
None.

Returns
None.

Related Links
Save
Try-Catch Blocks

CopyTo

Syntax
CopyTo(NewAnalyticTypeName)

Description
Use the CopyTo method to copy the current AnalyticTypeDefn object to the AnalyticTypeDefn object
with the specified name. This method fails if the analytic type specified with NewAnalyticTypeName
already exists.

Parameters

Parameter Description

NewAnalyticTypeName Specify the name of the new analytic type definition that you
want to create.

332 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

Returns
The new AnalyticTypeDefn object.

Related Links
Create
Save

Delete

Syntax
Delete()

Description
Use the Delete method to delete the analytic type definition. You must use this method immediately after
you create the AnalyticType object, before you instantiate it, that is, before you use either the Get or
Create method.

Note: This method executes immediately, and deletes the definition from Application Designer.

Parameters
None.

Returns
None.

Related Links
Create
Get
Save

DeleteModel

Syntax
DeleteModel(ModelName)

Description
Use the DeleteModel method to delete the specified model from the analytic type definition.

Note: The model is not deleted from the analytic type definition until you use the Save method.

Copyright © 1988, 2024, Oracle and/or its affiliates. 333

Analytic Type Classes Chapter 6

Parameters

Parameter Description

ModelName Specify the name of a model that exists in the analytic type
definition.

Returns
None.

Related Links
AddModel
GetModelNames
AnalyticTypeModelDefn Class Properties

DeleteRecord

Syntax
DeleteRecord(RecordName)

Description
Use the DeleteRecord method to delete a record from the analytic type definition.

Note: The record deleted from the analytic type definition until you use the Save method.

Parameters

Parameter Description

RecordName Specify the name of the record that you want to remove from
the analytic type definition.

Returns
None.

Related Links
AddRecord
GetRecordNames
AnalyticTypeRecordDefn Class Methods

334 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

Get

Syntax
Get()

Description
Use the Get method to instantiate an existing analytic type definition as an AnalyticTypeDefn object. If
the analytic type doesn't exist, this method throws an exception.

Parameters
None.

Returns
None.

Related Links
Create
Save

GetModel

Syntax
GetModel(ModelName)

Description
Use the GetModel method to return a reference to an AnalyticTypeModelDefn object.

This method fails if the model specified by ModelName doesn't exist.

Parameters

Parameter Description

ModelName Specify the name of the analytic type model definition that you
want to access.

Returns
An AnalyticTypeModelDefn object.

Copyright © 1988, 2024, Oracle and/or its affiliates. 335

Analytic Type Classes Chapter 6

Related Links
AnalyticTypeModelDefn Class Properties

GetModelNames

Syntax
GetModelNames()

Description
Use the GetModelNames method to return an array of string containing all the model names in this
analytic type definition.

Parameters
None.

Returns
An array of string.

Related Links
AddModel
DeleteModel
AnalyticTypeModelDefn Class Properties

GetRecord

Syntax
GetRecord(RecordName)

Description
Use the GetRecord method to return a reference to an AnalyticTypeRecordDefn object.

This method fails if the record specified by RecordName doesn't exist.

Parameters

Parameter Description

RecordName Specify the name of the record that you want to access.

336 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

Returns
An AnalyticTypeRecordDefn object.

Related Links
AnalyticTypeRecordDefn Class Methods

GetRecordNames

Syntax
GetRecordNames()

Description
Use the GetRecordNames method to return an array of string containing the names of all the records
associated with the analytic type definition.

Parameters
None.

Returns
An array of string.

Related Links
AddRecord
DeleteRecord
AnalyticTypeRecordDefn Class Methods

Rename

Syntax
Rename(NewAnalyticTypeName)

Description
Use the Rename method to rename an existing analytic type definition to a new name. You must use this
method immediately after you create the AnalyticType object, before you instantiate it, that is, before you
use either the Get or Create method. The new name is not saved to the database until you use the Save
method.

Copyright © 1988, 2024, Oracle and/or its affiliates. 337

Analytic Type Classes Chapter 6

Parameters

Parameter Description

NewAnalyticTypeName Specify the new name for the analytic type definition.

Returns
None.

Related Links
Save

Save

Syntax
Save()

Description
Use the Save method to save any changes that were made to the AnalyticTypeDefn object to the database.

Parameters
None.

Returns
None.

AnalyticTypeDefn Class Properties

In this section we discuss the AnalyticTypeDefn class properties. The properties are described in
alphabetic order.

AppClassPath

Description
Use this property to specify the full name of the application package that contains the Create, Copy and
Delete methods used with this analytic type definition.

This property is read/write.

338 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

Comments

Description
Use this property to specify comments for the analytic type.

This property is read/write.

Description

Description
Use this property to specify a description for the analytic type.

This property is read/write.

Name

Description
This property specifies the name of the AnalyticTypeDefn.

This property is read-only.

OwnerID

Description
This property specifies the owner ID for this AnalyticTypeDefn.

This property is read/write.

AnalyticTypeModelDefn Class Properties

In this section we discuss the AnalyticTypeModelDefn class properties. The properties are described in
alphabetic order.

Name

Description
This property specifies the name of the analytic type model.

This property is read-only.

Copyright © 1988, 2024, Oracle and/or its affiliates. 339

Analytic Type Classes Chapter 6

Type

Description
This property specifies the type of the analytic type model. Values are:

Value Description

%ModelType_ACE The model is an Analytic Calculation Engine.

%ModelType_OPT The model is an optimization.

This property is read-only.

AnalyticTypeRecordDefn Class Methods

In this section we describe the AnalyticTypeRecordDefn class methods. The methods are discussed in
alphabetic order.

GetSelectedField

Syntax
GetSelectedField()

Description
Use the GetSelectedField to return an array of string containing the names of the fields that are selected
for this record.

Parameters
None.

Returns
An array of string.

Related Links
SetSelectedField

340 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

SetSelectedField

Syntax
SetSelectedFields(FieldName)

Description
Use the SetSelectedField method to specify the name of the field that is selected for this record.

Parameters

Parameter Description

FieldName Specify the name of the field that you want to select.

Returns
None.

Related Links
GetSelectedField

UnsetSelectedField

Syntax
UnsetSelectedField(FieldName)

Description
Use the UnsetSelectedField method to deselect the selected field.

This method throws an exception if the field specified by FieldName isn't selected.

Parameters

Parameter Description

FieldName Specify the name of the field that you want to deselect.

Returns
None.

Copyright © 1988, 2024, Oracle and/or its affiliates. 341

Analytic Type Classes Chapter 6

AnalyticTypeRecordDefn Class Properties

In this section we discuss the AnalyticTypeRecordDefn class properties. The properties are described in
alphabetic order.

All of the properties listed here can also be set for the analytic type definition using Application Designer.

Related Links
“Understanding Analytic Model Properties” (Analytic Calculation Engine)

Callback

Description
Use this property to specify whether this record has a callback. This property takes a Boolean value, true
if the record has a callback, false otherwise.

This property is read/write.

Description

Description
Use this property to specify a description for the record.

This property is read/write.

Name

Description
This property specifies the name of the record.

This property is read-only.

Readable

Description
Use this property to specify whether this record is readable. This property takes a Boolean value, true if
the record is readable, false otherwise.

This record is read/write.

342 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 6 Analytic Type Classes

ReadOnce

Description
Use this property to specify whether this record is specified as read once. This property takes a Boolean
value, true if the record is only read once, false otherwise.

This property is read/write.

ScenarioManaged

Description
Use this property to specify if the record is specified as scenario managed. This property takes a Boolean
value, true if the record is scenario managed, false otherwise.

This property is read/write.

SyncOrder

Description
This property specifies the synchronization order for the record. It returns an integer value.

This property is read/write.

Writeable

Description
Use this property to specify if a record is specified as writeable. This property takes a Boolean value, true
if the record is writeable, false otherwise.

This property is read/write.

AnalyticType Classes Example

The following is a typical example of using the AnalyticType classes.
import PT_ANALYTICTYPEDEFN:*;

Local PT_ANALYTICTYPEDEFN:AnalyticTypeDefn &AnalyticType;

Local PT_ANALYTICTYPEDEFN:AnalyticTypeRecordDefn &AnalyticTypeRecordDefn;

&AnalyticType = create PT_ ANALYTICTYPEDEFN:AnalyticTypeDefn("BB_TEST");

&AnalyticType.Create();

&AnalyticType.AddModel("QE_BAM_GENX", %ModelType_ACE);

Copyright © 1988, 2024, Oracle and/or its affiliates. 343

Analytic Type Classes Chapter 6

&AnalyticTypeRecordDefn = &AnalyticType.AddRecordl("QE_BAM_CCSMOKE");

&AnalyticTypeRecordDefn = &AnalyticType.AddRecordl("QE_BAM_FACTTBL");

&AnalyticType.Save();

344 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7

Application Classes

Understanding Application Classes

You can create Application Packages in Application Designer. These packages contain application
classes (and may contain other packages also). An application class, at its base level, is just a PeopleCode
program. However, using the Application Packages, you can create your own classes, and extend the
functionality of the existing PeopleCode classes.

The application classes provide capability beyond that offered by the existing PeopleCode classes. Unlike
the existing classes, a subclass can inherit all the properties and methods of the class it extends. This
provides all the advantages of true object-oriented programming:

• easier to debug because all the pieces are separate

• easier to maintain because functionality is gathered into a single place

• extensible by subclass

In addition, the application classes provide more structure. Using the Application Packages, you have a
clear definition of each class, as well as its listed properties and methods. This makes it easier to create a
complex program that uses many functions.

Related Links
“Creating Application Packages” (PeopleCode Developer’s Guide)

When Would You Use Application Classes?

Use Application classes to help structure your existing PeopleCode functions. For example, prior to
Application classes, most PeopleCode functions were put into FUNCLIB records. However, in larger,
more complex programs, it is sometimes difficult to find (let alone maintain) a function. You could make
every function a class in a package with very little reworking of your PeopleCode (as well as making the
different fields in a record a package, and combining them into a single larger package.) This provides a
better visual interface for grouping your functions.

In addition, use Application classes when you have to do generic processing, and just the details are
different. For example, suppose one of the processes for your application is reading a file object and
doing bulk insert. The process could all be contained in a single package, with the classes and subclasses
providing all the details, different kinds of reading for different types of files, different inserts based on
the record, and so on.

One of the main differences between a class and a function call is that the call to the class is dynamic, like
a function variable, but more closely controlled. All the calls to the class (methods) must have the same
signature.

Copyright © 1988, 2024, Oracle and/or its affiliates. 345

Application Classes Chapter 7

For example, suppose you want to provide a more generic sort, with comparison function at the end of
it. You want to use the array class Sort method, but your process has to be generic: you aren't certain
if you're comparing two records or two strings. You could define a class that had as its main method a
comparison, and return a -1, 0, or 1. Then write your personalized sort, extending the array class method
Sort.

Another use is for business processing. Think in terms of core functionality, with vertical product
solutions that extend the basic processing by providing specifics, in other words, by extending the general
classes with subclasses. This could be appropriate for sales force automation or order entry.

Generally, use application classes where you can extract the common functionality.

Note: Do not extend a SOAPDoc with an application class. This is currently not supported.

Application Classes General Structure

This section discusses the general form of an application class. All application classes are contained in
application packages; and all application classes are composed of executable PeopleCode statements.

The division of application classes facilitates object-oriented programming and enables a separation of the
following:

• What the class provides to other classes.

• What is applicable to the entire class.

• What is applicable to the definition of a method.

The data types used in an application class (for methods parameters, return values, and so on) can be any
PeopleCode types, including application classes. Likewise, application classes can be used anywhere in a
PeopleCode program where a general data type can be used.

Related Links
“Data Types” (PeopleCode Developer’s Guide)

Class Name
Application classes have a fully qualified name that is formed hierarchically by the name of the top-level
package that contains them, the package that contains that package, and so on down to the short class
name, that is, the one specified when the class was created in Application Designer, using a colon for the
separator between names.

The fully qualified name of the class must be unique, as this is what identifies the class. The short name
of the class does not have to be unique.

346 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

For example, suppose package CRM contains the application classes Address and Customer as well as the
package Utilities, which in turn contains the application classes Address and Incident:

There are four distinct application classes in this example:

• CRM:Address

• CRM:Customer

• CRM:Utilities:Address

• CRM:Utilities:Incident

Note: If you change the name of a package or an application class, that name change is not automatically
propagated through all your PeopleCode programs. You must make the change manually in your
programs. If you specify an incorrect name for a package or application class, you receive a warning
when you try to save the PeopleCode.

Class Extension
Extension represents the "is-a" relationship. When a class extends another class, it's called a subclass of
that class. Conversely, the class being extended is called a superclass of that subclass.

A subclass inherits all of the public methods and properties (collectively called members) of the class it
extends. These members can be overridden by declarations of methods and properties in the subclass.

Note: Application classes have no multiple inheritance (that is, being able to extend more than one class.)

Type checking in PeopleCode (both at design time and runtime) does strong type checking of application
classes, tracking each application class as a separate type. A subclass can be used as the class it extends,
because it implements the public interfaces of its superclass. This is called subtyping.

Copyright © 1988, 2024, Oracle and/or its affiliates. 347

Application Classes Chapter 7

In the following example, the class Banana extends the class Fruit. Banana is the subclass of Fruit. From
Fruit, you can extend to Bananas. However, from Bananas you can't extend to Fruit. Another way to think
about this is you can only extend from the general to the specific, not the other way around.
class Fruit
method DoFruit();
property number FruitNum instance;
end-class;

class Banana extends Fruit

method DoBanana();
property number BananaNum instance;
end-class;

The following code shows a correct way to assign a class object, because Banana is a subtype of Fruit.
local Fruit &Bref = create Banana();

The following is not correct. Banana is a subtype of Fruit. Fruit is not a subtype of Banana. This
assignment causes an error at design time.
local Banana &Fref = create Fruit();

Before you can extend a class, you must first import it. You must import all class names you use in a
PeopleCode program before you use them.

Related Links
Import Declarations

Declaration of Public External Interface

The names of the members (that is, all the methods and properties of a class) must be unique only within
that class. Different classes can have members with the same name. As members are used only with
objects, and each object knows its class, the member that's accessed is the one associated with that class.

For example, more than one class has the property Name which returns the name of the object executing
the property. There isn't any confusion, because the field Name property returns the name of a field, while
the record name property returns the name of a record. No class has more than one property called Name.

Note: Within a class, each member name must be unique.

The public part of a class declaration specifies the methods and properties that the class provides to other
PeopleCode programs. These methods and properties are dynamically bound, that is, the actual method
that is called depends on the actual class of the object, as it might be an overridden method or property
from a subclass.

In the following code example, the text in bold indicates the public part of the class declaration.
/* generic building class */
class BuildingAsset
method Acquire();
method DisasterPrep();
end-class;

348 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

Access Control and the Declaration of Protected Properties and Methods

Application class objects have private and public access control. Properties or methods that are declared
outside the “private” declaration section have public access control. This means that they can be
referenced and used by any PeopleCode. This access is of course subject to access controls such as
“readonly”. Private properties and methods are private to the class, not instance, and can only be
referenced by objects of this application class.

Between these two access control schemes of public and private, lies the concept of protected methods
and properties. Protected methods and properties can be accessed only by objects of this application class
and those derived from this application class. Use protected methods or properties when you want to hide
them from outside use, but allow the flexibility of using them in derived classes.

The declarations of protected variables and methods are done within the class declaration, before the
declaration of private variables and methods. You can use protected instance variables in interface classes.
Protected methods and properties can be overridden by subclasses.

Most of the time your design can be implemented through the use of private methods and properties
without resorting to the use of protected methods and properties. The following examples demonstrates
the rules and some of the subtleties about when to use protected methods and properties.
class A;
method A();
property string Q;
protected
method MP() Returns string;
property string p;
end-class;

method A;
&p = "Class A: property p";
end-method;

method MP
/+ Returns String +/
Return "Class A: method MP";
end-method;

====================

class B extends A;
method B();
method M(&X As C);
method m2(&Aobj As A);
/* property string P; */
protected
property string Q;
method MP() Returns string;
end-class;

method B;
%Super = (create A());
&Q = "Class B: property Q";
/* &P = "Class B: property P";*/
end-method;

method M
/+ &X as FOXTEST:C +/;

MessageBox(0, "", 0, 0, "In B:M %This.P=" | %This.p);

/* %This.p is class A property P */
MessageBox(0, "", 0, 0, "In B:M %This.Q=" | %This.Q);
/* %This.q is class B property Q */
MessageBox(0, "", 0, 0, %This.MP());

Copyright © 1988, 2024, Oracle and/or its affiliates. 349

Application Classes Chapter 7

/* %This.MP() calls class B method MP */

if &X.p = "Error" then

end-if;
/* error: cannot reference &X.p since class B is
not involved in the implementation of class C */
end-method;

method m2
/+ &Aobj as FOXTEST:A +/
/* MessageBox(0, "", 0, 0, "In B:M2 &Aobj.P=" | &Aobj.p);
/* Error: cannot reference &Aobj.p from class B
since class B is not involved in its implementation */

end-method;

method MP
/+ Returns String +/
Return "Class B: method MP";
end-method;

=======================

class C extends A;
method C();
protected
property string P;
end-class;

method C;
%Super = (create A());
&P = "Class C: property P";
end-method;
==========================

/* AE program */
import FOXTEST:*;

Local A &A = (create A());

Local object &obj = &A;

MessageBox(0, "", 0, 0, "In AEMINITEST: &Obj.p=" | &obj.P);
/* run time error: anonymous access through type
object not allowed*/

The following example also illustrates some of the rules surrounding protected access control.
import FOXTEST:Point3d;

class Point
method Point(&X1 As integer, &Y1 As integer);
method Warp(&A As Point3d);
protected
property integer x;
property integer y;
end-class;

method Point
/+ &X1 as Integer, +/
/+ &Y1 as Integer +/;

%This.x = &X1;
%This.y = &Y1;
end-method;

method Warp
/+ &A as FOXTEST:Point3d +/
/* Local Integer &temp = &A.Z; ERROR cannot access &A.Z */
end-method;
================================
import FOXTEST:Point;

350 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

class Point3d extends Point

method Point3d(&X1 As integer, &Y1 As integer, &Z1 As integer);
method Delta(&P As Point);
method Delta3d(&Q As Point3d);
protected
property integer z;
end-class;

method Point3d
/+ &X1 as Integer, +/
/+ &Y1 as Integer, +/
/+ &Z1 as Integer +/;
%Super = (create Point(&X1, &Y1));
%This.z = &Z1;
end-method;

method Delta
/+ &P as FOXTEST:Point +/

/* &P.x = %This.x;
ERROR cannot access &P.x since while Point3d
(the class in which references to fields x and y occur)
is a subclass of Point (the class in which x and y are declared),
it is not involved in the implementation of Point (the type of parameter p)*/

/* &P.y = %This.y;
ERROR cannot access &P.y. Same reason as above */
end-method;

method Delta3d
/+ &Q as FOXTEST:Point3d +/

/* The protected members of Q can be accessed because the class point3d is a subcla⇒

ss of Point and is involved in the implementation of Point3d */

&Q.x = %This.x;
&Q.y = %This.y;
&Q.z = %This.z;

end-method;

Declaration of Private Instance Variables and Methods

The private part of a class declaration gives the declaration of any private methods, instance variables,
and private class constants. Private methods cannot be overridden by subclasses, because they are
completely private to the declaring class. Likewise, the instance variables can't be overridden.

The declarations of private variables and methods are done within the class declaration.

Note: You cannot have private methods or instance variables in an interface type of class.

In the following example, there are both public as well as private methods and properties. Any method
that is declared before the keyword Private in the initial class declaration is public. Any method declared
after the keyword Private is private. Properties are only declared in Public. Instances and Constants are
only declared in Private

In the following example, the class Example extends the class ExampleBase. It has both public as well as
private methods and properties. It also defines the private method in the definition of methods section of
the code (the private definitions are marked like this.)
import PWWPACK:ExampleBase;

class Example extends ExampleBase

Copyright © 1988, 2024, Oracle and/or its affiliates. 351

Application Classes Chapter 7

method Example();
method NumToStr(&Num As number) Returns string;
method AppendSlash();
property number SlashCount get;
property number ImportantDayOfWeek get set;
property string SlashString readonly;
property date ImportantDate;
private
method NextDayOfWeek(&Dow As number) Returns date;
Constant &Sunday = 1;
instance string &BaseString;
end-class;

Global string &CurrentBaseString;

/* Method definitions */
method NumToStr
return String(&num);
end-method;

method AppendSlash
&SlashString = &SlashString | "/";
end-method;

get SlashCount
Return Len(&SlashString) - Len(&BaseString);
end-get;

get ImportantDayOfWeek
Return Weekday(&ImportantDate);
end-get;

set ImportantDayOfWeek
&importantdate = %This.nextdayofweek(&newvalue);
end-set;

/* Private method. */
method nextdayofweek
Return &ImportantDate + (&dow - Weekday(&ImportantDate));
end-method;

/* Constructor. */
method Example
&BaseString = &CurrentBaseString;
&SlashString = &BaseString;
&ImportantDate = Date(19970322);
end-method;

Definition of Methods
After the declaration of any global or component variables and external functions needed by the methods,
comes the actual definition of the methods. This section discusses some of the differences in how
application programs are processed by the system, and how application class method parameters are
processed.

• The system never skips to the next top-level statement.

• Application programs generally pass parameters by value, which is not the same as for existing
functions.

• Parameter passing with object data types is by reference.

• Application programs use the out specifier to pass a parameter by reference.

352 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

Not Skipping to The Next Top-Level Statement

For existing functions and programs, the system skips to the next top-level statement in some
circumstances, such as a field not found error. This never happens in an application class program. The
code is always executed or an error is produced.

Passing Parameters in Application Class Methods

The parameters to a method are passed by value in the absence of an out specification in the parameter
list. However, if a parameter list has an out specification, that argument (when used in the call of a
method) must be a value that can be assigned something, and is passed by reference. In particular this
means you cannot pass an object property to a method which requires the parameter to be an "out"
parameter. Application class properties are always passed by value.

For example:
/* argument passed by reference */
method increment(&value as number out);

/* argument passed by value */

method increment(&value as number);

This is in contrast with existing PeopleCode functions that pass all parameters by reference when they
can be assigned something. This means the method signature is a specification of which parameters can
be updated by the method. This makes the code easier to debug and maintain because it's easy to see what
can be updated and what can't.

The following is an example of code that increments a variable by one.

local Number &Mine;

&Mine = 1;

&obj.Increment(&Mine);

&Mine now has the value 2.

You cannot pass properties by reference. For example, suppose MyProp is a property of class Xan, a
statement that requires a reference doesn't work if you supply the property. The following code will
always fail because &Xan.MyProp is always passed by value and the MySqlExec method requires it to be
passed by reference (so a value can be returned.)
MySqlExec("select from bar", &Xan.MyProp)

This makes sense because the semantics of an object require that you can only change a property with
standard property references, not as a side affect of some other action.

Passing Parameters with Object Data Types

Parameters with object data types are always passed by reference:
/* argument passed by reference */
method storeInfo(&f as File);

If you specify the out modifier for a method parameter with an object data type, it becomes a reference
parameter. This means that the parameter variable is passed by reference instead of the object that it is
pointing at when passed.

Copyright © 1988, 2024, Oracle and/or its affiliates. 353

Application Classes Chapter 7

For example, if you pass an object parameter with the out modifier:
method myMethod(&arg as MyObjectClass);

local MyObjectClass &o1 = create MyObjectClass("A");

local MyOtherObjectClass &o2 = create MyOtherObjectClass();

&o2.myMethod(&o1);

And inside myMethod this occurs:

Method myMethod
&arg = create MyObjectClass("B");
end-method;

Since the method argument is reassigned within the body of myMethod, &o1 does not point at the new
instance of MyObjectClass (initialized with "B") after the method call completes. This is because &o1
still references the original instance of MyObjectClass.

However, if &o1 had been passed with the out modifier, after the method call completes, &o1 points
at whatever the parameter was last assigned to; in this case, the new instance of MyObjectClass. The
parameter, rather than the object, is passed by reference.

Using the Out Specification for a Parameter

In the following example, a class, AddStuff, has a single public method, DoAdd. This adds two numbers
together, then assigns them as different numbers. In the signature of the method declaration, the first
parameter is not declared with an out statement, while the second one is.
class AddStuff
method DoAdd(&P1 as number, &P2 as number out);
end-class;

method DoAdd
&X = &P1 + &P2;
&P1 = 1;
&P2 = 2;
end-method;

In the following PeopleCode example, an object named &Aref is instantiated from the class AddStuff.
Two parameters, &I and &J are also defined.
local AddStuff &Aref = create AddStuff();
local number &I = 10;
local number &J = 20;

The following code example is correct. &J is changed, because of the out statement in the method
signature, and because the value is being passed by reference. The value of &I is not updated.
&Aref.DoAdd(&I, &J); /* changes &J but not &I */

The following code example causes a design time error. The second parameter must be passed by
reference, not by value.
&Aref.DoAdd(10, 20); /* error - second argument not variable */

Related Links
“PeopleCode Language Structure” (PeopleCode Developer’s Guide)

354 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

Declaration of Abstract Methods and Properties

You can declare methods and properties as abstract, that is, a method or property that has a signature
which specifies the parameters and results, but has no implementation in the class that defines it. The
implementation may occur in one of the classes that extend the class where the method or property is
initially defined.

Abstract methods and properties could be used, for example, when your application wants to provide
a means for in-field customization. Your application might deliver a base class specifying the abstract
methods and properties and you would allow the customization to complete those methods and properties
by using a class that would extend the base class and provide implementations for some or all of the
abstract methods and properties.

For a class that only contains abstract methods and properties, that is, a pure interface class, you would
define a PeopleCode interface, instead of a class. You define a PeopleCode interface by using the
keyword Interface instead of Class. In an interface, all the methods and properties are abstract by default.

The following example illustrates the use of abstract methods and properties. Class MyInterface is the
base class which has mostly abstract methods and properties. However it is fully specified by the class
MyImplementation which provides and implementation for all the methods and properties.
class MyInterface
method MyMethod1() abstract;
method MyMethod2() Returns string abstract;
method MyMethod3();
property string myproperty1 abstract readonly;
property number myproperty2 abstract;
property number myproperty3 abstract;
end-class;

method MyMethod3
end-method;
-------------------------------------------------------------------
import FOXTEST:MyInterface;

class MyImplementation extends MyInterface;

method MyImplementation();
method MyMethod1();
method MyMethod2() Returns string;
property string myproperty1 readonly;
property number myproperty2;
property number myproperty3;
end-class;

method MyImplementation
%Super = create MyInterface();
end-method;

method MyMethod1
/* dummy */
end-method;

method MyMethod2
/+ Returns String +/
Return "MyMethod2's implementation is this";
end-method;

Considerations Using Abstract Methods and Properties

Be aware of the following considerations when using abstract methods or properties.

• You cannot have private abstract methods.

Copyright © 1988, 2024, Oracle and/or its affiliates. 355

Application Classes Chapter 7

• You will receive an error if you try to provide a method body for an abstract method.

• The method signatures must be identical between the abstract method definition and the method
implementation in the derived subclass.

• You will receive an error if you try to provide a Get or Set body with an abstract property.

• You will receive an error and your PeopleCode program will be terminated if you try to call an
abstract method or property at runtime, unless caught in a try-catch block.

• The class that implements an interface must still assign %Super in its constructor.

Interfaces
The concept of an interface class is purely a syntactic assist when you are defining an application
class which is totally composed of abstract methods and properties. In this case by simply specify the
keyword interface you are indicating that all the methods and properties are abstract. The following two
definitions are semantically equivalent.
class MyInterface
method MyMethod1() abstract;
method MyMethod2() Returns string abstract;
property string myproperty1 abstract readonly;
property number myproperty2 abstract;
property number myproperty3 abstract;
end-class;

interface MyInterface
method MyMethod1();
method MyMethod2() Returns string;
property string myproperty1 readonly;
property number myproperty2;
property number myproperty3;
end-interface;

When you provide an implementation for an interface you can also use the keyword implements instead
of extends. While this is not mandatory, specifying implements describes more accurately what your
application class is doing.

If your class implements an interface, you don't need to create an object reference to the superclass since
the system does that automatically for you.

In addition if your constructor takes no parameters and simply exists to create an object reference to the
superclass (that is, there is only one statement such as %Super = create mySuper();), then you
don't need to define a constructor method at all.

Constructors
The constructor for a class is the public method with the same name as the (short name of the) class. The
statements contained in this method (if any) provide the initialization of the class.

This constructor is always executed when an object of the class is instantiated.

Note: Before a constructor runs, the instance variables for the class are set by default based on their
declared types.

356 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

Instantiate new objects of an application class by using the create function. This function takes the name
of the class, and any parameters needed for the constructor method.

If the short class name is unambiguous, that is, only one class by that short name has been imported, you
can use just the short class name.

The following code instantiates an object of the class Fruit:

&Fref = create Fruit();

If there's a possibility that the name is ambiguous, you can use the full class name to instantiate the object.

The following code instantiates an object of the Invoice class:

&InvObj = create PT:examples:Invoice();

If the create function is used in the context of further object expressions, that is, with a reference to
members by a dot operation, the function call must be enclosed in parentheses. This is to emphasize that
the creation happens before the member reference. For example:
&InvCust = (create Invoice()).Cust();

If necessary, the constructor is supplied its parameters by the call-list after the class name in the create
statement. For example:
&Example = create Example(&ConstructorParameter1, 2, "Third");

A class that does not extend some other class does not need any constructor.

A class that extends another class must have a constructor, and in the constructor, it must initialize
its super class. This restriction is relaxed if the super class constructor takes no parameters, and all
the constructor does is assign it to %Super. In this case, the runtime creates the super object and
runs its constructor automatically. The benefit of this is two-fold: at design time you do not need to
provide a constructor since the runtime automatically does the equivalent of %Super = create
MySuperObject(); Also, at runtime, you may notice a performance increase since the super class
object creation and construction are done without any PeopleCode. This latter benefit can be compounded
in the case where there are multiple levels of inheritance.

To the general case, to initialize a superobject, an instance of the superclass is assigned to the keyword
%Super in the constructor for the subclass. This assignment is allowed only in the constructor for the
subclass.

The following example shows this type of assignment:

class Example extends ExampleBase
method Example();
...
end-class;

Global string &CurrentBaseString;

method Example
%Super = create ExampleBase();
&BaseString = &CurrentBaseString;
&SlashString = &BaseString;
&ImportantDate = Date(19970322);
end-method

Copyright © 1988, 2024, Oracle and/or its affiliates. 357

Application Classes Chapter 7

If your subclass’ constructor only exists to create the superclass object and assign that to your %Super,
you can dispense with providing a constructor completely as the following example illustrates.
class A
...
end-class;

Class B extends A
...
end-class;

Class C extends B
...
end-class;

...
Local C &c = create C();

...

Classes A, B and C have no constructors and the one call to create C creates objects of class C, B
and A and run their constructors. PeopleSoft recommends that unless your constructors take parameters
and need to do more than be assigned to their %Super, that you do not provide constructors since that
simplifies design time as well as may improve runtime performance significantly.

The above example is semantically equivalent to the following, except that it may run much faster, since it
does not have to run PeopleCode at each step of the construction process.
class A
...
end-class;

Class B extends A
Method B();
...
end-class;

method B
%Super = create A();
end-method;

Class C extends B
Method C();
...
end-class;

method C
%Super = create B();
end-method;

Note: Application classes don't have destructors, that is, a method called just before an object is
destroyed. The PeopleCode runtime environment generally cleans up any held resources, so they're not as
necessary as they are in other languages.

Related Links
“create” (PeopleCode Language Reference)
Superclass Reference
“%Super” (PeopleCode Language Reference)

358 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

External Function Declarations

External function declarations are allowed in application classes, in the global and component variable
declarations, after the class declaration (after the end-class statement), and before the method definitions.
For example:
import SP:Record;

class Person extends SP:Record

method Person(&pid As string);

method getPerson() Returns Record;

method getUserName() Returns string;

private
instance Record &recPerson;

end-class;

Declare Function getUserName PeopleCode FUNCLIB_PP.STRING_FUNCTIONS FieldFormula;

method Person
/+ &pid as String +/

%Super = create SP:Record(Record.SPB_PERSON_TBL);

&recPerson = %Super.getRecord();
&recPerson.PERSON_ID.Value = &pid;

end-method;

method getPerson
/+ Returns Record +/

Return &recPerson;

end-method;

method getUserName
/+ Returns String +/
Local string &formattedName;

&formattedName = getUserName(&recPerson.PERSON_ID);
Return &formattedName;
end-method;

When application class properties and instance variables are used as the argument to functions or
methods, they are always passed by value, never by reference. This means that the called function or
method cannot change the value of the property or instance variable. If you want a function call to change
a property or instance variable, use a local variable in the call and then assign the property or instance
variable after the call.

Suppose you have the following class and you want to call Meth2 in the body of Meth1, passing it
MyProp:
class MyClass
property number MyProp;
method Meth1();
method Meth2(&i as number out);
end-class;

The following PeopleCode fails with a compile-time error:

method Meth1
Meth2(%This.MyProp); /* error - field or temp name required. */
Meth2(&MyProp); /* error - field or temp name required. */
end-method;

Copyright © 1988, 2024, Oracle and/or its affiliates. 359

Application Classes Chapter 7

The following PeopleCode is valid:

method Meth1
/* Assignment needed if &i is input as well as output in Meth2. */
local number &Var = %This.MyProp;
Meth2(&Var);
%This.MyProp = &Var;
end-method;

Note: You call a Java program from an Application Class the same way you do using any other
PeopleCode program, that is, by using one of the existing Java class built-in functions.

See From Java to PeopleCode.

Naming Standards
This section describes the naming standards these components of application classes: packages, classes,
methods, and properties.

Naming Packages
The naming standard for application packages is in the following format.
CC_XXX[_YYY]

Where CC is the company name (for example, PS is PeopleSoft), XXX is the product line, and YYY is
the product code.

Examples are PS_CRM and PS_CRM_RB.

Naming Classes
Use a constructor to be the same name as the short name for the class. PeopleSoft recommends that you
do not name classes to be GetXxx.

Naming Methods
Make method names simple verb or verb object words, spelled out, first letter of each word capitalized.
Examples: GetField, Save, SetDefault, WriteRecord

Naming Properties
Make property names nouns, likewise spelled out, first letter of each word capitalized. Examples:
Dimension, HTTPMethod, PathInfo, SubscriptionProcessId.

For Boolean read-only properties, sometimes IsXxx is appropriate. Examples: IsOpen, IsNewFieldID,
IsChanged, IsDeleted

State Boolean properties positively, that is, IsChanged, as opposed to negatively, IsUnChanged. This
avoids double negatives when testing (If Not &MyField.IsUnChanged Then. . . .)

360 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

Import Declarations
Before you can use a class name in a PeopleCode program (either a class definition program or an
ordinary PeopleCode program), you must first import it using an import statement at the beginning of
your program.

An import statement names either all the classes in a package or one particular application class.

If you're importing all the classes in a package, the syntax for the import statement ends with the
following:
:*

This makes all the application classes directly contained in the named package available. Application
classes contained in subpackages of the named package are not made available.

If you're importing one particular application class, the syntax of the import statement ends with the short
name of the class. Only that class is made available.

For example, the following imports all the classes of the package named Fruit:
Import Fruit:*;

The following imports only the application classes Banana and Kiwi. If the package named Fruit contains
other classes, those are not made available to the PeopleCode program:
Import Fruit:Banana;

Import Fruit:Kiwi;

If you had a subpackage in Fruit named Drinks, you could access all the classes in that subpackage like
this:
Import Fruit:Drinks:*;

A PeopleCode program (either a separate program or one contained within a class definition) can use
only application class names that have been imported. However, a class definition can use its own name
without having to import it.

It's possible to import two packages which contain application classes with the same short name. For
example, suppose my package Fruit contained classes Apple and Banana. Suppose a second package,
Drinks, contained Apple and Cherry.
Import Fruit:*;

Import Drinks:*;

You could refer to the Banana and Cherry classes using just the short name of the class. However, you
couldn't refer to the Apple class by the short name. You must always use the full name reference (that is,
the name of the package and the name of the class) when referring to Apple.
Global Banana &MyBanana;

Local Cherry &CherryTree;

Component Fruit:Apple &GreenApple;

Copyright © 1988, 2024, Oracle and/or its affiliates. 361

Application Classes Chapter 7

The following line produces an error, because the program doesn't know which Apple class you're
referring to:
Component Apple &GreenApple;

Note: Single class imports (such as, Import Fruit:Banana) are checked for existence when you save your
PeopleCode.

Self-Reference
A method can refer to the current object using the %This system variable.

Due to subtyping, %This is an object of either the method's class or a subclass of the method's class.

In PeopleCode, the methods and properties of the class cannot be used without an object qualification.

In the following code example, the line in bold indicates an error. You can't call the class this way: you
must use %This.
class FactorialClass
method factorial(&I as number) returns number;
end-class;

method factorial
if &I <= 1 then
return 1;
end-if;

return &I * factorial(&I - 1); /* error - factorial undefined */

return &I * %This.factorial(&I - 1); /* okay */

end-method;

One of the implications of this is that when you're writing a method, there isn't any way to guarantee
you'll access your own class' version of a public method (rather then a subclass') as it might be overridden
by a subclass. The only way to make sure that you can access your own method is to make it private.

If you have some action that you also want to make public, and you want guaranteed access to it, you can
make the action a private method, then define a public method for it that calls the private one.

In the following example, factorial is the public method that can be used by other classes. myFactorial is
the private action.
class FactorialClass
method factorial(&I as number) returns number;
private
method myFactorial(&I as number) returns number;
end-class;

method factorial
return myFactorial(&I);
end-method;

method myFactorial
if &I <= 1 then
return 1;
end-if;

return &I * %This.myFactorial(&I - 1);

362 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

end-method;

If you declare an instance variable as private you can still access it as a private property in another
instance of the same class. For example, given the following declaration:
class Example

private

instance number &Num;

end-class;

A method of Example could reference another Example instance's &Num instance variable as follows:
&X = &SomeOtherExample.Num;

Related Links
“%This” (PeopleCode Language Reference)

Using %This with Constructors

%This when used in application class constructor code refers to the object currently being constructed. It
does not refer to the dynamic this pointer of some object under construction. Given these two application
classes, the PeopleCode %This.Test() in the Base constructor always refers to the Test method in the
Base class.
class Base
method Base();
method Test();
method CallTest();
property string sTestResult;
end-class;

method Base
%This.Test();
end-method;

method Test
&sTestResult = "BASE_METHOD_CALLED";
end-method;

method CallTest
%This.Test();
end-method;

import PACKAGE:Base;

class Extend extends PACKAGE:Base;

method Extend();

method Test();
end-class;

method Extend
%Super = create PACKAGE:Base();
end-method;

method Test
/+ Extends/implements PACKAGE:Base.Test +/
%This.sTestResult = "EXTENSION_METHOD_CALLED";
end-method;

Copyright © 1988, 2024, Oracle and/or its affiliates. 363

Application Classes Chapter 7

Even though the Extend class method provides its own Test method which overrides Base's Test method,
in PeopleCode create Extend() which ultimately runs Base's constructor, the %This.Test() call
in Base's constructor still references Base's Test method, not Extend's Test method, because %This always
refers to the object under construction

Properties and Constants

This section discusses the various ways to use properties and constants with application classes.

Differentiating Between Properties and Methods

A method is a procedure or routine, associated with one or more classes, that acts on an object.

A property is an attribute of an object.

PeopleSoft recommends that you use read/write or read-only properties instead of creating methods
named GetXxx and SetXxx. For example, instead of creating a method GetName, that takes no parameter,
just to return the name of an object, create a read-only property Name.

If your properties simply set or return the value of an instance variable, it is far more efficient to declare
the property that way than have a get and set method. The overhead of having a get and set method means
that each time the property is reference some PeopleCode has to be run.

Application classes can have read-only properties, but no indexed properties.

Considerations Creating Public Properties

There are two implementations of (public) properties:

• as instance variables.

• as get-set methods.

From outside the class, you cannot tell the difference between them (for example, both are dynamically
bound). However, if you just want to expose an instance variable to users of the class, you can declare a
property of that name and type, which declares the instance variable too:
class xxx
property string StringProp;
end-class

If you want the property to be read-only outside the class, use the following code:
class xxx
property string StringProp readonly;
end-class

Both of these code examples declare an instance variable called &StringProp and provide its value for
getting and change its value for setting (if not readonly). You can think of this as shorthand for the usual
implementation of get-set methods.

364 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

If you want to implement the same with code (perhaps deriving the property from other instance variables
or other data), use the following sort of PeopleCode program:
class xxx
property string StringProp get set;

private
instance string &inst_str;

end-class;

get StringProp
/+ Returns String +/
Return &inst_str; /* Get the value from somewhere. */
end-get;

set StringProp
/+ &NewValue as String +/
/* Do something with &NewValue. */
&inst_str = &NewValue;
end-set;

To specify a read-only property, omit the set portions of the code example.

Overriding Properties
A property of a superclass can be overridden by a subclass by providing a different implementation.

The properties of a class are implemented by the keywords Get and Set, or by access to an otherwise
private instance variable.

To access the property, you do not have to specify Get or Set: the context tells the processor which task
you're doing. To create read-only properties, specify only a Get method, with no Set method, or for
instance variable properties, specify Readonly.

For an instance variable property, there are two different ways for method code in the class itself to refer
to the property:

• %This.PropertyName

• &PropertyName

The first way is dynamically bound, as it uses whatever (possibly overridden by a subclass)
implementation of PropertyName that the current object provides.

The second way always accesses the private instance variable of the class that the method is declared in.

The following example returns strings, by converting the property. It also demonstrates overriding.
class A
property number Anum;
property string Astring get;
property string Astring2 get;
end-class;

/* The following is a dynamic reference to the Anum property of the current object,⇒

which might be a subclass of A, so this might not access the A class's implementat⇒

ion of Anum as an instance variable. */

Get Astring
return String(%This.Anum);

Copyright © 1988, 2024, Oracle and/or its affiliates. 365

Application Classes Chapter 7

end-get;

/* The following is a static reference to our &Anum instance variable. Since it doe⇒

s not use %This, it will not be overridden even if the current object is a subclass⇒

of A. */
Get Astring2
return String(&Anum);
end-get;

/* The following overrides the Anum property of our superclass,

in this case by providing another instance variable implementation.
This gives us our own &Anum instance variable. */
class B extends A
property number Anum;
end-class;
. . .
/* Set the Anum property in B. Because of the above definitions, this sets
the &Anum instance variable in the B object, but not the &Anum instance
variable in its superobject. In the absence of other setting, the latter will
be defaulted to 0. */

local B &B = Create B();

&B.Anum = 2;

&MyValue = &B.Astring; /* &MyValue is "2" */

&MyValue = &B.Astring2; /* &MyValue is now "0" */

Using Get and Set with Properties

PeopleSoft recommends against defining properties that are public and mutable in application classes
(similar to public instance variables) because this allows external code to read and change the internal
state of the object without any controls. Instead, modify the property declarations with the Get and Set
keywords.

There is a slight performance advantage, and you write less code, if you use the Get and Set keywords
over using get and set methods.

If you define a property with the Get and Set keywords, you also must define a get or set block in the
same part of the code that contains the method bodies.

Using Read-Only Properties

PeopleCode read-only properties are functionally similar to static variables, as long as the class that
defines the properties initializes them and does not change them. The difference is that you need an
instance of the class to access them.

For example, consider a Category object that has a CategoryType member that can have one of the
following values:

• ‘R’ for Regular

• ‘B’ for Browse

• ‘N’ for News

You can define three read-only properties corresponding to each of these values, REGULAR, BROWSE,
and NEWS, then initialize them to the appropriate values in the constructor of the class.

366 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

When you write code to evaluate the CategoryType of the Category object, perform a test like this:
If (&category.getCategoryType() = &constants.NEWS) then...

PeopleSoft recommends referring to the read-only properties, rather than their literal values, for the
following reasons:

• If you spell a literal value incorrectly, the PeopleCode editor does not catch it; if you spell a read-only
property wrong, it does.

• If you ever need to change the value of a read-only property, you only have to do it in one place.

• It makes the code more maintainable and reusable (because NEWS is more intelligible than ‘N’).

Using Methods and Properties for Collections

Application classes can contain collections. Collections of objects generally have at least the following
methods and properties.

• First()

• Item(Index)

• Next()

• Count (as a property)

All numeric indexes in PeopleCode are one-origin, that is, start all indexes at 1, not 0.

Declaring Constants
PeopleSoft recommends that if constants are inextricably linked to a class, you should define them within
that class. If the constants are more general, potentially used by multiple classes, consolidate the constants
into a constants class at application-level or package-level.

Message catalog set and message numbers are good candidates to centralize into a single constants class.
It can improve the readability of code and make it easier to maintain these values.

For example, you can define a constant MSG_SET_NBR, and then define constant values for each
message that explain a little about what the message represents (like REQUIRED_VALUE_MISSING,
UNIMPLEMENTED_METHOD, or INSUFFICIENT_PRIVILEGES).

Using Variables in Application Classes

This section discusses how to use variables in application classes.

Placement of Variable Declarations

Variables are declared after the class definition (the end-class statement) before anything else. After you
have declared a variable, you can use it anywhere in your program.
class Example

Copyright © 1988, 2024, Oracle and/or its affiliates. 367

Application Classes Chapter 7

method Example_M1(&par As string);

end-class;

Global boolean &b;

method Example_M1
/+ &par as String +/
&b = False;
end-method;

Declaring Private Instance Variables

A private instance variable is private to the class, not just to the object instance. For example, consider a
linked-list class where one instance needs to update the pointer in another instance. Another example is
the following class declaration:
class Example private instance number &Num; end-class;

A method of Example could reference another instance of the Example &Num instance variable as:
&X = &SomeOtherExample.Num;

Avoid making every instance-scoped variable a public property. You should consider each variable
individually and decide if it belongs in the public interface or not. If it does, decide if the variable
warrants get or set modifiers and therefore should be a public property. If the variable only serves internal
purposes to the class, it should be declared as a private instance variable.

Global Variables
PeopleSoft recommends avoiding global variables in application classes unless there is a situation where
no other code works. Generally, an application class should not know about anything scoped outside of
its instance. There are exceptions, since not all application classes should be standalone. For example,
an application class that interacts with the Component Buffer must know about the Component Buffer
objects.

Overriding Variables and Properties

PeopleSoft recommends against overriding of variables and of properties.

Since instance variables are private in scope, you cannot access them in subclasses, but you can redeclare
them in subclasses. The same is true of public properties; you can even explicitly access the overridden or
overriding property. However, overriding is not recommended.

Superclass Reference
A method can refer to a member of its superclass by using the %Super system variable. This construction
is needed only to access superclass members that are hidden by overriding members in the current class.

In the following example, the classes that extend the general BuildingAsset class each have their own
method DisasterPrep, that does the specific processing, then calls the superclass (generic) version of
DisasterPrep.
/* generic building class */
class BuildingAsset

368 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

method Acquire();
method DisasterPrep();
end-class;

method Acquire
%This.DisasterPrep();
end-method;method DisasterPrep
PrepareForFire();
end-method;

/* building in Vancouver */
class VancouverBuilding extends BuildingAssetmethod DisasterPrep();
end-class;

method DisasterPrep
PrepareForEarthquake();%Super.DisasterPrep(); /* call superclass method */
end-method;

/* building in Edmonton */
class EdmontonBuilding extends BuildingAssetmethod DisasterPrep();
end-class;

method DisasterPrep
PrepareForFreezing();%Super.DisasterPrep(); /* call superclass method */
end-method;

local BuildingAsset &Building = Create VancouverBuilding();

&Building.Acquire(); /* calls PrepareForEarthquake then PrepareForFire */

&Building = Create EdmontonBuilding();

&Building.Acquire(); /* calls PrepareForFreezing then PrepareForFire */

Related Links
“%Super” (PeopleCode Language Reference)

Downcasting
Downcasting is the process of determining if an object is of a particular subclass type. If the object has
that subtype (either the object is of that subtype, or is a subtype of it), a reference to the subobject is
returned, otherwise Null is returned. In either case, the type of the resulting value is compatible with the
named subclass type.

This downcast inquiry into the actual type of an object can be used when the object has been passed to
some general facility, then passed back to more specific code. For example, the general facility might be
a dispatch mechanism, or a new storage structure such as a binary balanced tree. These general facilities
won't know about specific types, but it might be necessary for the specific program using the general
facility to recover the actual type of an object that is returned to it by the general facility.

A downcast should not be used when you could add members to a common base class to provide the
same functionality. In other words, if you find yourself using the downcast to test whether the object is
one or another of several related types, you should add members to the common base class to provide
the operations or properties that you are trying to access, then provide separate implementations of those
actions or properties in each specific class.

Copyright © 1988, 2024, Oracle and/or its affiliates. 369

Application Classes Chapter 7

If the downcast operator is to be used in the context of further object expressions (such as references to
other members using dot notation) then the downcast must be enclosed in parentheses to emphasize that
the downcast happens before the member reference.
class Fruit
property number FruitCount;
end-class;

class Banana extends Fruit

property number BananaCount;
end-class;

In the following code example, first the variables are assigned. All the variable assignments are legal, for
Banana is a subtype of Fruit.
local Banana &MyBanana = Create Banana();
local Fruit &MyFruit = &MyBanana; /* okay, Banana is a subtype of Fruit */
local number &Num = &MyBanana.BananaCount;

The next two lines of code don't produce an error, as &MyFruit is currently a Banana at runtime.
&MyBanana = &MyFruit As Banana;

&Num = (&MyFruit As Banana).BananaCount; /* same as &MyBanana.BananaCount */

In the next lines of code, we're reassigning &MyFruit to be of type Fruit, that is, of the superclass Fruit.
When you try to reassign &MyFruit as Banana, &MyBanana is assigned as Null, because &MyFruit is no
longer of type Banana.
&MyFruit = Create Fruit();

&MyBanana = &MyFruit As Banana; /* assigns Null - &MyFruit isn't a Banana */

Exception Handling
Use the Exception class to do exception handling in your PeopleCode. This class provides a try, catch,
and throw mechanism so you don't need to check after each operation for errors. Instead, by the structure
of the try-catch blocks, you can declare when you are interested in handling exceptions, and how you
want to handle them.

Exceptions are instances or subclasses of the PeopleCode Exception class. Oracle recommends that when
applicable, application class methods should throw exceptions instead of communicating back to the
calling code with return values. You can create exceptions by:

• Creating an Exception base class that encapsulates the built-in function call and handles its function
parameters consistently. This is the preferred way.

• Calling the built-in function CreateException.

Since a method can throw exceptions for several different reasons, Oracle recommends that you:

• Create Exception subclasses often.

• Throw strongly typed exceptions.

This allows the calling code to make decisions based on the exception type.

370 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

For example, a method that retrieves customer data from a database might throw an exception named
SQLException if a database error occurs, or an exception named PrivilegeException if the current user
doesn’t have the appropriate permissions to perform the operation. There could be different errors causing
either of these exception types to be thrown in this method; if necessary, you can write the calling code to
examine the specific message numbers and react accordingly.

Oracle recommends that you always catch an exception; if it is not caught, it causes a runtime error. Use a
try-catch block.

Not catching an exception causes a runtime error and can cause PeopleTools to display a dialog box with
the message catalog entry and information about the technical context of the exception. The reasons for
avoiding this by using try-catch blocks are:

• Application code often continues some form of processing even in the event of an exception; you
should not assume that the script stops all processing if an exception occurs.

• The error message that PeopleTools displays might not be appropriate for end-users because of its
technical information.

Related Links
Exception Class Built-in Functions
“CreateException” (PeopleCode Language Reference)
“throw” (PeopleCode Language Reference)
“try” (PeopleCode Language Reference)

Commenting and Documenting Application Classes

This section contains guidelines for writing method header comments, class header comments, and tags
inside the comments.

Understanding Comments and Documentation

Documentation is important in all code, but even more so in application class code, which aims at, and
incurs certain overhead in the name of, higher levels of reuse.

There are two types of inline comments:

• Internal comments, which start with /* and end with */.

• Comments which can potentially be used to generate API documentation, which start with /* and end
with */. You can write method header and class header comments for application classes, and you can
use the comment tags, with this type of comment.

Warning! In application classes you will see the use of /+ +/ style comments. Do not use these in your
PeopleCode. These annotations are generated by the compiler. If you use them, they will be removed the
next time you validate, compile, or save your PeopleCode. They are used to provide signature information
on application class methods and properties, and are regenerated each time the compiler compiles your
application class PeopleCode. Instead, use the standard commenting mechanisms listed above.

Copyright © 1988, 2024, Oracle and/or its affiliates. 371

Application Classes Chapter 7

PeopleSoft recommends keeping a running line of asterisks along one side of an extensive comment to
help the readability of the code by making the entire comment stand out from the surrounding code.

Method Header Comments

The following is an example of documentation conventions for method header comments, which are also
suitable for PeopleCode. It contains comment tags, which are explained below the example.
/**
* Description of what method does
*
* @param a optional description of param a
* @param b optional descriptions of param b
* @exception PrivilegeException thrown if etc, etc
* @exception SQLException thrown if etc., etc.
* @return String - description of potential values
*/
Method myMethod
...
End-method;

Method Comment Tags

The following are the suggested tags for commenting methods.

Tag Description

@param N Specify a description for each method parameter. The name of

the parameter is specified after the keyword @param.

@exception name Specify a description of each exception class. The name of

the exception is specified after the keyword @exception. For
example, the descriptions can explain what causes certain
exceptions to be thrown.

@return Type Specify a description of the return value. The type of data
that is returned is specified after the keyword @return. For
example, explain the potential values a method may return,
whether it returns null in some circumstances, and so on.

Not all methods require documentation. For example, some simple set or get methods have method
signatures that are descriptive enough. In other cases, it may suffice to include a brief sentence in the
header explaining what the method does.

As with methods, PeopleCode get or set blocks should also carry method header comments.

Class Header Comments

Header comments for the class should provide descriptive information about the class, and may optionally
include additional tags, indicating version and author:
/**
* class description

372 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

*
* @version 1.0
* @author amachado
*/

Class Header Comment Tags

The following are the suggested tags for commenting class headers.

Tag Description

@version number Specify a version number for a class.

@author name Specify an author for a class.

Designing Base Classes

This section discusses some ways you can design application classes.

Base Classes
Base classes contain a representation of data elements, such as documents, categories, users, and
miscellaneous security-related entities.

To design the document data element to be integration-friendly, PeopleSoft recommends you start with a
relatively basic base class. Then use more specialized types of documents to create a subclass from that
base class, adding the necessary specialized attributes.

Even if you think of ways to use data to drive the business rules, PeopleSoft recommends that you do not
place them into your data objects. Replicating business rules for every instance of a data element can be
detrimental to performance.

Abstract Base Classes

Abstract base classes contain reusable logic for PeopleCode classes; you do not instantiate them directly.
Instead, you instantiate classes that are subclasses of the abstract base class. Abstract base classes use
placeholder methods for specialized logic, and its subclasses override those methods to provide the
specialized logic.

An example of a candidate for an abstract base class is a class that is used for administering a data entity,
such as an invoice. Such a class has a Save method. A Save method can use normal methods to call
generic validation routines, talk to the database, and handle errors; it can use the placeholder methods for
specialized logic, such as mapping a given data class to a particular database table.

PeopleSoft recommends that you program an active validation check into your placeholder method that
causes a runtime error, such as throwing an UnimplementedMethodException, if an abstract base class
placeholder method hasn’t been overridden.

Copyright © 1988, 2024, Oracle and/or its affiliates. 373

Application Classes Chapter 7

Generic Base Classes

Generic base classes contain reusable logic for PeopleCode classes; you write them to be self-contained,
fully implemented, and capable of being instantiated directly. This differs from abstract base classes,
which are not instantiated directly and need subclasses that override methods to provide specialized logic.

Some examples of classes that are good candidates for creating generic base classes are:

• Service classes, which typically extend a class that provides infrastructure services, such as
configurable application logging.

• Data classes, which typically extend a class that enables you to plug in adapters to support sorting
their instances with custom sort algorithms.

Even when a class does not seem generic because it only has a couple of subclasses, you can still define it
in your design as a generic base class rather than cloning common code across different classes. The main
reason is maintainability: it's easier to maintain a single class than trying to keep track of the same code
scattered across your database.

Utility Classes
Some reusable code is the kind you typically don’t want to inherit, but you just want to use here and there.
Utility classes can serve this purpose.

String parsing, data type conversion, and formatting routines are all good candidates for utility classes.
PeopleSoft recommends that anytime you code something that’s more than just a line or two, and that
seems to be reusable, write it as a utility class.

Declaration of Application Classes

This section provides instructions for declaring application classes.

Declaring Application Classes

Application object references are declared in your PeopleCode programs by either the short name of the
class (if the short name is unambiguous amongst all the imported classes), or by the full name of the class.
Like all uses of class names, to use the name in a variable declaration, you must have imported the class.
Application objects can be of Local, Global, or Component scope.

Every application class is a definition of a new data type in PeopleCode, like the record, rowset, or field
data types. The application class includes both the definition of its external interface, its data (properties
and instance variables), and its actions (methods), just like the PeopleSoft delivered classes.

Importing Class Names

When you import a class name, fully-qualifying it is optional. The syntax is:
<package>:<subpackage>:<...>:<classname or wildcard>

374 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

PeopleSoft recommends that you individually import each class when you import multiple classes from
the same package, instead of using wildcards.

Referencing Superclasses
PeopleSoft recommends that you do not set %Super to a new instance of the current class you are
defining because this would start an infinite loop.
/* Do not do this! */
%Super = %This;

Declaring Private Methods

PeopleSoft recommends that you use private methods for succinct operations, even if they aren’t reused,
to improve the readability and maintainability of the code. You can also do this by using many inline
comments.

Scope of an Application Class

Application classes can be instantiated only from PeopleCode. These classes can be used anywhere you
have PeopleCode, that is, in message notification PeopleCode, Component Interface PeopleCode, record
field PeopleCode, and so on.

Application Classes Built-in Functions and Language Constructs

In this section, we discuss the Application classes built-in functions and language constructs, in
alphabetical order.

class

Syntax
class ClassName [{extends | implements} SuperClassName]
[Method_declarations]
[Property_declarations]
[protected
[Method_declarations]
[Instance_declarations]
[Constant_declaration]]
[private
[Method_declarations]
[Instance_declarations]
[Constant_declaration]]
end-class

Where Method_declarations are of the form:

method methodname([MethodParam1 [, MethodParam2...] [Returns Datatype]] [abstract])⇒

Copyright © 1988, 2024, Oracle and/or its affiliates. 375

Application Classes Chapter 7

Where Property_declarations are of the form:

property DataType PropertyName {{[get] | [set]} | [abstract] | [readonly]}

Where Instance_declarations are of the form:

instance DataType &Variable1 [, &Variable2...]

Where Constant_declarations are of the form:

constant &Constant = {Number | String | True | False | Null }

Description
Use the Class language construct to build application classes in an application package. All classes within
a package must be uniquely named, however, classes contained in different packages do not have to be
named uniquely.

External function declarations are allowed in application classes, in the global and component variable
declarations, after the class declaration (after the end-class statement), and before the method definitions.

Parameters

Parameter Description

ClassName Specify the name of the class that you are creating. All classes
within a package must be uniquely named, however, classes
contained in different packages do not have to be named
uniquely.

extends | implements SuperClassName For a regular class, specify the name of the class that this class
extends. If the class is an interface type of class, specify the
name of the interface that this class implements.

Important! You must import the class to extend it.

Method_declarations Specify the methods (and their signature) as used in this class.

Property_declarations Specify the properties, and their usage, in this class.

protected Use this keyword to declare any methods, constants, or

instance variables as protected to the class, that is, are only
visible to the declaring class and subclasses.

private Use this keyword to declare any methods, constants, or

instance variables as private to the class, that is, they can't be
accessed by any other classes.

Instance_declarations Specify any variables that should be in any instance (object) of

the class.

376 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

Parameter Description

Constant_declarations Specify any constants that should be used with this class.

Returns
None.

Example
class Example extends ExampleBase
method NumToStr(&Num As number) Returns string;
method AppendSlash();
property number SlashCount get;
property number ImportantDayOfWeek get set;
property string SlashString readonly;
property date ImportantDate;
private
method NextDayOfWeek(&DoW As number) Returns date;
constant &Sunday = 1;
instance number &BaseString;
end-class;

Related Links
method
property
get
set

get

Syntax
get PropertyName
StatementList
end-get

Description
Use the get language construct when defining properties in an application class that are implemented
by methods rather than an instance variable. All properties within an application class must be uniquely
named.

Parameters

Parameter Description

PropertyName Specify the name of the property that you're implementing.

Copyright © 1988, 2024, Oracle and/or its affiliates. 377

Application Classes Chapter 7

Parameter Description

StatementList Returns the value of the property. In other words, this is a

method which has no parameters and must return the value of
the property.

Returns
Depends on the assignment within StatementList

Example
get FruitCount
Return &MyFruit.Number();
end-get;

Related Links
set
“Return” (PeopleCode Language Reference)

import

Syntax
import PKG_NAME[:SubpackageName[:SubpackageName]]{:ClassName | *}

Description
Before you can use a class name, you must first import it using an import declaration statement at the
beginning of your program.

An import declaration statement names either all the classes in a package or a single application class.

Parameters

Parameter Description

import PKG_NAME Specify the name of the package that you want to import.

:SubpackageName[:SubpackageName] Specify the subpackage path to the class.

ClassName Import only this class of the specified package. You won't have
access to any other classes in the specified package, only this
one.

* Import all the classes of the specified package.

378 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

Returns
None.

Example
The following gives you access to all the classes in the FRUIT package:
import FRUIT:*;

The following gives you access to the Banana class only in the FRUIT package:
import FRUIT:Banana;

The following gives you access to the Apple class only from the Fruit subpackage of the DRINKS
package:
import DRINKS:Fruit:Apple;

Related Links
class

interface

Syntax
interfaceClassName [{extends | implements} SuperClassName]
[Method_declarations]
[Property_declarations]
[protected [Method_declarations]
[Instance_declarations]
[Constant_declaration]]
end-interface

Where Method_declarations are of the form:

method methodname([MethodParam1 [, MethodParam2...] [Returns Datatype]] [abstract])⇒

Where Property_declarations are of the form:

property DataType PropertyName {{[get] | [set]} | [abstract] | [readonly]}

Where Instance_declarations are of the form:

instance DataType &Variable1 [, &Variable2...]

Where Constant_declarations are of the form:

constant &Constant = {Number | String | True | False | Null }

Description
Use the Interface language construct to create classes of type interface in an application package. An
interface class is a purely abstract class.

Copyright © 1988, 2024, Oracle and/or its affiliates. 379

Application Classes Chapter 7

Parameters
An interface does not have private methods or properties, but all the other parameters are identical to the
class language construct.

Returns
None.

Related Links
class

method

Syntax
method MethodName
StatementList
end-method

Description
Use the method statement to define the methods of your application class.

Parameters

Parameter Description

method MethodName Specify the name of the method that you are creating.

StatementList Specify the program of the method, what it does.

Returns
Depends on the method.

Example
method NumToStr
/+ Returns String +/
Return String(&Num);
end-method;

method AppendSlash
&SlashString = &SlashString | "/";
end-method;

Related Links
“Return” (PeopleCode Language Reference)

380 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 7 Application Classes

property
While properties are declared, they do not have explicit definitions like methods. However, you can create
definitions to set or get the value of a property. See set and get.

set

Related Links
get

Syntax
setPropertyName
StatementList
end-set

Description
Use the set language construct when implementing properties in an application class. All properties
within an application class must be uniquely named. The new value for the property is available in the
&NewValue parameter of the set definition.

Note: You cannot create a set-only property. You can create only get-set properties.

Parameters

Parameter Description

set PropertyName Specify the name of the property that you're implementing.

StatementList Change the value of the property to be &NewValue.

Returns
None.

Example
set FruitCount
/+ &NewValue as String +/
&NewValue = &MyFruit.ActiveRowCount;
&FruitCount = &NewValue;
end-set;

Related Links
class

Copyright © 1988, 2024, Oracle and/or its affiliates. 381

Application Classes Chapter 7

382 Copyright © 1988, 2024, Oracle and/or its affiliates.

Chapter 8

Application Data Set Classes

Understanding the Application Data Set Classes

The Data Migration Workbench is designed to manage the complexity of migrating configuration data
across multiple PeopleSoft systems. Data Migration Workbench uses Application Data Sets (ADS) as its
underlying infrastructure. There are five main parts to the Data Migration Workbench:

• The ADS definition designer is used to define ADS definitions, which define the data sets that can
be migrated. Each ADS definition includes a record hierarchy. An ADS definition has associated
validation PeopleCode specified by an application class, which is the main subject of these topics.

• The Project Editor allows you to interactively create projects containing ADS instance data (that is,
the data defined by ADS definitions) and edit their content.

• The Project Manager allows ADS projects to be exported to a file, compared from a file, or copied
from a file.

• The Project Reviewer is used to view the results of compares, including validation.

• The Project Approver invokes the approval framework to assure that the each project has been
properly reviewed and approved before it is copied.

PeopleTools supplies the base class application class, PTADSDEFN:AdsValidationBase, that provides the
basic validation described in the following sections.

Prescribed methods described in the following sections of the validation application class are
automatically invoked when ADS projects are compared or copied. If you wish to provide additional
validation, or to override the base validation, you can implement an application class derived from
PTADSDEFN:AdsValidationBase and register that class in the ADS definition designer part of the Data
Migration Workbench. The derived class should override one or more of the automatically invoked
methods.

Basic Validation
The DoADSValidations method provides basic validation by validating static prompts, translate values,
Y/N values, and required fields. Because basic validation is always triggered for any copy or compare,
you do not need to explicitly call DoADSValidations. Therefore, even when you do not define an
extended application class for a specific ADS definition, basic validations are performed by this method.
If a validation error is detected, DoADSValidations returns false and information about the error is written
to the target database.

Extended Validation
You can extend the AdsValidationBase base class to define specific validation logic for your data sets.
To provide data set-specific validation or transformation logic, you can extend three methods from

Copyright © 1988, 2024, Oracle and/or its affiliates. 383

Application Data Set Classes Chapter 8

the base class and define any additional methods and properties as necessary. The following three
AdsValidationBase class methods can be extended in your custom application class:

• OnPreCopyCompare

• OnPreUpdate

• OnPostCopy

Related Links
“Application Data Set Overview” (Lifecycle Management Guide)
“Defining Extension” (Lifecycle Management Guide)

Importing Application Data Set Classes

The Application Data Set classes are application classes, not built-in classes, like Rowset, Field, Record,
and so on. Before you can use these classes in your PeopleCode program, you must import them into your
program.

An import statement either names a particular application class or imports all the classes in a package.

Using the asterisks after the package name makes all the application classes directly contained in the
named package available. Application classes contained in subpackages of the named package are not
made available.

Related