Enterprise PeopleTools 8.50
PeopleBook: PeopleCode API
Reference
September 2009
Enterprise PeopleTools 8.50 PeopleBook: PeopleCode API Reference
SKU pt850pbr0
Copyright © 1988, 2009, Oracle and/or its affiliates. All rights reserved.
Trademark Notice
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their
respective owners.
License Restrictions Warranty/Consequential Damages Disclaimer
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.
Warranty Disclaimer
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.
Restricted Rights Notice
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S.
Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS
Programs, software, databases, and related documentation and technical data delivered to U.S. Government
customers are "commercial computer software" or "commercial technical data" pursuant to the applicable
Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication,
disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the
applicable Government contract, and, to the extent applicable by the terms of the Government contract, the
additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007).
Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
Hazardous Applications Notice
This software 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 which may create a risk of personal
injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe,
backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates
disclaim any liability for any damages caused by use of this software in dangerous applications.
Third Party Content, Products, and Services Disclaimer
This software and documentation may provide access to or information on 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. 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.
Copyright © 1988, 2009, Oracle and/or its affiliates. All Rights Reserved. iii
Contents
Preface
PeopleCode API Reference Preface .......................................................................................................... cxv
PeopleCode API Reference .......................................................................................................................... cxv
PeopleCode Typographical Conventions .................................................................................................... cxv
Chapter 1
AESection Class ............................................................................................................................................ 1
Understanding AESection Class ..................................................................................................................... 1
How an AESection is Accessed ...................................................................................................................... 2
AESection Example ........................................................................................................................................ 3
Data Type of an AESection Object ................................................................................................................. 5
Scope of an AESection Object ......................................................................................................................... 5
AESection Class Built-in Function .................................................................................................................. 5
AESection Class Methods ............................................................................................................................... 5
AddStep .................................................................................................................................................... 5
Close ......................................................................................................................................................... 6
Open ......................................................................................................................................................... 7
Save .......................................................................................................................................................... 8
SetSQL ..................................................................................................................................................... 9
SetTemplate ............................................................................................................................................ 10
AESection Class Property ............................................................................................................................. 11
IsOpen .................................................................................................................................................... 11
Chapter 2
Analytic Calculation Engine Classes .......................................................................................................... 13
Understanding the Analytic Calculation Engine Classes ............................................................................... 13
Using the Analytic Calculation Engine Classes with Application Engine .............................................. 14
Running Synchronously ................................................................................................................................ 14
Using Trees ................................................................................................................................................... 14
Error Handling .............................................................................................................................................. 15
Data Types for Analytic Calculation Engine Classes ................................................................................... 16
Scope of Analytic Calculation Engine Classes ............................................................................................. 16
Analytic Calculation Engine Classes Built-in Functions .............................................................................. 16
Contents
iv Copyright © 1988, 2009, Oracle and/or its affiliates. All Rights Reserved.
AnalyticInstance Class Methods ................................................................................................................... 16
CheckAsyncStatus .................................................................................................................................. 16
CheckStatus ............................................................................................................................................ 17
Copy ....................................................................................................................................................... 18
Delete ..................................................................................................................................................... 19
GetAnalyticModel .................................................................................................................................. 20
Load ........................................................................................................................................................ 21
RunAsync ............................................................................................................................................... 22
RunSync ................................................................................................................................................. 23
Terminate ............................................................................................................................................... 24
Unload .................................................................................................................................................... 24
AnalyticInstance Class Properties ................................................................................................................. 25
AnalyticType .......................................................................................................................................... 25
ID ............................................................................................................................................................ 25
Messages ................................................................................................................................................ 26
AnalyticModel Class Methods ...................................................................................................................... 26
AddMember ........................................................................................................................................... 26
AttachTree .............................................................................................................................................. 27
CalculateCube ........................................................................................................................................ 28
DetachTree ............................................................................................................................................. 29
GetCubeCollection ................................................................................................................................. 30
GetCellProperties ................................................................................................................................... 30
GetMembers ........................................................................................................................................... 31
GetTree ................................................................................................................................................... 33
Recalculate ............................................................................................................................................. 34
RenameMember ..................................................................................................................................... 35
AnalyticModel Class Property ...................................................................................................................... 35
Messages ................................................................................................................................................ 36
CubeCollection Class .................................................................................................................................... 36
CubeCollection Class Methods ..................................................................................................................... 36
CollapseNode ......................................................................................................................................... 36
DrillIntoNode ......................................................................................................................................... 37
DrillOutOfNode ..................................................................................................................................... 38
ExpandNode ........................................................................................................................................... 39
GetData ................................................................................................................................................... 40
GetDimFilter .......................................................................................................................................... 41
GetDimSort ............................................................................................................................................ 42
GetLayout ............................................................................................................................................... 43
GetRowCount ......................................................................................................................................... 44
GetSlice .................................................................................................................................................. 44
SetData ................................................................................................................................................... 45
SetDimensionOrder ................................................................................................................................ 46
SetDimFilter ........................................................................................................................................... 46
SetDimSort ............................................................................................................................................. 47
SetSlice ................................................................................................................................................... 48
Contents
Copyright © 1988, 2009, Oracle and/or its affiliates. All Rights Reserved. v
ShowHierarchy ....................................................................................................................................... 49
UnsetDimFilter ....................................................................................................................................... 50
UnsetDimSort ......................................................................................................................................... 51
CubeCollection Class Property ..................................................................................................................... 51
Messages ................................................................................................................................................ 52
Chapter 3
Analytic Calculation Engine Metadata Classes ........................................................................................ 53
Understanding the PeopleSoft Analytic Calculation Engine Metadata Classes ........................................... 53
Using the Analytic Calculation Engine Metadata Classes ............................................................................ 54
Inserting and Deleting Objects ................................................................................................................ 54
Building a Rule as an Object ................................................................................................................... 54
Error Handling .............................................................................................................................................. 55
Data Types of the Analytic Calculation Engine Metadata Objects .............................................................. 55
Scope of Analytic Calculation Engine Metadata Objects .............................................................................. 56
How to Import the Analytic Calculation Engine Metadata Classes .............................................................. 56
How to Create an Analytic Calculation Engine Metadata Class Object ....................................................... 57
Analytic Calculation Engine Metadata Classes Constructor ........................................................................ 57
AnalyticModelDefn ................................................................................................................................ 58
AnalyticModelDefn Class ............................................................................................................................. 58
AnalyticModelDefn Class Methods .............................................................................................................. 59
AddCube ................................................................................................................................................. 59
AddCubeCollection ................................................................................................................................ 59
AddDimension ....................................................................................................................................... 60
AddExplicitDimensionSet ...................................................................................................................... 61
AddOrganizer ......................................................................................................................................... 62
AddUserFunction ................................................................................................................................... 62
CopyCube ............................................................................................................................................... 63
CopyCubeCollection .............................................................................................................................. 64
CopyDimension ...................................................................................................................................... 65
CopyExplicitDimensionSet .................................................................................................................... 65
CopyTo ................................................................................................................................................... 66
CopyUserFunction ................................................................................................................................. 67
Create ..................................................................................................................................................... 68
Delete ..................................................................................................................................................... 68
DeleteCube ............................................................................................................................................. 69
DeleteCubeCollection ............................................................................................................................ 70
DeleteDimension .................................................................................................................................... 71
DeleteExplicitDimensionSet .................................................................................................................. 71
DeleteOrganizer ..................................................................................................................................... 72
DeleteUserFunction ................................................................................................................................ 73
Get .......................................................................................................................................................... 74
