PeopleTools 8.51 PeopleBook: PeopleCode API Reference

Appendix: Quick Reference for PeopleCode Classes

This appendix discusses:

PeopleCode syntax quick reference
PeopleCode classes alphabetical reference.
Session classes.
Deprecated items and PeopleCode no longer supported.

PeopleCode Syntax Quick Reference

The following is a description of the PeopleCode syntax, as derived from the PeopleCode parser. This description uses these metacharacters:

Metacharacter	Description
[ ]	Brackets are used to indicate optional portions.
...	Ellipses are used to indicate that the preceding part (often optional) repeats an arbitrary number of times.
\|	Vertical bars are used to separate alternatives. They indicate that one of the alternatives should be present. The alternatives extend only to the immediately enclosing parentheses or brackets (if any).
()	Parentheses are used to group portions of definitions to limit the scope of alternatives (\|) or optionality (...).
'symbols'	Quoted characters in keyword style are keywords or punctuation in the language. They should appear literally, without the quotation marks.

The following is the PeopleCode language syntax quick reference:

Term	Syntax
Program	ImportList (DeclList TopStList \| ClassDefn )
ImportList	[ ImportDecl ‘;’ ]...
ImportDecl	‘import’ PackageName [ *‘:’ ‘’** ]
PackageName	Id [ ‘:’ Id ]...
ClassDefn	ClassDecl [ ‘;’ ExtDecls ] [ ‘;’ MethodDefns ]
ClassDecl	‘class’\| ‘interface’' Id [ Extends ] [ ClassPublics ] [ ClassProtecteds ] [ ClassPrivates ] ‘end-class’ \| ‘end-interface’
Extends	‘extends’ \| ‘implements’ QualifiedId
QualifiedId	[ PackageName ‘:’ ] Id
ClassPublics	ClassPublic [ ‘;’ ClassPublic ]...
ClassPublic	MethodDecl \| PropertyDecl
MethodDecl	‘method’ Id ‘(’ [ MethodParameters ] ‘)’ [ 'abstract' ] [ ‘returns’ PeopleCodeType ]
MethodParameters	MethodParameter [ ‘,’ MethodParameter ]...
MethodParameter	‘&’ Id ‘as’ PeopleCodeType [ ‘out’ ]
PropertyDecl	‘property’ PeopleCodeType Id [ (‘get’ [ ‘set’ ] \| 'abstract' ) \| ‘readonly’ ]
ClassPrivates	‘private’ [ ClassPrivate [ ‘;’ ClassPrivate ]... ]
ClassPrivate	MethodDecl \| InstanceDecl \| ConstantDecl
ClassProtecteds	‘protected’ [ ClassProtected [ ‘;’ ClassProtected ]... ]
ClassProtected	MethodDecl \| InstanceDecl \| ConstantDecl
InstanceDecl	‘instance’ VarDeclare
ExtDecls	ExtDecl [ ‘;’ ExtDecl ]...
MethodDefns	MethodDefn [ ‘;’ MethodDefn ]...
MethodDefn	MethodMethod \| GetMethod \| SetMethod
MethodMethod	‘method’ Id StList ‘end-method’
GetMethod	‘get’ Id StList ‘end-get’
SetMethod	‘set’ Id StList ‘end-set’
TopStList	TopStmt [ ‘;’ TopStmt ]...
TopStmt	Stmt
StList	Stmt [ ‘;’ Stmt ]...
Stme	[ LValue [ Assign ] \| If \| Evaluate \| While \| Repeat \| For \| Accept \| Break \| Return \| Exit \| Error \| Warning \| Try \| Throw \| LocalDecl ]
Assign	‘=’ Expression
If	‘if’ LogicalExpression ‘then’ StList [ ‘else’ StList ] ‘end-if’
Evaluate	‘evaluate’ Expression [ WhenExpr... StList ]... [ ‘when-other’ StList ] ‘end-evaluate’
WhenExpr	‘when’ [ RelOp ] Expression
While	‘while’ LogicalExpression StList ‘end-while’
Repeat	‘repeat’ StList ‘until’ LogicalExpression
For	‘for’ Variable ‘=’ Expression ‘to’ Expression [ ‘step’ Expression ] StList ‘end-for’
Accept	‘accept’
Return	‘return’ [ Expression ]
Break	‘break'
Exit	‘exit’ [ Expression ]
Warning	‘warning’ Expression
Error	‘error’ Expression
Try	‘try’ StList (‘catch’ QualifiedId ‘&’ Id StList )... ‘end-try’
Throw	‘throw’ Expresssion
LocalDecl	‘local’ PeopleCodeType ‘&’ Id [ (',' ‘&’ Id)... \| ‘=’ Expression ]
Continue	'Continue'
LogicalExpression	LogicalTerm [ ‘or’ LogicalTerm ]...
LogicalTerm	Relation [ ‘and’ Relation ]...
Relation	‘not’ Relation \| Expression [ Relop Expression ]
Relop	‘not’ Relop \| ‘<’ \| ‘<=’ \| ‘=’ \| ‘>=’ \| ‘>’ \| ‘!=’ \| ‘<>’
Expression	Term [ (‘+’ \| ‘-’ \| ‘\|’ ) Term ]...
Term	Power [ *(‘’ \| ‘/’ )** Power ]...
Power	Primary [ ‘’** Primary ]...
Primary	LValue [ ‘as’ QualifiedId ] \| Number \| String \| ‘true’ \| ‘false’ \| 'null' \| ‘-’ Primary \| ‘create’ QualifiedId Call
LValue	LValueStart [ LValueObject \| LValueSubscript ]...
LValueStart	Variable \| Id Call \| '@' Primary \| '%' BuiltinVar \| ‘(’ LogicalExpression ‘)’
LValueObject	'.' Id [ Call ] \| Call
LValueSubscript	'[' Expression [ ',' Expression ]... ']'
Variable	‘&’ Id \| Id [ ‘.’ ( Id \| String ) ] \| ‘^’
Call	‘(’ [ Expression [ ‘,’ Expression ]... ] ‘)’
Constant	Number \| String \| ‘true’ \| ‘false’ \| 'null' \| QualifiedId ‘:’ Id
DecList	[ Decl ‘;’ ]...
Decl	‘local’ VarDeclare \| ‘function’ Function \| ConstDecl \| ExtDecl
VarDeclare	PeopleCodeType ‘&’ Id [ ‘,’ ‘&’ Id ]...
Function	Id [ ‘(’ InternalParameters ‘)’ ] [ ‘returns’ PeopleCodeType ] [ ‘noexport’ ] [ ‘doc’ String ] TopStList ‘end-function’
InternalParameters	[ InternalParameter [ ‘,’ InternalParameter ]... ]
InternalParameter	‘&’ Id [ ‘as’ PeopleCodeType ]
ConstDecl	‘constant’ ‘&’ Id ‘=’ ( Number \| String \| ‘true’ \| ‘false’ \| 'null' )
ExtDecl	‘global’ VarDeclare \| ‘component’ VarDeclare \| ‘declare’ Declare
Declare	‘function’ Id (‘library’ DeclareLibrary \| ‘peoplecode’ DeclarePC )
DeclareLibrary	String [ ‘alias’ String ] [ ‘(’ ExternalParameters ‘)’ ] [ ‘returns’ ExternalType [ ‘as’ PeopleCodeType ] ]
ExternalParameters	[ ExternalParameter [ ‘,’ ExternalParameter ]... ]
ExternalParameter	ExternalType [ ‘value’ \| ‘ref’ ] [ ‘as’ PeopleCodeType ]
DeclarePC	Variable EventType
PeopleCode Type	[ ‘array’ ‘of’ ]... (‘number’ \| ‘string’ \| ‘date’ \| ‘time’ \| ‘datetime’ \| ‘any’ \| ‘boolean’ \| ‘object’ \| ‘array’ \| ‘integer’ \| ‘float’ \| QualifiedId )
ExternalType	‘boolean’ \| ‘integer’ \| ‘long’ \| ‘uinteger’ \| ‘ulong’ \| ‘string’ \| ‘lstring’ \| ‘ustring’ \| ‘float’ \| ‘double’

PeopleCode Classes Alphabetical Reference

This section provides an overview of typographical conventions and visual cues and lists the PeopleCode classes in alphabetical order, along with the functions, methods and properties associated with that class.

Typographical Conventions and Visual Cues

This table describes the typographical conventions and visual cues that are used in this quick reference:

Typographical Convention or Visual Cue	Description
^D	Identifies the default method for a class.
^RO	Identifies a read-only property. Properties that aren't identified as read-only are read-write.

In addition, the usual PeopleCode typographical conventions are used to distinguish between different elements of the PeopleCode language, such as keyword to indicate keywords or syntax that must be entered exactly as shown, variable for arguments, parameters, and so on.

AESection

This section lists the functions, methods, and properties, as well as returns (if applicable) for the AESection class.

Function

Function	Returns
GetAESection(applid, ae_section [, effdt])	AESection object

Methods

Method	Returns
AddStep(ae_step_name [,NewStepName])	None
Close()	None
Open(ae_applid, ae_section, [effdt])	AESection object
Save()	None
SetSQL(action_type_string, string)	None
SetTemplate(ae_applid, ae_section)	None

Property

Property	Returns
IsOpen	Boolean ^RO

Analytic Calculation Engine Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the Analytic Calculation Engine Classes.

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

Functions

Function	Returns
CreateAnalyticInstance(AnalyticType, AIID, Descr, AppClassName, MethodName, &RecordRef, Force)	AnalyticInstance object
GetAnalyticInstance(AIID)	AnalyticInstance object

AnalyticInstance Methods

Method	Returns
CheckAsyncStatus()	Number
CheckStatus()	Constant
Copy(NewAIID, ForceDelete, &Record)	None
Delete(ForceUnload, &RecordRef)	None
GetAnalyticModel((Model. ModelName)	AnalyticModel object
GetTraceLevel()	Integer
Load((Message. MessageName), Sync, IdleTimeOut)	String
RunAsync()	None
RunSync()	None
SetTraceLevel(TraceLevel)	Number
Terminate()	None.
Unload()	None

AnalyticInstance Properties

Property	Returns
AnalyticType	String^RO
ID	Integer^RO
Messages	Multi-dimensional array of any^RO

AnalyticModel Methods

Method	Returns
AddMember(DimName, MemberName)	None
AttachTree(DimName, TreeName, SetId, UserKeyValue, EffDt, NodeName, OverrideRecord, DetailStartLvl, TreeDiscardLvl)	None
CalculateCube(CubeName, Sync)	None
DetachTree(DimName)	None
GetCubeCollection(CubeCollName)	CubeCollection object
GetCellProperties(CubeName, &Node)	Array of string
GetMembers(DimName, DimFilter)	Two-dimensional array
GetTree(DimName)	Array of string
Recalculate(Sync)	String
RenameMember(DimName, OrigMemberName, NewMemberName)	None

AnalyticModel Property

Property	Returns
Messages	Multi-dimensional array of any^RO

CubeCollection Methods

Method	Returns
CollapseNode(DimName, &Node)	None
DrillIntoNode(DimName, &Node)	None
DrillOutOfNode(DimName, &Node)	None
ExpandNode(DimName, &Node, ExpandAll)	None
GetData(&DataRowset, StartRow, EndRow[, NetChanges])	None
GetDimFilter(DimName)	String
GetDimSort(DimName)	Array
GetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray)	None
GetRowCount()	Integer
GetSlice(&SliceRecord)	None
SetData(&DataRowset)	None
SetDimensionOrder(&FieldNames)	None
SetDimFilter(DimName, DimFilter)	None
SetDimSort(DimName, IsAscending[, Key1, IsAscending2, Key2, IsAscending3, Key3])	None
SetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray	None
SetSlice(&SliceRecord)	None
ShowHierarchy(DimName, Show)	None
UnsetDimFilter(DimName)	None
UnsetDimSort(DimName)	None

CubeCollection Property

Property	Returns
Messages	Multi-dimensional array of any^RO

Analytic Calculation Engine Metadata Classes

This section lists the methods and properties, as well as returns (if applicable) for the Analytic Calculation Engine metadata classes.

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

AnalyticModelDefn Methods

Method	Returns
AddCube(CubeName)	CubeDefn object
AddCubeCollection(CubeCollectionName)	CubeCollectionDefn object
AddDimension(DimName)	DimensionDefn object
AddExplicitDimensionSet (ExplicitDimSetName)	ExplicitDimensionSet object
AddOrganizer(OrganizerName)	OrganizerDefn object
AddUserFunction(UserFunctionName)	UserFunction object
CopyCube(CubeName, NewCubeName)	CubeDefn object
CopyCubeCollection(CubeCollectionName, NewCubeCollectionName)	CubeCollectionDefn object
CopyDimension(DimName, NewDimName)	DimensionDefn object
CopyExplicitDimensionSet(OldExplicitDimSetName, NewExplicitDimSetName)	ExplicitDimensionSet object
CopyTo(NewModelName)	AnalyticModelDefn object
CopyUserFunction(UserFunctionName, NewUserFunctionName)	UserFunctionDefn object
Create()	None
Delete()	None
DeleteCube(CubeName, ForceDelete)	None
DeleteCubeCollection(CubeCollectionName, ForceDelete)	None
DeleteOrganizer(OrganizerName)	None
DeleteDimension(DimensionName)	None
DeleteExplicitDimensionSet(ExplicitDimensionSetName)	None
DeleteUserFunction(UserFunctionName, ForceDelete)	None
Get()	None
GetCube(CubeName)	CubeDefn object
GetCubeCollection(CubeCollection)	CubeCollectionDefn object
GetCubeCollectionNames()	Array of string
GetCubeNames()	Array of string
GetDimension(DimName)	DimensionDefn object
GetDimenstionNames()	Array of string
GetExplicitDimensionSet	ExplicitDimensionSet object
GetExplicitDimensionSetNames	Array of strings
GetOrganizer(OrganizerName)	OrganizerDefn object
GetOrganizerNames()	Array of string
GetUserFunction(UserFunctionNames)	UserFunctionDefn object
GetUserFunctionNames()	Array of string
Rename(NewModelName)	None
RenameCube(CubeName, NewCubeName, ForceRename)	None
RenameCubeCollection(CubeCollectionName, NewCubeCollectionName, ForceRename)	None
RenameDimension(DimensionName, NewDimName, ForceRename)	None
RenameExplicitDimensionSet(ExplicitDimSetName, NewExplicitDimSetName, ForceRename)	None
RenameOrganizer(OrganizerName, NewOrganizerName, ForceRename)	None
RenameUserFunction(UserFunctionName, NewUserFunctionName, ForceRename)	None
Save()	None
Validate()	Boolean

AnalyticModelDefn Properties

Property	Returns
CircularFomulaWarn	Boolean
Description	String
IsValid	Boolean^RO
LongDescription	String
MaxDelta	Integer
MaxIterations	Integer
Messages	Multi-dimensional array of any^RO
Name	String^RO
ResolveCircularDeps	Boolean

DimensionDefn Properties

Property	Returns
AggregateSequence	Number^RO
AggregationUserFunction	String
Comments	String
Name	String^RO
TotalMemberName	String

ExplicitDimensionSet Methods

Method	Returns
AttachDimension(DimName)	None.
DetachDimension(DimName)	None.
GetDimensionName()	Array of string.

ExplicitDimensionSet Properties

Property	Returns
Name	String ^RO
SequenceNumber	Number ^RO

CubeDefn Methods

Method	Returns
AttachDimension(DimName)	None
DetachDimension(DimName)	None
GetCauses(CauseType)	Array of string
GetCircularDeps(DimName)	Array of string
GetDimensionAggregate(DimName)	String
GetEffects(EffectType)	Array of string
GetDimensionNames()	Array of string
GetRule(DimensionName)	RuleDefn object
SetDimensionAggregate(DimName, UserFunctionName)	None
SetRule(&RuleDefn)	None
UsesDimension(DimName)	Boolean

CubeDefn Properties

Property	Returns
CalcAggregates	Boolean
Comments	String
DimensionCount	Number^RO
FormatType	Varies
IsVirtual	Boolean
Name	String^RO
Rule	String
ValueDimensionName	String

CubeCollectionDefn Methods

Method	Returns
AttachCube(CubeName)	None
DetachCube(CubeName)	None
GetAggregateMapping(PartName, IsCube)	String
GetCubeNames()	Array of string
GetDimensionNames()	Array of string
GetDimSort(DimensionName)	Array of string
GetFieldMapping(PartName, IsCube)	String
GetFilter(DimensionName)	String
GetPersistAggregate(DimensionName)	String
SetAggregateMapping(PartName, IsCube, AggregateFieldName)	String
SetDimSort(DimName, IsAscending[,CubeName1, IsAscending2, CubeName2, IsAscending3, CubeName3])	None
SetFieldMapping(PartName, IsCube, FieldName)	None
SetFilter(DimensionName, FilterName)	None
SetPersistAggregate(DimensionName, AggregateType)	None
UsesCube(CubeName)	Boolean
UsesDimension(DimensionName)	Boolean

CubeCollectionDefn Properties

Property	Returns
AggregateRecName	String
Comments	Number^RO
CubeCount	Number^RO
DimensionCount	Number^RO
Name	String^RO
RecordName	String

UserFunctionDefn Properties

Property	Returns
Comments	String
Name	String^RO

UserFunctionDefn Methods

Method	Returns
GetRule( )	RuleDefn object
SetRule(&Rule)	None

OrganizerDefn Methods

Method	Returns
AttachPart(PartName, PartType)	None
DetachPart(PartName, PartType	None
GetPartNames()	Array of string
UsesPart(PartName, PartType)	Boolean

OrganizerDefn Properties

Property	Returns
Comments	String
Name	String^RO

RuleDefn Methods

Method	Returns
AddRuleExpression(&Expr)	None
GenerateRule ( )	None

RuleDefn Property

Property	Returns
RuleString	String^RO

Assignment Method

Method	Returns
GenerateRule()	String

Assignment Properties

Property	Returns
Expression	Depends on value
Variable	String

Comparison Method

Method	Returns
GenerateRule ()	String

Comparison Properties

Property	Returns
Operand1	RuleExpression object
Operand2	RuleExpression object
Type	String ^RO

Constant Method

Method	Returns
GenerateRule()	String

Constant Properties

Property	Returns
Type	String ^RO
Value	String ^RO

Cube Methods

Method	Returns
AddIndex(&MemberReference)	None
GenerateRule()	String
GetIndexes()	Array of MemberReference objects

Cube Property

Property	Returns
Name	String ^RO

ExpressionBlock Methods

Method	Returns
AddRuleExpression(&Expr)	None.
GetRuleExpressions()	Array of rule expression objects.

FunctionCall Methods

Method	Returns
AddArgument(&RuleExpression)	None
GenerateRule()	String
GetArguments()	Array of RuleExpression objects

FunctionCall Properties

Property	Returns
Name	String ^RO
Type	String

MemberReference Method

Method	Returns
GenerateRule()	String

MemberReference Properties

Property	Returns
Dimension	String ^RO
Member	String ^RO

Operation Method

Method	Returns
GenerateRule()	String

Operation Properties

Property	Returns
Operand1	RuleExpression object
Operand2	RuleExpression object
Type	String

Variable Method

Method	Returns
GenerateRule()	String

Variable Properties

Property	Returns
Name	String ^RO
Type	String ^RO

Analytic Grid Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the analytic grid classes.

Important! The analytic grid classes are not supported on IBM z/OS and Linux for IBM System z.

AnalyticGrid Function

Function	Returns
GetAnalyticGrid(PAGE.pagename, gridname)	AnalyticGrid object

AnalyticGrid Methods

Method	Returns
GetColumn(ColumnName)	GridColumn object
GetCubeCollection()	CubeCollection object
LoadData()	None
SetAnalyticInstance(AIID)	None
SetLayout(&SlicerArray, &RowAxisArray, &ColumnAxisArray)	None.

AnalyticGrid Properties

Property	Returns
InActive	Boolean
Label	String
ShowGridLines	Boolean
SlicerVisible	Boolean
SummaryText	String

Analytic Type Classes

This section lists the methods and properties as well as returns for analytic type classes.

Important! The analytic type classes are not supported on IBM z/OS and Linux for IBM System z.

AnalyticTypeDefn Methods

Method	Returns
AddModel(ModelName, ModelType	AnalyticTypeModelDefn object
AddRecord(RecordName)	AnalyticTypeRecordDefn object
Create()
Copy(NewAnalyticTypeName, ForceCopy)	AnalyticTyepDefn object
Delete()
DeleteModel(ModelName)	None
DeleteRecord(RecordName)	None
Get()	None
GetModels()	Array
GetRecordNames()	Array of string
Rename(NewAnalyticTypeName)	None
Save()	None

AnalyticTypeDefn Properties

Property	Returns
Comments	String
Description	String
Name	String^RO
AppClassPath	String
OwnerID	String ^RO

AnalyticTypeModelDefn Properties

Property	Returns
Name	String^RO
Type	String^RO

AnalyticTypeRecordDefn Methods

Method	Returns
GetSelectedFields()	Array of string
SetSelectedFields(SelectedFieldsArray)	None
UnsetSelectedFields(FieldName)	None

AnalyticTypeRecordDefn Properties

Property	Returns
Callback	Boolean
Description	String
Name	String^RO
Readable	Boolean
ReadOnce	Boolean
ScenarioManaged	Boolean
SyncOrder	Integer^RO
Writeable	Boolean

Application Classes

This section lists the functions, as well as returns (if applicable) for the application classes.

Functions

Function	Returns
Class classname [{Extends \| Implements}Classname] [Method_declarations] [Property_declarations] [Protected [Method_declarations] [Instance_declarations] [Constant_declaration]] [Private [Method_declarations] [Instance_declarations] [Constant_declaration]] End-Class	None
Get PropertyName StatementList End-Get	Depends on assignment of StatementList
Import PackageName:[PackageName. . .:]{Classname \| *}	None
Interface classname [{Extends \| Implements}Classname] [Method_declarations] [Property_declarations] [Protected [Method_declarations] [Instance_declarations] [Constant_declaration]] End-Interface	None.
Method MethodName StatementList End-Method	Depends on method
Set PropertyName StatementList End-Set	None

Array

This section lists the functions, methods, and properties, as well as returns (if applicable) for the Array class.

Functions

Function	Returns
CreateArray(paramlist)	Array object
CreateArrayAny([paramlist] )	Array object
CreateArrayRept(val, count)	Array object
Split(string, separator)	Array object

Methods

Method	Returns
Clone()	Array object
Find(value)	Index of an element
Get(index)	Element of array
Join([separator [ , arraystart, arrayend [, stringsizehint]]])	String
Next(&index)	Boolean
Pop()	Value of last array element
Push(paramlist)	None
Replace(start, length, [paramlist])	None
Reverse()	None
Set(index)	None
Shift()	Value of first array element
Sort([order])	None
Subarray(start, length)	Array object
Substitute(old_val, new_val)	None
Unshift(paramlist)	None

Properties

Property	Returns
Dimension	Number ^RO
Len	Number

BPEL

This section lists the constructors, methods, and properties, as well as returns (if applicable) for the BPEL classes AsyncFFSend, BPELUtil, and IBUtil.

Constructors

Constructor	Returns
AsyncFFSend()	AsyncFFSend object
BPELUtil()	BPELUtil object
IBUtil()	IBUtil object

AsyncFFSend Method

Method	Returns
OnRequestSend(&Msg)	Message object

BPELUtil Methods

Method	Returns
GetASyncBPELProcessInstanceURL(TransactionID)	String
GetBPELProcessBrowserURL(NodeName)	String
GetOperationType(OperationName)	String
GetSyncBPELProcessURL(NodeName, MessageID)	String
LaunchASyncBPELProcess(OperationName, &Msg, Username, Password)	String
LaunchSyncBPELProcess(OperationName, &Msg, Username, Password)	Message object
UpdateConnectorResponseProperties(&Msg)	None

IBUtil Methods

Method	Returns
GetBPELConsoleURL(NodeName)	String
GetBPELDomain(NodeName)	String
GetMessageId(TransactionID)	String
GetNode(MessageID)	String
GetNumberOfRoutings(ServiceOperationName)	Number
GetStatus(TransactionID)	String
GetTransactionId(MessageId)	String

Charting Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the charting class.

Charting Classes Functions

Function	Returns
CreateObject("Chart")	Chart object
GetChart(RecordName.FieldName)	Chart object
GetChartURL(&Chart)	String
GetGanttChart([Recordname.FieldName])	Gantt chart object
GetOrgChart([Recordname.FieldName])	OrgChart chart object
GetRatingBoxChart([Recordname.FieldName])	RatingBoxChart chart object

Chart Class Methods

Method	Returns
Reset()	None
SetColorArray(&Array_of_Color)	None
SetData({Record_Name \| &Rowset})	None
SetDataAnnotations(Recordname.FieldName)	None
SetDataColor(Record_Name.Field_Name)	None
SetDataGlyphScale(Recordname.FieldName)	None
SetDataHints(Record_Name.Field_Name)	None
SetDataSeries(Record_Name.Field_Name)	None
SetDataURLs(URLString)	None
SetDataXAxis(Record_Name.Field_Name)	None
SetDataYAxis(Record_Name.Field_Name)	None
SetLegend(&Array_of_String)	None
SetOLData({Record_Name \| &Rowset})	None
SetOLDataAnnotations(Recordname.FieldName)	None
SetOLDataGlyphScale	None
SetOLDataSeries(Record_Name.Field_Name)	None
SetOLDataXAxis(Record_Name.Field_Name)	None
SetOLDataYAxis(Record_Name.Field_Name)	None
SetXAxisLabels(&Array_of_Any)	None
SetYAxisLabels(&Array_of_Any)	None

Chart Class Properties

Property	Returns
DataStartRow	Number
DataWidth	Number
GridLines	String
GridLineType	String
HasLegend	Boolean
Height	Number
ImageMap	Image map ^RO
IsDrillable	Boolean
IsPlainImage	Boolean
IsTrueXY	Boolean
IsYAxisInteger	Boolean
LegendMaxEntries	Number
LegendPosition	String
LegendStyle	String
LineType	String
MainTitle	String
MainTitleOrient	String
MainTitleStyle	String
OLLineType	None
OLType	None
RevertToPre850	Boolean
ShowCrossHair	Boolean
Style	String
StyleSheet	String
Type	String
Width	Number
XAxisCross	Number
XAxisCrossPoint	Number
XAxisLabelOrient	String
XAxisMax	Number
XAxisMin	Number
XAxisPrecision	Number
XAxisScaleResolution	Number
XAxisStyle	String
XAxisTicks	Number
XAxisTitle	String
XAxisTitleOrient	String
XAxisTitleStyle	String
XRotationAngle	String
YAxisCrossPoint	Number
YAxisLabelOrient	String
YAxisMax	Number
YAxisMin	Number
YAxisPrecision	Number
YAxisScaleResolution	Number
YAxisStyle	String
YAxisTicks	Number
YAxisTitle	String
YAxisTitleOrient	String
YAxisTitleStyle	String
YRotationAngle	String
ZRotationAngle	String

Gantt Methods

Method	Returns
Reset()	None
SetActualEndDate(RecordName.FieldName)	None
SetActualStartDate(RecordName.FieldName)	None
SetActualTaskBarColor(Recordname.FieldName)	None
SetChartArea(Percentage)	None
SetDayFormat(Format)	None
SetHourFormat(Format)	None
SetLegend(&Array_of_String)	None
SetMinuteFormat(Format)	None
SetMonthFormat(Format)	None
SetPlannedEndDate(RecordName.FieldName)	None
SetPlannedStartDate(RecordName.FieldName)	None
SetPlannedTaskBarColor(RecordName.FieldName)	None
SetSecondFormat(Format)	None
SetTableXScrollbar(Scroll_ArrowAmount)	None
SetTaskAppData(RecordName.FieldName1[, RecordName.FieldName2 [,RecordName.FieldName3. . .]])	None
SetTaskAppDataTitles(&TitleArray)	None
SetTaskBarURL(RecordName.FieldName)	None
SetTaskData({Record. RecordName \| &Rowset})	None
SetTaskDependencyChildID(RecordName.FieldName)	None
SetTaskDependencyData({RecordName \| &Rowset})	None
SetTaskDependencyParentID(RecordName.FieldName)	None
SetTaskDependencyType (RecordName, FieldName)	None
SetTaskDependencyURL(RecordName.FieldName)	None
SetTaskDrill(Recordname.FieldName)	None
SetTaskExpanded(RecordName.FieldName)	None
SetTaskHints(RecordName.FieldName)	None
SetTaskID(RecordName.FieldName)	None
SetTaskLabel(RecordName.FieldName)	None
SetTaskLevel(RecordName.FieldName)	None
SetTaskMilestone(RecordName.FieldName)	None
SetTaskName(RecordName.FieldName)	None
SetTaskProgress(RecordName.FieldName)	None
SetTaskProgressBarColor(RecordName.FieldName)	None
SetWBSNumbering(RecordName.FieldName)	None
SetYearFormat(Format)	None

Gantt Properties

Property	Returns
AxisEndDateTime	Datetime
AxisStartDateTime	Datetime
DataEndDateTime	Datetime
DataStartDateTime	Datetime
DataStartRow	Number
DataWidth	Number
GridLines	String
GridLineType	String
HasLegend	Boolean
Height	Number
ImageMap	Image map ^RO
InteractiveEnd	Boolean
InteractiveMove	Boolean
InteractiveProgress	Boolean
InteractiveStart	Boolean
IsDrillable	Boolean
IsPlainImage	Boolean
LegendPosition	String
LegendStyle	String
MainTitle	String
MainTitleStyle	String
PixelsPerRow	Number ^RO
RevertToPre850	Boolean
ShowTaskLabels	Boolean
Style	String
StyleSheet	String
TaskDependencyLineType	Number
TaskMilestoneGlyph	Number
TaskTitle	String
Width	Number
XAxisPosition	Constant
YAxisPosition	Constant

OrgChart Methods

Method	Returns
SetCrumbData(&Rowset)	None
SetCrumbRecord(Record.Record_Name)	None
SetDropdownData(&Rowset)	None
SetDropDownRecord(Record.RecordName)	None
SetLegend(&Array_of_String)	None
SetLegendImg(&Array_of_String)	None
SetNodeData(&Rowset)	None
SetNodeRecord(Record.Record_Name)	None
SetPopUpNodeData(&Rowset)	None
SetPopUpNodeRecord(Record.Record_Name)	None

OrgChart Properties

Property	Returns
CenterFocusNode	Number
ChartScrollType	Number
Collapsed_Msg	String
CollapsedImage	String
CollapseMainIconSpace	Number
CrumbDescrStyle	String
CrumbMaxDisplayLength	Number
CrumbSeparatorImage	String
DefaultImage	String
Direction	Number
DropDownBoxStyle	String
Expanded_Msg	String
ExpandedImage	String
HasLegend	Boolean
Height	Number
ImageHeight	Number
ImageLocation	Number
ImageMouseoverMagnificationFactor	Number
LegendPosition	Number
LegendStyle	String
LegendTopSpace	Number
MainTitle	String
MainTitleStyle	String
MaxDropdownDisplayItem	Number
MaxPopupDisplayNode	Number
NodeDescr1Style	String
NodeDescr2Style	String
NodeDescr3Style	String
NodeDescr4Style	String
NodeDescr5Style	String
NodeDescr6Style	String
NodeDescr7Style	String
NodeMaxDisplayDescLength	Number
OptimizeHorizontalSpace	Number
OptimizeVerticalSpace	Number
PopupHeaderStyle	String
PopupNodeDescr1Style	String
PopupNodeDescr2Style	String
PopupNodeDescr3Style	String
PopupNodeDescr4Style	String
PopupNodeDescr5Style	String
PopupNodeDescr6Style	String
PopupNodeDescr7Style	String
PopupNodeDescr8Style	String
Style	String
SuppressPeopleCodeOnImage	Boolean
SuppressPeopleCodeOnNode	Boolean
UnlinkCrumbDescrStyle	String
VerticalSpace	Number
Width	Number

RatingBoxChart Methods

Method	Returns
SetLegend(&Array_of_String)	None
SetLegendImg(&Array_of_String)	None
SetRBNodeData(&Array_of_String)	None
SetRBNodeRecord(Record.RecordName)	None
SetXAxisLabels(&Array_of_Any)	None
SetYAxisLabels(&Array_of_Any)	None

RatingBoxChart Properties

Property	Returns
BoxMaxDisplayItems	Number
DraggedNodeStyle	String
GridLineType	Number
HasLegend	Boolean
Height	Number
IconOnlySelectedQuadrantStyle	String
IsDragable	Boolean
LegendPosition	Number
MainTitle	String
MainTitleStyle	String
NDMaxDisplayDescLength	Number
PopUpHeaderStyle	String
PopUpHeight	Number
PopUpStyle	String
PopUpWidth	Number
SelectedQuadrantStyle	String
ShowNodeDescription	Boolean
Style	String
ViewAllStyle	String
Width	Number
XAxisBoxNum	Number
XAxisLabelStyle	String
XAxisTitle	String
XAxisTitleStyle	String
YAxisBoxNum	Number
YAxisLabelStyle	String
YAxisTitle	String
YAxisTitleStyle	String

Component Interface

See Component Interface Class Methods and Properties.

Connected Query Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the connected query classes.

Connected Query Classes Constructors

Constructor	Returns
CONQRSMGR([userID], CONQRSNAME);	CONQRSMGR object
SEC_PROFILE()	SEC_PROFILE object
UTILITY()	UTILITY object

CONQRSMGR Methods

Method	Returns
CleanOutputFile()	None
Close()	None
CopyDefn(target_UserID, target_ID)	Boolean
DeleteDefn()	Boolean
ExistsByName (ObjName)	Boolean
Open(IsNew)	Boolean
ResetQueriesPrompt()	None
Run(Prompts, runProcessInfo)	Boolean
RunToWindow()	Number
RunToXMLFormattedString(Prompts)	String
Save()	Boolean
SaveRunControlParms(runCntlID)	Boolean
SetRunControlData(runCntlID, IsNewCtrl, IsChangeDB)	Boolean
Validate()	Boolean
ValidateIfFieldsMapped()	Boolean
ValidateRunControlParms(runCntlID)	Boolean

CONQRSMGR Properties

Property	Returns
Const	CONQRS_CONST object ^RO
Description	String
Details	String
ErrString	String ^RO
ExecutionLog	Boolean ^RO
IgnoreRelFldOutput	Boolean ^RO
IsChanged	Boolean ^RO
IsDebugMode	Boolean ^RO
IsInit	Boolean ^RO
IsPublic	Boolean ^RO
LastUpdatedBy	String ^RO
LastUpdateDTTM	Datetime ^RO
MaxRowsPerQuery	Number
Name	String ^RO
ObjectRowset	Rowset object
OprID	String ^RO
OutProcessFileName	String ^RO
PropertyArray	Array of CONQRSPROPERTY objects
QueriesPromptsArray	Array of QUERYITEMPROMPT objects ^RO
QueryArray	Array of string ^RO
RegisteredBy	String ^RO
RegisteredDTTM	Datetime ^RO
RunCntlId	String ^RO
RunControlParArray	Array of PSCONQRSRUNPRM records ^RO
RunMode	Number ^RO
SchedInfo	SCHED_INFO object
SchedRequestType	String
SecProfile	SEC_PROFILE object ^RO
ShowFormattedXML	Boolean ^RO
Status	String
XMLDataFileName	String ^RO
XMLDataFullName	String ^RO

CONQRSPROPERTY Properties

Property	Returns
PROPDEFAULT	String
PROPNAME	String
PROPVALUE	String
PROPVALUEARRAY	String
PROPVALUEARRAYDESC	String

CONQRS_CONST Properties

Property	Returns
InitExisting	Boolean ^RO
InitNew	Boolean ^RO
MsgSet	Number ^RO
RunCntlId_Auto	String ^RO
RunMode_Prev	Number ^RO
RunMode_Prev_DefRowNumber	Number ^RO
RunMode_Sample	Number ^RO
RunMode_Sched_File	Number ^RO
RunMode_Sched_Web	Number ^RO
RunMode_Window	Number ^RO
RunMode_XMLFormattedString	Number ^RO
SchedRequest_CQR	String ^RO
SchedRequest_XMLP	String ^RO
Stat_Active	String ^RO
Stat_InActive	String ^RO
Stat_InProgress	String ^RO

QUERYITEMPROMPT Properties

Property	Returns
QueryName	String ^RO
QueryPromptRecord	Record object ^RO

SCHED_INFO Properties

Property	Returns
AE_ID	String
DIRLOCATION	String
OPRID	String
OUTDESTTYPE	Number
PRCSFILENAME	String
PROCESS_INSTANCE	String
RUN_CNTL_ID	String

SEC_PROFILE Properties

Property	Returns
CanCreatePublic	Boolean ^RO
CanModify	Boolean ^RO
CanRunQuery	Boolean ^RO

UTILITY Methods

Method	Returns
CheckQryForTreePrompt(QryName, scope)	String
CheckQrySecurity(QryName, IsPublicObject)	Boolean
GetQueryScopeByName(QryName)	Number
ValidateObjectID(ID)	String

Crypt Class

This section lists the methods and properties, as well as returns (if applicable) for the Crypt class.

Function

Function	Returns
CreateObject(“Crypt”)	Crypt object

Methods

Method	Returns
FirstStep()	None
GoToStep(StepNumber)	None
LoadLibrary(LibraryFile, LibraryID)	None
NextStep()	None
Open(ProfileName)	None
SetParameter(Name,Value)	None
UpdateData(Data)	None

Properties

Property	Returns
Result	String ^RO
Verified	Boolean ^RO

Document Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the connected query classes.

Document Classes Functions

Function	Returns
CreateDocument(DocumentKey \| Package, DocumentName, Version)	Document object
CreateDocumentKey(Package, DocumentName, Version)	DocumentKey object

Document Methods

Method	Returns
GenXmlString([validate])	String
GetDocumentKey()	DocumentKey object
GetElement(ElementName)	Collection object, Compound object, or Primitive object
GetRowset()	Rowset object
GetSchema()	String
ParseXmlFromFile(file_name [, validate])	Boolean
ParseXmlFromURL(URL [, validate])	Boolean
ParseXmlString(XML_string [, validate])	Boolean
UpdateFromRowset(&Doc_RS)	Boolean
ValidateData()	Boolean

Document Properties

Property	Returns
DocumentElement	Compound object ^RO

DocumentKey Methods

Method	Returns
SetDocumentKey(Package, DocumentName, Version)	Boolean

DocumentKey Properties

Property	Returns
DocumentName	String ^RO
PackageName	String ^RO
Version	String ^RO

Primitive Methods

Method	Returns
GetEnumName(index)	String
GetParent()	Collection object or Compound object
GetPath()	String

Primitive Properties

Property	Returns
ElementType	Integer ^RO
EnumCount	Integer ^RO
IsChanged	Boolean ^RO
IsInitialized	Boolean ^RO
IsRequired	Boolean ^RO
MaxDefinedDecimalLength	Integer ^RO
MaxDefinedLength	Integer ^RO
Name	String ^RO
OrigValue	String
PrimitiveSubType	Integer ^RO
PrimitiveType	Integer ^RO
SequenceNumber	Integer ^RO
Value	String

Compound Methods

Method	Returns
GetParent()	Collection object or Compound object
GetPath()	String
GetPropertyByIndex(index)	Collection object, Compound object, or Primitive object
GetPropertyByName(prop_name)	Collection object, Compound object, or Primitive object
GetUniqueKey()	Array of string

Compound Properties

Property	Returns
ElementType	Integer ^RO
IsChanged	Boolean ^RO
IsInitialized	Boolean ^RO
IsRequired	Boolean ^RO
Name	String ^RO
PropertyCount	Integer ^RO
SequenceNumber	Integer ^RO

Collection Methods

Method	Returns
AppendItem(&Elem)	Boolean
CreateItem()	Collection object, Compound object, or Primitive object
DeleteItem(index)	Boolean
GetItem(index)	Collection object, Compound object, or Primitive object
GetParent()	Collection object or Compound object
GetPath()	String
InsertItem(&Elem, index)	Boolean

Collection Properties

Property	Returns
CollectionElementType	Integer ^RO
Count	Integer ^RO
DefinedMaxOccurs	Integer ^RO
DefinedMinOccurs	Integer ^RO
ElementType	Integer ^RO
IsChanged	Boolean ^RO
IsInitialized	Boolean ^RO
IsRequired	Boolean ^RO
Name	String ^RO
SequenceNumber	Integer ^RO

Exception Class

This section lists the functions, methods, and properties, as well as returns (if applicable) for the exception class.

Functions

Function	Returns
CreateException(message_set, message_num, default_txt [, subslist])	Exception object
Throw Expression	None
try Protected StatementList catch QualifiedID &Id StatementList end-try	None

Methods

Method	Returns
GetSubstitution(Index)	String
Output()	String
SetSubstitution(Index, String)	None
ToString()	String

Properties

Property	Returns
Context	String ^RO
DefaultText	String
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
MessageSeverity	String ^RO
StackTrace	String ^RO
SubstitutionCount	Number ^RO

Feed Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the feed classes.

Feed Classes Constructors

Constructor	Returns
FeedFactory.createFeed("feed_ID")	Feed object
FeedFactory()	FeedFactory object
FeedFactory.getDataSource("DS_ID")	DataSource object
DataSourceParameter("DSP_ID", &Parent_DS)	DataSourceParameter object
DataSourceParameterValue("ID", &Parent_DSP)	DataSourceParameterValue object
DataSourceSetting("DSS_ID", &Parent_DS)	DataSourceSetting object
Utility()	Utility object
FeedFactory.Utility.getFeedDoc ("feed_ID", Format, &Attributes)	FeedDoc object
FeedDoc.addEntry("entry_ID")	FeedEntry object

Feed Methods

Method	Returns
delete()	Boolean
equals(&Object)	Boolean
execute()	FeedDoc object
getAttribute(attribute_ID)	Attribute object
load()	Boolean
populatePrefData(&FeedRequest)	None
publishToSites(Sites)	None
resetFeedAttributes()	FeedAttributes collection
resetFeedSecurities()	FeedSecurities collection
save()	Boolean
saveAs(new_ID, CopyPrefData)	Feed object
setAttribute(attribute_ID, Value, XML)	Attribute object
setDataSourceById(DataType_ID)	DataSource object
unpublishFromSites(Sites)	None

Feed Properties

Property	Returns
Authorized	Boolean ^RO
CategoryID	String
CreateDTTM	Datetime ^RO
CreateNode	String
CreateOprID	String ^RO
CreatePortal	String
DataSource	DataSource object
DataTypeID	String ^RO
Description	String
FeedAttributes	FeedAttributes collection
FeedAuthorizationOprID	String
FeedAuthorizationOprPWD	String
FeedAuthorizationType	String
FeedCacheTime	not current used
FeedCacheType	not current used
FeedContentUrl	String ^RO
FeedFactory	FeedFactory object
FeedFormat	String
FeedSecurityType	String
FeedUrl	String ^RO
HasAdminParams	Boolean ^RO
HasUserParams	Boolean ^RO
IBOperationName	String
ID	String ^RO
LastPubDTTM	Datetime ^RO
LastUpdDTTM	Datetime ^RO
LastUpdOprID	String ^RO
NameSpaceID	String
ObjectType	String ^RO
OperatingMode	Number ^RO
OwnerID	String
PublishedInSites	Array of string ^RO
Title	String
Utility	Utility object

FeedFactory Methods

Method	Returns
convertFeedLinksToHoverMenu(&Links, Flat)	HoverMenu object
convertFeedLinksToOPML(&Links, Flat)	OPMLDoc object
createFeed(feed_ID)	Feed object
deleteFeed(feed_ID)	Boolean
genFeedUrl(feed_ID, OperationName, SecurityType)	String
genUniqueFeedId(seed)	String
getAllPagedFeedLinks(feed_ID, fromDTTM, allLanguages)	Array of string
getCategory(category_ID, ActiveOnly)	Array of string
getDataSource(DataType_ID)	DataSource object
getFeed(feed_ID, mode)	Feed object
getFeedDoc(&feedRequest)	FeedDoc object
getFeedLink(feed_ID)	Link object
getFeedLinks(&searchRequest)	Link collection
getRelatedFeedsHoverMenu(&Requests)	HoverMenu object
getRelativePageLinkForFeed(feed_ID, currentFeedURL, linkOption, fromDTTM)	String

FeedFactory Properties

Property	Returns
DataSources	DataSource collection ^RO
Feeds	Feed collection ^RO
Utility	Utility object

DataSource Methods

Method	Returns
addParameter(DSparam_ID, Value)	DataSourceParameter object
equals(&Object)	Boolean
getAttributeById(attribute_ID)	Attribute object
getContentUrl()	String
getDataSecurity()	Authorization objects
getParameterById(DSP_ID)	DataSourceParameter object
getParameterDetail()	String
getSettingDetail()	String
isCurrentUserAdmin()	Boolean
isCurrentUserAuthorized()	Boolean
onDelete()	None
resetParameters()	DataSourceParameter collection

DataSource Properties

Property	Returns
AdminPersonalizationPage	PSComponent object
AllowCustomParameters	Boolean ^RO
AllowRealTimeFeedSecurity	Boolean ^RO
DataSourceType	String ^RO
DefaultFeedAttributes	Attribute collection
DefaultIBOperationName	String ^RO
Description	String
HasParameters	Boolean ^RO
HasSettings	Boolean ^RO
IBOperations	IBOperation collection
ID	String ^RO
LongDescription	String
ObjectType	String ^RO
Parameters	DataSourceParameter collection ^RO
ParametersCompleted	Boolean ^RO
Parent	Feed object
PortalSpecificPersonalization	Boolean ^RO
Settings	DataSourceSetting collection ^RO
SettingsCompleted	Boolean ^RO
UserPersonalizationPage	PSComponent object
Utility	Utility object

DataSourceParameter Methods

Method	Returns
addUserValue(DSPValue_ID, Value)	DataSourceParameterValue object
clone()	DataSourceParameter object
equals(&Object)	Boolean
resetUserValues()	UserValues collection
setRangeFromFieldTranslates(FieldName)	None
validateValue(Value, CheckPrompt)	String

DataSourceParameter Properties

Property	Returns
AllowChangesToRequired	Boolean
DefaultValue	String
DefaultValueForDisplay	String ^RO
Description	String
EditType	Number
EvaluatedValue	String ^RO
FieldType	Number
ID	String
Name	String
ObjectType	String ^RO
Parent	DataSource object
PromptTable	String
Range	Array of string
Required	Boolean
SkipValidityChecks	Boolean
UsageType	String
UserValues	UserValues collection ^RO
Utility	Utility object
Value	String
ValueForDisplay	String ^RO

DataSourceParameterValue Methods

Method	Returns
clone()	DataSourceParameterValue object
equals(&Object)	Boolean

DataSourceParameterValue Properties

Property	Returns
Description	String
ID	String ^RO
Name	String
ObjectType	String ^RO
OrderNumber	Number
Parent	DataSourceParameter object
Value	String

DataSourceSetting Methods

Method	Returns
clone()	DataSourceSetting object
equals(&Object)	Boolean
setRangeFromFieldTranslates(FieldName)	None

DataSourceSetting Properties

Property	Returns
DefaultValue	String
DisplayOnly	Boolean ^RO
EditType	Number
Enabled	Boolean
FieldType	Number
ID	String ^RO
LongName	String
Name	String
ObjectType	String ^RO
Parent	DataSource object
PromptTable	String
Range	Array of string ^RO
RefreshOnChange	Boolean
RelatedFieldValue	String
Required	Boolean
ShowRelatedField	Boolean ^RO
Utility	Utility object
Value	String
Visible	Boolean

Utility Methods

Method	Returns
dateStringToUserPref(DateString)	String
datetimeToString(Datetime)	String
decodeXML(String)	String
encodeXML(String)	String
evaluateSysVar(SysVar)	String
genNameSpaceID(NameSpace_ID)	String
getExceptionText(&Exception)	String
getFeedDoc(feed_ID, Format, &Attributes)	FeedDoc object
getFeedMimeType(Format)	String
getFieldTranslates(FieldName)	Array of array of string
getNodeValue(String, Tag)	String
getUserDateFormat()	String
getUserInfo(user_ID)	Array of string
httpStringToDatetime(string)	Datetime
join(&Array, Tag)	String
join2D(&Array, Tag, ChildTags)	String
setMessageHeadersAndMimeType(&Message, &feeddoc, &FeedRequest)	Message object
setNodeValue(Value, Tag)	String
showException(Exception)	None
showInvalidValueException(Name, Value)	None
split()	Array of string
split2D()	Array of array of string
stringToDate(DateString)	Date
stringToDatetime(DatetimeString)	Datetime
validateSysVar(SysVar)	String
viewStringAsAttachment(String, FileName, ViewAttachment)	None

Utility Properties

Property	Returns
ATTACHMENT_URL	String ^RO
AUTHTYPE_PERM	String ^RO
AUTHTYPE_ROLE	String ^RO
DSPARAMETER_INCREMENTAL	String ^RO
DSPARAMETER_MAXROW	String ^RO
DSPARAMETER_SF_MAXMINUTES	String ^RO
DSPARAMETER_SF_PAGING	String ^RO
EDITTYPE_NOTABLEEDIT	Integer ^RO
EDITTYPE_PROMPTTABLE	Integer ^RO
EDITTYPE_TRANSLATETABLE	Integer ^RO
EDITTYPE_YESNO	Integer ^RO
FEEDATTRIBUTE_AUTHOR	String ^RO
FEEDATTRIBUTE_CLOUD	String ^RO
FEEDATTRIBUTE_COMPLETE	String ^RO
FEEDATTRIBUTE_CONTRIBUTOR	String ^RO
FEEDATTRIBUTE_COPYRIGHT	String ^RO
FEEDATTRIBUTE_EXPIRES	String ^RO
FEEDATTRIBUTE_ICONURL	String ^RO
FEEDATTRIBUTE_LOGOURL	String ^RO
FEEDATTRIBUTE_MANAGINGEDITOR	String ^RO
FEEDATTRIBUTE_MAXAGE	String ^RO
FEEDATTRIBUTE_PERSINSTRUCTION	String ^RO
FEEDATTRIBUTE_RATING	String ^RO
FEEDATTRIBUTE_SKIPDAYS	String ^RO
FEEDATTRIBUTE_SKIPHOURS	String ^RO
FEEDATTRIBUTE_TEXTINPUT	String ^RO
FEEDATTRIBUTE_TTL	String ^RO
FEEDATTRIBUTE_WEBMASTER	String ^RO
FEEDATTRIBUTE_XSL	String ^RO
FEEDAUTHTYPE_ALL	String ^RO
FEEDAUTHTYPE_ANONYMOUS	String ^RO
FEEDAUTHTYPE_DEFAULT	String ^RO
FEEDCACHETYPE_NONE	String ^RO
FEEDCACHETYPE_PRIVATE	String ^RO
FEEDCACHETYPE_PUBLIC	String ^RO
FEEDCACHETYPE_ROLE	String ^RO
FEEDFORMAT_ATOM10	String ^RO
FEEDSECUTYPE_PUBLIC	String ^RO
FEEDSECUTYPE_REALTIME	String ^RO
FEEDSECUTYPE_SELECTED	String ^RO
FEEDTYPE_DYNAMIC	String ^RO
FEEDTYPE_PREPUBLISHED	String ^RO
FIELDTYPE_CHARACTER	Integer ^RO
FIELDTYPE_DATE	Integer ^RO
FIELDTYPE_DATETIME	Integer ^RO
FIELDTYPE_LONGCHARACTER	Integer ^RO
FIELDTYPE_NUMBER	Integer ^RO
FIELDTYPE_SIGNEDNUMBER	Integer ^RO
FIELDTYPE_TIME	Integer ^RO
IBSOTYPE_ASYNC	String ^RO
IBSOTYPE_SYNC	String ^RO
IBSOTYPE_UNKNOWN	String ^RO
ICONURL_FEED_A	String ^RO
ICONURL_FEED_IA	String ^RO
INCREMENTALOPTION_NO	String ^RO
INCREMENTALOPTION_YES	String ^RO
LINKTYPE_FIRST	String ^RO
LINKTYPE_LAST	String ^RO
LINKTYPE_NEXT	String ^RO
LINKTYPE_PREVIOUS	String ^RO
MIMETYPE_ATOM	String ^RO
MIMETYPE_OPML	String ^RO
MIMETYPE_XML	String ^RO
OPERATINGMODE_AUTHORIZATION	Integer ^RO
OPERATINGMODE_DEFAULT	Integer ^RO
OPERATINGMODE_DELETION	Integer ^RO
OPERATINGMODE_EXECUTION	Integer ^RO
OPERATINGMODE_EXECUTION_NOENTRY	Integer ^RO
QUERYPARAMETER_CHILDFEEDID	String ^RO
QUERYPARAMETER_DATATYPEID	String ^RO
QUERYPARAMETER_DEFLOCALNODE	String ^RO
QUERYPARAMETER_DSSCOUNT	String ^RO
QUERYPARAMETER_DSSNAME	String ^RO
QUERYPARAMETER_DSSVALUE	String ^RO
QUERYPARAMETER_FEEDFORMAT	String ^RO
QUERYPARAMETER_FEEDID	String ^RO
QUERYPARAMETER_FEEDLIST	String ^RO
QUERYPARAMETER_FEEDTYPE	String ^RO
QUERYPARAMETER_IBTRANSID	String ^RO
QUERYPARAMETER_IFMODIFIEDSINCE	String ^RO
QUERYPARAMETER_IFNONEMATCH	String ^RO
QUERYPARAMETER_KEYWORD	String ^RO
QUERYPARAMETER_LANGUAGE	String ^RO
QUERYPARAMETER_NODENAME	String ^RO
QUERYPARAMETER_PAGENUM	String ^RO
QUERYPARAMETER_PORTALNAME	String ^RO
QUERYPARAMETER_PTPPB_SEARCH_MODE	String ^RO
QUERYPARAMETER_PTPPB_SEARCH_TEXT	String ^RO
RequestInfo	FeedRequest object
SF_MAXMINUTES_ALLMSGS	Integer ^RO
SF_MAXROWOPTION_ALLMSGS	Integer ^RO
SF_MAXROWOPTION_LATESTMSG	Integer ^RO
SF_PAGINGOPTION_NOPAGING	Integer ^RO
SF_PAGINGOPTION_SEGMENTED	Integer ^RO
SYSVAR_INVALID	String ^RO
USAGETYPE_ADMINSPECIFIED	String ^RO
USAGETYPE_FIXED	String ^RO
USAGETYPE_INTERNAL	String ^RO
USAGETYPE_NOTUSED	String ^RO
USAGETYPE_SYSVAR	String ^RO
USAGETYPE_USERSPECIFIED	String ^RO
XMLCHILDELEMENTS_CLOUD	Array of string ^RO
XMLCHILDELEMENTS_PERSON	Array of string ^RO
XMLCHILDELEMENTS_TEXTINPUT	Array of string ^RO
XMLELEMENT_DAY	String ^RO
XMLELEMENT_DESCRIPTION	String ^RO
XMLELEMENT_DOMAIN	String ^RO
XMLELEMENT_EMAIL	String ^RO
XMLELEMENT_HOUR	String ^RO
XMLELEMENT_LINK	String ^RO
XMLELEMENT_NAME	String ^RO
XMLELEMENT_PATH	String ^RO
XMLELEMENT_PORT	String ^RO
XMLELEMENT_PROTOCOL	String ^RO
XMLELEMENT_REGISTERPROCEDURE	String ^RO
XMLELEMENT_TITLE	String ^RO

FeedDoc Methods

Method	Returns
addCategory(category)	Boolean
addEntry(entry_ID)	FeedEntry object
datetimeToString(Datetime)	String
deleteCategory(category)	Boolean
equals(&Object)	Boolean
getEntry(entry_ID)	FeedEntry object
resetEntries()	FeedEntry collection
stringToDatetime(DatetimeString)	Datetime

FeedDoc Properties

Property	Returns
AllowMoreEntries	Boolean ^RO
ApplicationRelease	String ^RO
Categories	Array of string ^RO
ContentUrl	String
Copyright	String
Description	String
Entries	FeedEntry collection ^RO
Expires	Datetime
FeedFormat	String ^RO
FeedUrl	String
FirstUrl	String
Generator	String
ID	String ^RO
LastUrl	String
Logo	String
MaxAge	Number
MaxEntries	Number
NextUrl	String
ObjectType	String ^RO
PreviousUrl	String
RootElement	XmlNode object ^RO
Title	String
Updated	Datetime

FeedEntry Methods

Method	Returns
addCategory(category)	Boolean
addContributor(name, email)	Boolean
addEnclosure(URL, type, length)	Boolean
delete()	None
deleteCategory(category)	Boolean
deleteContributor(name)	Boolean
deleteEnclosure(URL)	Boolean
equals(&Object)	Boolean

FeedEntry Properties

Property	Returns
Author	Array of string
Categories	Array of string ^RO
Comments	String
ContentUrl	String
Contributors	Array of array of string ^RO
Copyright	String
Description	String
Enclosures	Array of array of string ^RO
Expires	Datetime
FeedDoc	FeedDoc object ^RO
FullContent	String
GUID	String
ID	String ^RO
MaxAge	Number
ObjectType	String ^RO
Published	Datetime
Title	String
Updated	Datetime

Field

This section lists the functions, methods, and properties, as well as returns (if applicable) for the field class.

Function

Function	Returns
GetField([recname.fieldname])	Field object

Methods

Method	Returns
AddDropDownItem(CodeString, DescriptionString)	None
ClearDropDownList()	None
EncryptPETKey()	None
DecryptPETKey()	None
GetAuxFlag(FlagNumber)	Boolean
GetLongLabel(LabelID)	String
GetRelated(recname.fieldname)	Field object
GetShortLabel(LabelID)	String
SearchClear()	None
SetCursorPos({PAGE.pagename \| %Page})	None
SetDefault()	None

Properties

Property	Returns
DataAreaCollapsed	Boolean
DecimalPosition	Number
DisplayFormat	String
DisplayOnly	Boolean
DisplayZero	Boolean
DisplayZeroChanged	Boolean
EditError	Boolean
Enabled	Boolean
FieldLength	Number ^RO
FormatLength	Number ^RO
FormattedValue	None
HoverText	String
IsAltKey	Boolean ^RO
IsAuditFieldAdd	Boolean ^RO
IsAuditFieldChg	Boolean ^RO
IsAuditFieldDel	Boolean ^RO
IsAutoUpdate	Boolean ^RO
IsChanged	Boolean ^RO
IsDateRangeEdit	Boolean ^RO
IsDescKey	Boolean ^RO
IsDuplKey	Boolean ^RO
IsEditTable	Boolean ^RO
IsEditXlat	Boolean ^RO
IsFromSearchField	Boolean ^RO
IsInBuf	Boolean ^RO
IsKey	Boolean ^RO
IsListItem	Boolean ^RO
IsNotUsed	Boolean ^RO
IsRequired	Boolean ^RO
IsRichTextEnabled	Boolean ^RO
IsSearchItem	Boolean ^RO
IsSystem	Boolean ^RO
IsThroughSearchField	Boolean ^RO
IsUseDefaultLabel	Boolean ^RO
IsYesNo	Boolean ^RO
Label	String
LabelImage	{Image.imagename \| String}
LongTranslateValue	Any
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
MouseOverMsgNum	Number
MouseOverMsgSet	Number
Name	String ^RO
OriginalValue	Depends on field
ParentRecord	Record Object ^RO
PromptTableName	String ^RO
SearchDefault	Boolean
SearchEdit	Boolean
SetComponentChanged	Boolean
ShortTranslateValue	Any
ShowRequiredFieldCue	Boolean
SmartZero	Boolean
SqlText	String
StoredFormat	String ^RO
Style	String
Type	String ^RO
Value	Depends on field
Visible	Boolean

File

This section lists the functions, methods, and properties, as well as returns (if applicable) for the file class.

Functions

Function	Returns
CreateDirectory(path, [, pathtype])	None
FileExists(filename [, pathtype])	Boolean
FindFiles(filespec_pattern [, pathtype])	Array object
GetFile(filename, mode [, charset] [,pathtype])	File object
GetTempFile(filename, mode [, charset] [,pathtype])	File object

Methods

Method	Returns
Close()	None
CreateRowset()	Rowset object
GetPosition()	Number
GetString([Strip_Line_Terminator])	String
Open(filename, mode [, charset] [, pathtype])	None
ReadLine(string)	Boolean
ReadRowset()	Rowset object
SetFileId(fileid, position)
SetFileLayout(FILELAYOUT.filelayoutname)	Boolean
SetPosition(position)	None
SetRecTerminator(Terminator)	None
WriteLine(string)	None
WriteRaw(RawBinary)	None
WriteRecord(record)	Boolean
WriteRowset(rowset [, Write_Data])	Boolean
WriteString(string)	None

Properties

Property	Returns
CurrentRecord	String ^RO
IgnoreInvalidId	Boolean
IsError	Boolean ^RO
IsNewFileId	Boolean ^RO
IsOpen	Boolean ^RO
Name	String ^RO
TerminateLines	Boolean
UseSpaceForNull	Boolean
ZeroExtend	Boolean

Grid Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the grid classes.

Grid Functions

Function	Returns
GetGrid(PAGE.pagename, gridname [, occursnumber])	Grid object

Grid Methods

Method	Returns
GetColumn(columname)^D	Grid column object
EnableColumns(&Array)	None
LabelColumns(&Array)	None
SetProperties(&Array)	None
ShowColumns(&Array)	None

Grid Properties

Property	Returns
gridcolumnname	Grid column object
Label	String
SummaryText	String

GridColumn Properties

Property	Returns
Enabled	Boolean
Label	String
Name	String ^RO
Visible	Boolean

Internet Script Classes

This section lists the system variables, methods, and properties, as well as returns (if applicable) for the internet script (iScript) classes.

Internet Script System Variables

System Variable	Returns
%Request	Request object
%Response	Response object

Request Methods

Method	Returns
GetCookieNames()	Array of string
GetCookieValue(name)	String
GetHeader(name)	String
GetHeaderNames()	Array of string
GetHelpURL(HelpContext)	String
GetParameter(name)	String
GetParameterNames()	Array of string
GetParameterValues(Name)	Array of string

Request Properties

Property	Returns
AuthTokenDomain	String ^RO
AuthType	String ^RO
BrowserPlatform	String ^RO
BrowserType	String ^RO
BrowserVersion	String ^RO
ByPassSignOn	Boolean ^RO
ContentURI	String ^RO
ExpireMeta	String ^RO
FullURI	String ^RO
HTTPMethod	String ^RO
LogoutURL	String ^RO
PathInfo	String ^RO
Protocol	String ^RO
QueryString	String ^RO
RelativeURL	String ^RO
RemoteAddr	String ^RO
RemoteHost	String ^RO
RequestURI	String ^RO
RemoteUser	String ^RO
Scheme	String ^RO
ServerName	String ^RO
ServerPort	String ^RO
ServletPath	String ^RO
Timeout	Integer ^RO

Response Methods

Method	Returns
Clear()	None
CreateCookie(name)	Cookie object
GetCookie(name)	Cookie object
GetCookieNames()	Array of string
GetHeader(name)	String
GetHeaderNames()	Array of string
GetImageURL(ImageName)	String
GetJavaScriptURL(HTML.Name)	Srting
GetStyleSheetURL(STYLESHEET.name)	String
RedirectURL(name)	None
SetContentType(Type)	None
SetHeader(name, value)	None
UseSimpleURL({True \| False})	None
Write(HTML)	None
WriteLine(HTML)	None

Response Properties

Property	Returns
Charset	String ^RO
DefaultStyleSheetName	String ^RO

Cookie Properties

Property	Returns
Domain	String
MaxAge	Number
Name	String ^RO
Path	String
Secure	Boolean
Value	String

Java

This section lists the functions for the Java class.

Functions

Function	Returns
CopyFromJavaArray(JavaArray, &PeopleCodeArray [, &RestrictionArray])	None.
CopyToJavaArray(&PeopleCodeArray, JavaArray [, &RestrictionArray])	None.
CreateJavaArray(ElementClassName[], NumberOfElements)	Java object
CreateJavaObject(ClassName [ConstructorParams])	Java object
GetJavaClass(ClassName)	Java object

Mail Classes

This section lists the methods and properties as well as returns (if applicable) for the mail (MultiChannel Framework) classes.

Constructors

Constructor	Returns
MCFBodyPart()	MCFBodyPart object
MCFGetMail()	MCFGetMail object
MCFOutboundEmail()	MCFOutboundEmail object
MCFMailStore()	MCFMailStore object
SMTPSession()	SMTPSession object

MCFBodyPart Methods

Method	Returns
AddHeader(HeaderName, HeaderValue)	None.
GetHeader(HeaderName)	String
GetHeaderCount()	Number
GetHeaderName(Index)	String
GetHeaderNames()	String
GetHeaderValues(Index)	String
GetUnparsedHeaders()	String
SetAttachmentContent({FilePath \| FileURL}, FilePathType, FileName, FileDescr, OverrideContentType, OverrideCharset)	None

MCFBodyPart Properties

Property	Returns
AttachmentURL	String
Charset	String
ContentType	String
Description	String
Disposition	String
Filename	String
FilePath	String
FilePathType	String
IsAttachment	Boolean ^RO
MultiPart	String
Text	String

MCFEmail Properties

Property	Returns
BCC	String
BounceTo	String
CC	String
From	String
Importance	String
Priority	Number
Recipients	String
RefIDs	String
ReplyIDs	String
ReplyTo	String
Sender	String
Sensitivity	String
Subject	String
Text	String

MCFGetMail Methods

Method	Returns
CreateQuarantineFolder ( )	Boolean
GetCount ( )	Number
GetEmailCount(user, password, server, node)	Number
ReadAllEmailHeadersWithAttach(user, password, server, node)	Rowset object
ReadEmails (Count)	String
ReadEmailsWithAttach(User, password, server, node, count)	Rowset object
ReadEmailsWithUID (UID)	Array of MCFInboundEmail objects
ReadEmailWithAttach(User, password, server, node, UID)	Rowset object
ReadHeaders ( )	Array of objects
RemoveEmail(user, password, server, node, UID list)	Boolean
RemoveEmails(UID_List)	String
SetMCFEmail (user, password, server, node)	None

MCFGetMail Properties

Property	Returns
AttachmentRoot	String
ContentTypes	String
ErrorCount	Number ^RO
IBNode	String
MailServer	String
Password	String
QuarantineCount	Number ^RO
QuarantineFolder	String
Status	String ^RO
UserID	String

MCFInboundEmail Methods

Method	Returns
DumpToFile (&File)	None
GetAttachments ( )	Array of objects
GetFrom ( )	Array of string
GetParts ( )	Array of objects
GetSender ( )	Array of string
ReadFromDatabase (Email_ID)	Boolean
SaveToDatabase ( )	Number

MCFInboundEmail Properties

Property	Returns
AttachList	String
AttachSizes	String
DttmReceived	String
DttmSaved	String
DttmSent	String
IBNode	String
Language	String
MessageID	String
NotifyCC	String
NotifyTo	String
OffsetReceived	Number
OffsetSent	String
Server	String
Size	Number
Status	String ^RO
UID	String
User	String

MCFMailStore Methods

Method	Returns
AuthorizeEmailAttach(email ID, authentication name, authentication type , operation)	Boolean
DeleteEmail(email ID, [forced delete])	Boolean
RetrieveEmail(email ID)	Rowset object
StoreEmail(rowset, row)	Number

MCFMailUtil Methods

Method	Returns
DecodeText (TextToDecode, &DecodedText)	Boolean
DecodeWord (WordToDecode, &DecodedWord)	Boolean
EncodeText (TextToEncode, charset, EncodingStyle, &EncodedText)	Boolean
EncodeWord (WordToEncode, charset, EncodingStyle, &EncodedWord)	Boolean
GetErrorMsgParam(&index)	String
IsDomainNameValid(domainname)	Boolean
IsEmailServerAvailable (server, port, user, password)	Boolean
ParseRichTextHtml(richtext)	Array of MCFBodyPart objects
ValidateAddress (addresslist)	Boolean

MCFMailUtil Properties

Property	Returns
badaddresses	Array of string^RO
ErrorDescription	String ^RO
ErrorDetails	String^RO
ErrorMsgParamsCount	Integer^RO
imagesLocation	String
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO

MCFMultiPart Methods

Method	Returns
AddBodyPart (&bodyPart)	None
GetBodyPart(Index)	MCFBodyPart object
GetContentType ( )	String
GetCount ( )	Number

MCFMultiPart Property

Property	Returns
SubType	String

MCFOutboundEmail Methods

Method	Returns
AddAttachment({FilePath \| FileURL}, FilePathType, FileName, FileDescr, OverrideContentType, OverrideCharset [,UploadPageTitle])	None
AddHeader(HeaderName, HeaderValue)	None
GetErrorMsgParam(&index)	String
GetHeader(HeaderName)	Array of string
GetHeaderCount ()	Integer
GetHeaderName(Index)	String
GetHeaderNames ( )	String
GetHeaderValues (Index)	String
Send ( )	Number
SetSMTPParam(ParamName, ParamValue)	None

MCFOutboundEmail Properties

Property	Returns
BackupSMTPPort	Number
BackupSMTPServer	String
BackupSMTPSSLClientCertAlias	String
BackupSMTPSSLPort	Number
BackupSMTPUserName	String
BackupSMTPUseSSL	Boolean
BCC	String
BounceTo	String
CC	String
Charset	String
ContentLanguage	String
ContentType	String
DefaultCharSet	String
Description	String
Disposition	String
ErrorDescription	String ^RO
ErrorDetails	String
ErrorMsgParamsCount	Integer^RO
Filename	String
FilePath	String
FilePathType	String
Importance	String
InvalidAddresses	String ^RO
IsAuthenticationReqd	Boolean
IsOkToSendPartial	Boolean
IsReturnReceiptReqd	Boolean
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
MultiPart	String
Priority	Number
Recipients	String
RefIDs	Number
ReplyIDs	Number
ReplyTo	String
ResultOfSend	Number ^RO
Sender	String
Sensitivity	String
SMTPPort	Number
SMTPServer	String
SMTPSSLClientCertAlias	String
SMTPSSLPort	Number
SMTPUserName	String
SMTPUserPassword	String
SMTPUseSSL	Boolean
StatusNotifyOptions	String
StatusNotifyReturn	String
Subject	String
Text	String
TimeToWaitForResult	Number
UsedDefaultConfig	Boolean ^RO
UsedPrimaryServer	Boolean ^RO
ValidSentAddresses	String ^RO
ValidUnsentAddresses	String ^RO

SMTPSession Methods

Method	Returns
Send(&Email)	Constant
SendAll(&Emails)	Array of numbers
SetSMTPParam(ParamName, ParamValue)	None

SMTPSession Properties

Property	Returns
BackupPort	Number
BackupServer	String
BackupSSLClientCertAlias	String
BackupSSLPort	Number
BackupUserName	String
BackupUserPassword	String
BackupUseSSL	Boolean
IsAuthenticationReqd	Boolean
Port	Number
Server	String
SSLClientCertAlias	String
SSLPort	Number
UsedDefaultConfig	Boolean ^RO
UsedPrimaryServer	Boolean ^RO
UserName	String
UserPassword	String
UseSSL	Boolean

Message Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the message classes.

Message Functions

Function	Returns
AddSystemPauseTimes(StartDay, StartTime, EndDay, EndTime)	Boolean
CreateMessage(OPERATION.messagename [,Message_Type])	Message object
DeleteSystemPauseTimes(StartDay, StartTime, EndDay, EndTime)	Boolean
GetNRXmlDoc(NRID, EntityName)	XmlDoc object
IBPurgeDomainStatus()	Boolean
IBPurgeNodeStatus()	Boolean
NodeDelete(nodeName)	Boolean
NodeRename(oldNodeName, newNodeName)	Boolean
NodeSaveAs(oldNodeName, newNodeName)	Boolean
PingNode(MsgNodeName)	Array of number
PSIGWServiceRequest(&Req_XmlDoc, &Resp_XmlDoc)	Integer
ReValidateNRXmlDoc(NRID, EntityName)	Boolean

Message Methods

Method	Returns
Clone()	Message object
CopyPartRowset(PartIndex, &Rowset)	None.
CopyRowset(source_rowset [, record_list])	None
CopyRowsetDelta(source_rowset [, record_list])	None
CopyRowsetDeltaOriginal(source_rowset, [, record_list])	None
CreateNextSegment()	None
DeleteSegment(Segment)	None
ExecuteEdits([editlevels])	None
GenXMLPartString(PartIndex)	String
GenXMLString()	String
GetContentString([SegmentIndex])	String
GetDocument([segmented_messsage])	Document object
GetPartAliasName(PartIndex)	String
GetPartName(PartIndex)	String
GetPartRowset(PartIndex)	Rowset object
GetPartVersion(PartIndex)	String
GetPartXmlDoc(PartIndex)	XmlDoc object
GetRowset([version])	Rowset object
GetSegment(Segment)	None
GetXmlDoc()	XmlDoc object
LoadXMLPartString(PartIndex, XmlString)	None
LoadXMLString(XMLString)	None
SegmentRestart(TransactionID, Segment_index, segmentByDB)	None
SetEditTable(%PromptTable, RECORD.recname)	None
SetXmlDoc(&XmlDoc)	None
UpdateSegment()	None

Message Properties

Property	Returns
ActionName	String ^RO
AliasName	String ^RO
CurrentSegment	Number ^RO
DoNotPubToNodeName	String
IBInfo	IBInfo object ^RO
IsBulkLoadTruncation	Boolean ^RO
IsDelta	Boolean ^RO
IsEditError	Boolean ^RO
IsEmpty	Boolean ^RO
IsLocal	Boolean ^RO
IsOperationActive	Boolean ^RO
IsParts	Boolean^RO
IsPartsStructured	Boolean^RO
IsRequest	Boolean^RO
IsSourceNodeExternal	Boolean^RO
IsStructure	Boolean ^RO
Name	String ^RO
NRId	String ^RO
OperationName	String^RO
OperationVersion	String^RO
ParentTransactionId	String^RO
PartCount	Number^RO
PubNodeName	String^RO
QueueName	String^RO
QueueSeqId	Number^RO
ResponseStatus	Number ^RO
SegmentCount	Number ^RO
SegmentsByDatabase	Boolean
Size	Number ^RO
TransactionId	String^RO
Version	String^RO

IntBroker System Variable

This section lists the system variables, as well as returns (if applicable) for the IntBroker class.

System Variable	Returns
%IntBroker	IntBroker object

IntBroker Methods

Method	Returns
Cancel(TransactionId, QueueName, DataType, SegmentIndex \| TransactionIdArray, QueueNameArray, DataTypeArray, SegmentIndexArray)	Boolean
ConnectorRequest(&Message)	Message object
ConnectorRequestUrl(URL)	String
DeleteOrphanedSegments(TransactionId)	Boolean
GetArchData(TransactionId, SegmentIndex)	String
GetArchIBInfoData(TransactionId, ParentTransactionId)	String
GetIBInfoData(TransactionId, DataType)	String
GetIBTransactionIDforAE(OperID, RunCtlID)	String
GetMessage([TransactionId, DataType])	Message object
GetMessageErrors(TransactionId)	Array of string
GetMsgSchema(MsgName, MsgVersion)	String
GetSyncIBInfoData(TransactionId, %LogType [, Archive])	String
GetSyncLogData(TransactionId, %LogType [, Archive])	String
InBoundPublish(&Message)	Boolean
IsOperationActive(OperationName [,OperationVersion])	Boolean
MsgSchemaExists(MsgName, MsgVersion)	Boolean
Publish(&Message [, &ArrayofNodeNames] [,IsEnqueued])	None.
Resubmit({TransactionId, QueueName, DataType, SegmentIndex} \| {TransactionIdArray, QueueNameArray, DataTypeArray, SegmentIndexArray})	Boolean
SetMessageError(TransactionID, MsgSet, MsgNumber, Error_Location, ParamListCounter, [Param] ...)	Boolean
SetStatus(&Message, Status)	None
SwitchAsyncEventUserContext(UserID, LanguageCode)	Boolean
SyncRequest([&MsgArray, &NodeNames])	Array of messages
Update(&Message)	Boolean
UpdateXmlDoc(&XmlDoc, TransactionId, DataType)	Boolean

IBInfo Methods

Method	Returns
AddAEAttribute(Name, value	Boolean
AddAttachment(Path)	String
AddAttribute(name, value)	Boolean
AddContainerAttribute(Name, Value)	Boolean
ClearAEAttributes()	None
ClearAttachments()	None
ClearAttributes()	None
ClearContainerAttributes()	None
DeleteAEAttribute(Name)	Boolean
DeleteAttachment(Index \| Content_Id)	Boolean
DeleteAttribute(name)	Boolean
DeleteContainerAttribute(Name)	Boolean
GetAEAttributeName(nIndex)	String
GetAEAttributeValue(nIndex)	String
GetAttachmentContentID(Index)	String
GetAttachmentProperty(Content_ID, Property_Type)	String
GetAttributeName(nIndex)	String
GetAttributeValue(nIndex)	String
GetContainerAttributeName(nIndex)	String
GetContainerAttributeValue(nIndex)	String
GetNumberofAEAttributes()	Integer
GetNumberOfAttributes()	Integer
GetNumberOfContainerAttributes()	Integer
GetTransactionIDforAE()	Number
InsertAEResponseAttributes()	Boolean
LoadConnectorProp(ConnectorName)	Boolean
LoadConnectorPropFromNode(NodeName)	Boolean
LoadConnectorPropFromRouting(RoutingDefnName)	Boolean
SetAttachmentProperty(Content_ID, Property_Type, Value)	Boolean

IBInfo Properties

Property	Returns
AppServerDomain	String
CompressionOverride	String
ConnectorOverride	Boolean
ConversationId	String
DeliveryMode	Number
DestinationNode	String, ^RO
ExternalMessageID	Number ^RO
ExternalOperationName	String
ExternalUserName	String
ExternalUserPassword	String
FinalDestinationNode	String, ^RO
FuturePublicationDateTime	Datetime
HTTPSessionId	String
IBConnectorInfo	IBConnectorInfo collection object, ^RO
InReplyToID	String
MessageName	String, ^RO
MessageQueue	String^RO
MessageType	String, ^RO
MessageVersion	Number, ^RO
NodeDN	String, ^RO
NonRepudiationID	String, ^RO
NumberOfAttachments	String, ^RO
OperationType	String, ^RO
OperationVersion	String, ^RO
OrigNode	String, ^RO
OrigProcess	String, ^RO
OrigTimeStamp	String, ^RO
OrigUser	String, ^RO
RequestingNodeName	String, ^RO
RequestingNodeDescription	String, ^RO
ResponseAsAttachment	Boolean
SegmentsUnOrder	Boolean
SourceNode	String, ^RO
SyncServiceTimeout	Number
TransactionID	String, ^RO
UserIed	String, ^RO
VisitedNodes	Array of string, ^RO
WSA_Action	String
WSA_FaultTo	String
WSA_MessageID	String
WSA_ReplyTo	String
WSA_To	String

IBConnectorInfo Collection Methods

Method	Returns
AddConnectorProperties(Name, Value, Type)	Boolean
AddQueryStringArg(Name, Value)	Boolean
ClearConnectorProperties()	None
ClearQueryStringArgs()	None
DeleteConnectorProperties(Name)	Boolean
DeleteQueryStringArg(Name)	Boolean
GetConnectorPropertiesName(Index)	String
GetConnectorPropertiesType(Index)	String
GetConnectorPropertiesValue(Index)	String
GetNumberOf ConnectorProperties()	Number
GetNumberOfQueryStringArgs()	Number
GetQueryStringArgName(Index)	String
GetQueryStringArgValue(Index)	String

IBConnectorInfo Collection Properties

Property	Returns
ConnectorClassName	String
ConnectorName	String
Cookies	String
PathInfo	String
RemoteFrameworkURL	String

Notification Classes

This section lists the constructors, methods, and properties, as well as returns (if applicable) for the Notification, NotificationAddress, NotificationTemplate and WorklistEntry classes.

Constructors

Constructors	Returns
Notification(NotifyFrom, dttmCreated, language_cd)	Notification object
NotificationAddress(Oprid, Description, Language, EmailId, Channel)	NotificationAddress object
NotificationTemplate(ComponentId, Market, TemplateId, TemplateType)	NotificationTemplate object
OnAckForMarkedWorkedResp()	OnAckForMarkedWorkedResp object
WLEntryMarkedWorkedResp()	WLEntryMarkedWorkedResp object
WorkList()	Worklist object
WorklistEntry()	WorklistEntry object
WSWorklistEntry()	WSWorklistEntry object
WSWorklistEntryStatus()	WSWorklistEntryStatus object

Notification Class Method

Method	Returns
Send()	None

Notification Class Properties

Property	Returns
ContentType	String
dttmCreated	Datetime
EmailReplyTo	String
FileNames	Array of String
FileTitles	Array of String
language_cd	String
Message	String
NotifyBCC	Array of NotificationAddress objects
NotifyCC	Array of NotificationAddress objects
NotifyFrom	String
NotifyGuid	GUID
NotifyTo	Array of NotificationAddress objects
Rte	Boolean
SourceComponent	String
SourceMarket	String
SourceMenu	String
Subject	String
Template	String

NotificationAddress Properties

Property	Returns
Channel	String
Description	String
Emailld	String
Language	String
Oprid	String

NotificationTemplate Methods

Method	Returns
GetAndExpandTemplate(Language, Vars)	Boolean
SetupCompVarsAndRcpts(&Rowset_Context)	String
SetupGenericVars(&AryValues)	String

NotificationTemplate Properties

Property	Returns
ComponentId	String
Instruction	String
Language	String
Market	String
Priority	String
Responses	String
Subject	String
TemplateId	String
TemplateType	String
Text	String

Worklist Method

Method	Returns
Reassign(FromOperid, ToOperid)	Boolean

WorklistEntry Methods

Method	Returns
Create()	Number
GetResponseStatus()	Number
Reassign(Operid)	Boolean
Save()	Number
SaveWithCustomData(&Message, &FieldNameArray, &FieldValueArray)	Message object`
SelectByKey()	Boolean
SelectByMessageId()	Boolean
Update()	Number

WorklistEntry Properties

Property	Returns
actiondttm	Datetime
busactivity	String
buseventname	String
busprocname	String
commentshort	String
do_replicate_flag	String
instanceid	Number
instselectddttm	Datetime
inststatus	String
insttimeoutddttm	Datetime
instworkeddttm	Datetime
IsCreatedViaWebService	Boolean ^RO
oprid	String
originatorid	String ^RO
prevoprid	String
requestmessageid	String
ResponseStatus	String ^RO
syncid	Number
timedout	String
transactionid	Number
url	String
wl_priority	String
wldaystoselect	Number
wldaystowork	Number
worklistname	String

WSWorklistEntry Methods

Method	Returns
OnError(&Message)	Depends on implementation
OnNotify(&Message)	None

WSWorklistEntry Properties

Property	Returns
InstanceId	String ^RO
TransactionId	String ^RO

Optimization PeopleCode Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the optimization PeopleCode classes.

Important! Optimization PeopleCode classes are not supported on IBM z/OS and Linux for IBM System z.

Functions

Function	Returns
CreateOptEngine(probinst, {%Synch \| %ASynch} [, detailedstatus] [,processinstance])	OptEngine object
CreateOptInterface()	OptInterface object
DeleteOptProbInst(probinst[, detailedstatus])	Constant
GetOptEngine(probinst[, detailedstatus])	OptEngine object
GetOptProbInstList(ProblemType , OutputErrorCode [, Prefix][, detailedstatus])	Array of string
InsertOptProbInst(probinst, ProblemType[, detailedstatus] [, Description])	Constant
IsValidOptProbInst(probinst[, status])	Constant

OptEngine Methods

Method	Returns
CheckOptEngineStatus()	Number
FillRowset(PARAM_NAME, &Rowset [, functionstatus])	Constant
GetDate(PARAM_NAME[,status])	Date
GetDateArray(PARAM_NAME)	Array of Date
GetDateTime(PARAM_NAME)	DateTime
GetDateTimeArray(PARAM_NAME)	Array of Datetime
GetNumber(PARAM_NAME)	Number
GetNumberArray(PARAM_NAME)	Array of number
GetString(PARAM_NAME)	String
GetStringArray(PARAM_NAME)	Array of string
GetTime(PARAM_NAME)	Time
GetTimeArray(PARAM_NAME)	Array of Time
GetTraceLevel(component)	Constant
RunAsynch(TRANSACTION, PARM_PAIRS)	Constant
RunSynch(TRANSACTION, PARM_PAIRS)	Constant
SetTraceLevel(Component, Severity)	Constant
ShutDown()	Constant

OptEngine Properties

Property	Returns
DetailMsgs	Array of String ^RO
DetailStatus	Constant

OptBase Methods

Method	Returns
GetParmDate(ParmName, &ParmValue)	Boolean
GetParmDateArray(ParmName, &ParmValue)	Boolean
GetParmDateTime(ParmName, &ParmValue)	Boolean
GetParmDateTimeArray(ParmName, &ParmValue)	Boolean
GetParmNumber(ParmName, &ParmValue)	Boolean
GetParmNumberArray(ParmName, &ParmValue)	Boolean
GetParmInt`(ParmName, &ParmValue)	Boolean
GetParmIntArray(ParmName, &ParmValue)	Boolean
GetParmString(ParmName, &ParmValue)	Boolean
GetParmStringArray(ParmName, &ParmValue)	Boolean
GetParmTime(ParmName, &ParmValue)	Boolean
GetParmTimeArray(ParmName, &ParmValue)	Boolean
Init()	Boolean
OptDeleteCallback(&record)	Boolean
OptInsertCallback(&Record)	Boolean
OptPostUpdateCallback(&OldRecord, &NewRecord)	Boolean
OptPreUpdateCallback(&OldRecord, &NewRecord)	Boolean
OptRefreshCallback()	Boolean
SetOutputParmDate(ParmName, &ParmValue)	Boolean
SetOutputParmDateArray(ParmName, &ParmValue)	Boolean
SetOutputParmDateTime(ParmName, &ParmValue)	Boolean
SetOutputParmDateTimeArray(ParmName, &ParmValue)	Boolean
SetOutputParmNumber(ParmName, &ParmValue)	Boolean
SetOutputParmNumberArray(ParmName, &ParmValue)	Boolean
SetOutputParmInt(ParmName, &ParmValue)	Boolean
SetOutputParmIntArray(ParmName, &ParmValue)	Boolean
SetOutputParmString(ParmName, &ParmValue)	Boolean
SetOutputParmStringArray(ParmName, &ParmValue)	Boolean
SetOutputParmTime(ParmName, &ParmValue)	Boolean
SetOutputTimeArray(ParmName, &ParmValue)	Boolean

OptInterface Methods

Method	Returns
ActivateModel(ModelID, SolverSettingID	Constant
ActivateObjective(Model_Name, Objective_Name)	Constant
DeactivateModel(ModelId)	Constant
DumpMsgToLog(LogSeverity, Message)	None
FindRowNum(&Record[, StartRow[, EndRow [, field_list]]]	Number
GetSolution(ModelId, varArrayId, SkipZero [, KeyFieldNames, KeyFieldValues[, Sollution]]	Constant
GetSolutionDetail(ModelId, SolutionType, Name, &Solution)	Constant
IsModelActive(ModelId)	Boolean
RestoreBounds(ModelId[, varArrayId])	Constant
SetVariableBoungs(ModelId, varArrayId,BoundType, LowerBound, UpperBound, &KeyRecord[ , ChangeModelBounds])	Constant
SetVariableType(ModelId, varArrayId, varType)	Constant
Solve(ModelId, SolutionType[, objValue[ , name-value_pairs]])	Constant

Page

This section lists the functions, methods, and properties, as well as returns (if applicable) for the page class.

Function

Function	Returns
GetPage(PAGE.pagename)	Page object

Properties

Property	Returns
CopyURLLink	Boolean
CustomizePageLink	Boolean
DisplayOnly	Boolean ^RO
HelpLink	Boolean
Name	String ^RO
NewWindowLink	Boolean
Visible	Boolean

PortalRegistry

See PortalRegistry Classes Methods and Properties.

PostReport

This section lists the functions, methods, and properties, as well as returns (if applicable) for the PostReport class.

Function

Function	Returns
SetPostReport()	PostReport object

Methods

Method	Returns
AddDistributionOption(DistIdType, DistId)	Number
Put()

Properties

Property	Returns
ExpirationDate	Date
OutDestFormat	String
ProcessInstance	Number
ProcessName	String
ProcessType	String
ReportDesc	String
ReportFolder	String
ReportId	Number
ServerName	String

Process Request Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the ProcessRequest class and the related PrcsApi class.

ProcessRequest Functions

Function	Returns
CreateProcessRequest([ProcessType, ProcessName])	ProcessRequest object
GetNextProcessInstance([Commit])	Number
SetupScheduleDefnItem(ScheduleName, JobName)	ProcessRequest object

ProcessRequest Methods

Method	Returns
AddDistributionOption(DistIdType, DistId [, JobName] [, PrcsItemLevel] [, JobSeqNo])	Number
AddNotifyInfo(field_name, field_value [, JobName] [, PrcsItemLevel] [, JobSeqNo])	None
PrintJobHTMLRpt()	String
PrintJobRqstRpt(ProcessInstance, ItemInstance [, PrintJobTree] [, PrintDistList] [, PrintNotifyList] [, PrintSystemMessage] [, PrintApplicationMessage] [, PrintParamList])	String
PrintSchdlHTMLRpt([PrintJobTree] [, PrintDistList] [, PrintNotifyList] [, PrintMessageList] [, PrintParamList])	String
RunJobSetNow()	None
Schedule()	None
SetEmailOption(EmailSubject, EmailText, EmailAddress, EmailWebReport, EmailAttachLog [, JobName] [, PrcsItemLevel] [, JobSeqNo])	None
SetItemFolder(PortalFolder [, JobName] [, PrcsItemLevel] [, JobSeqNo])	None
SetNotifyAppMethod(app_class_name, app_class_method [, JobName] [, PrcsItemLevel] [, JobSeqNo])	None
SetNotifyService(srvc_op_name[, JobName] [, PrcsItemLevel] [, JobSeqNo])	None
SetOutputOption(OutputType, OutputFormat, OutputDest [, JobName][, PrcsItemLevel] [, JobSeqNo])	None
UpdateRunStatus()	None

ProcessRequest Properties

Property	Returns
EmailAttachLog	Boolean
EmailSubject	String
EmailText	String
EmailWebReport	Boolean
FileName	String
JobName	String
LanguageCd	String
NotifyTextMsgNum	Number
NotifyTextMsgSet	Number
OutDest	String
OutDestFormat	String
OutDestType	String
PortalFolder	String
ProcessInstance	Number
ProcessName	String
ProcessType	String
RunControlID	String
RunDateTime	DateTime
RunLocation	String
RunRecurrence	String
RunStatus	Number
Status	Number ^RO
TimeZone	String

PrcsApi Constructor

Constructor	Returns
PrcsApi()	PrcsApi object

PrcsApi Methods

Method	Returns
getAllFileNames(PrcsInstance)	Array of string
notifyToWindows(PrcsInstance, Message)	Number

Query

See Query Classes Methods and Properties.

Record

This section lists the functions, methods, and properties, as well as returns (if applicable) for the record class.

Functions

Function	Returns
CreateRecord(RECORD.recname)	Record object
GetRecord([RECORD.recname])	Record object

Methods

Method	Returns
CompareFields(RecordObject)	Boolean
CopyChangedFieldsTo(RecordObj)	None
CopyFieldsTo(RecordObject)	None
DBPatternMatch(Value, Pattern, CaseSensitive)	Boolean
Delete()	Boolean
ExecuteEdits([EditLevel])	None
GetField(n/FIELD.fieldname)^D	Field Object
Insert()	Boolean
Save([CopyToOriginal])	Boolean
SearchClear()	None
SelectByKey([UseChangedBuffers])	Boolean
SelectByKeyEffDt(Date [, UseChangedBuffers])	Boolean
SetDefault()	None
SetEditTable(%PromptField, RECORD.recname)	None
Update([KeyRecord])	Boolean

Properties

Property	Returns
FieldCount	Number ^RO
fieldname	Field Object ^RO
IsChanged	Boolean ^RO
IsDeleted	Boolean ^RO
IsEditError	Boolean ^RO
Name	String ^RO
ParentRow	Row Object ^RO
RelLangRecName	String ^RO

Row

This section lists the functions, methods, and properties, as well as returns (if applicable) for the row class.

Function

Function	Returns
GetRow()	Row object

Methods

Method	Returns
CopyTo(rowobject)	Row Object
GetNextEffRow()	Row Object
GetPriorEffRow()	Row Object
GetRecord({n \| RECORD.recname})^D	Record Object
GetRowSet({n \| SCROLL.scrollname})	Rowset Object
scrollname(n)	Row Object

Properties

Property	Returns
ChildCount	Number ^RO
DeleteEnabled	Boolean
IsChanged	Boolean ^RO
IsDeleted	Boolean ^RO
IsEditError	Boolean ^RO
IsNew	Boolean ^RO
ParentRowSet	Rowset object ^RO
recname	Record object ^RO
RecordCount	Number ^RO
RowNumber	Number ^RO
Selected	Boolean
Style	String
Visible	Boolean

Rowset

This section lists the functions, methods, and properties, as well as returns (if applicable) for the rowset class.

Functions

Function	Returns
CreateRowset({RECORD.recname \| &Rowset} [, {FIELD.fieldname, RECORD.recname \| &Rowset}] . . .)	Rowset object
GetLevel0()	Rowset object
GetRowset([SCROLL.scrollname])	Rowset object

Methods

Method	Returns
ClearDeletesChanges()	None
CopyTo(&DestRowset [, RECORD.SourceRecname, RECORD.DestRecname]. . .)	None
DeleteRow(n)	Boolean
Fill([wherestring [, bindvalue] . . .])	Number
FillAppend([wherestring [, bindvalue] . . .])	Number
Flush()	None
FlushRow(n)	None
GetCurrEffRow()	Row object
GetFirstUserSortedRow(GridName)	Row object
GetLastUserSortedRow(GridName [, visible])	Row object
GetNewEffRow()	Row object
GetRow(n)^D	Row object
HideAllRows()	None
InsertRow(n)	Boolean
IsUserSorted(GridName)	Boolean
MapBufRowToUserSortRow(GridName, number)	Number
MapUserSortRowToBufRow(GridName, number)	Number
Refresh()	None
Select([parmlist], RECORD.selrecord [ , wherestr, bindvars])	Number
SelectNew([parmlist], RECORD.selrecord [, wherestr, bindvars])	Number
SetDefault(recname.fieldname)	None
ShowAllRows()	None
Sort([paramlist,] sort_fields)	None

Properties

Property	Returns
ActiveRowCount	Number ^RO
ChangeOnInit	Boolean
DataAreaCollapsed	Boolean
DBRecordName	String ^RO
DeleteEnabled	Boolean
EffDt	Date ^RO
EffSeq	Number ^RO
InsertEnabled	Boolean
IsEditError	Boolean ^RO
Level	Number ^RO
Name	String ^RO
ParentRow	Row Object ^RO
ParentRowSet	Rowset Object ^RO
RowCount	Number ^RO
SetComponentChanged	Boolean
TopRowNumber	Number ^RO

RowsetCache

This section lists the functions, methods, and properties, as well as the returns (if applicable) for the RowsetCache class.

Functions

Function	Returns
CreateRowsetCache(&Rowset, [Rowset.]Name, Description)	RowsetCache object
GetRowsetCache(([Rowset.]name)	RowsetCache object

Methods

Method	Returns
Delete()	Boolean
Get()	Rowset object
Save([[Rowset.]name] [, Description] [, Lang])	Boolean

Properties

Property	Returns
Content	Rowset object
Description	String

Search

See Verity Search Classes Methods and Properties.

Session

See Session Classes.

SOAPDoc

This section lists the functions, methods, and properties, as well as returns (if applicable) for the SOAPDoc class.

Function

Function	Returns
CreateSOAPDoc()	SOAPDoc object

Methods

Method	Returns
AddBody()	None
AddEnvelope(SOAP_Schema)	None
AddFault(Fault_Code, Fault_String)	None
AddHeader()	None
AddMethod(MethodName, IsRequest)	None
AddParm(ParmName, ParmValue)	None
GetParmName(Index)	String
GetParmValue(Index)	String
ValidateSOAPDoc([1])	String

Properties

Property	Returns
BodyNode	XmlNode object ^RO
EnvelopeNode	XmlNode object ^RO
FaultCode	Number ^RO
FaultCodeS	String ^RO
FaultString	String ^RO
HeaderNode	XmlNode object ^RO
MethodName	String ^RO
MethodNode	XmlNode object ^RO
ParmCount	Number ^RO
XmlDoc	XmlDoc object

SQL

This section lists the functions, methods, and properties, as well as returns (if applicable) for the SQL class.

Functions

Function	Returns
CreateSQL([{sqlstring\| SQL.SqlName} [, paramlist]])	None
DeleteSQL([SQL.]sqlname [ , dbtype [ , effdt]]] )	Boolean
FetchSQL([SQL.]sqlname [ , dbtype [ , effdt ]] )	String
GetSQL(SQL.sqlname [, paramlist])	SQL object
StoreSQL(sqlstring, [SQL.]sqlname [ , dbtype [ , effdt [, ownerId [ , Description]]]] )	None

Methods

Method	Returns
Close()	Boolean
Execute(paramlist)	Boolean
Fetch(paramlist)	Boolean
Open(sql [, paramlist])	None

Properties

Property	Returns
BulkMode	Boolean
IsOpen	Boolean ^RO
LTrim	Boolean
ReuseCursor	Boolean
RowsAffected	Number ^RO
Status	Number ^RO
TraceName	String
Value	String ^RO

TransformData

This section lists the variables, properties, and returns (if applicable) for the TransformData class.

System Variable

System Variable	Returns
%TransformData	TransformData object

Properties

Property	Returns
DestMsgName	String ^RO
DestMsgVersion	String ^RO
DestNode	String ^RO
RejectTransform	Number
RoutingDefnName	String ^RO
SourceMsgName	String ^RO
SourceMsgVersion	String ^RO
SourceNode	String ^RO
Status	Number
XmlDoc	XmlDoc object

Tree

See Tree Classes Methods and Properties.

Universal Queue

This section lists the built-in functions, constructors, methods, and properties as well as returns (if applicable) for the universal queue classes (MultiChannel Framework).

Universal Queue Built-in Functions

Function	Returns
DeQueue(physical queue ID, task type, task number, agent ID)	Number
EnQueue(logical queue , task type, Relative URL, Language_Code [,subject][, agent ID][, overflow timeout][, escalation timeout][, cost][, priority][, skill level])	Number
Forward(from physical queue ID, from agent ID, task number, task type, to logical queue ID[, to agent ID])	Number
InitChat(logical queue ID, application data URL, customer username, [chat_subject][, chat_question][, wizard_URL][, priority][, skill_level] [, cost])	Number
MCFBroadcast(ClusterID,QueueID, ChannelID, AgentState, AgentPresence, Message, MessageSetNumber, MessageNumber, DefaultMessage, SecurityLevel, ImportanceLevel, SenderId, NameValueString)	None.
NotifyQ(logical queue ID, task type)	Number

Universal Queue Constructors

Constructor	Returns
Agent(AgentID)	Agent object
AgentPhysQueueProps()	Agent physical queue properties object
AgentPhysQueueTasks(PhysicalQueueID, AgentID)	Agent physical queue tasks object
LogicalQueue(LogicalQueueID)	Logical queue object
MCFFactory([MAX_TASKLIST_ITEMS])	MCFFactory object
PhysicalQueue(PhysicalQueueID)	Physical queue object
Task(TaskNumber)	Task object
TaskList(Status, TaskType, [PhysicalQueueID[, AgentID]])	Task list object
Util()	Util object

Agent Methods

Method	Returns
Delete()	Number
Refresh()	None
RefreshQTaskList(PhysQ)	None

Agent Properties

Property	Returns
AgentID	String ^RO
AgentProps	AgentPhysQueueProps object ^RO
AgentTasks	AgentPhysQueueTask object ^RO
Buddy	Array of string ^RO
Language	Array of string ^RO
Name	String ^RO
Nickname	String ^RO
PhysicalQueueID	Array of string ^RO
TotalPhysicalQueues	Number ^RO

AgentPhysQueueProps Properties

Property	Returns
AgentID	String ^RO
PhysicalQueueID	String ^RO
SkillLevel	String ^RO
WorkLoad	Number ^RO

AgentPhysQueueTasks Method

Method	Returns
Refresh(TaskList)	None.

AgentPhysQueueTasks Properties

Property	Returns
AcceptedTaskList	Task list object ^RO
AssignedTaskList	Task list object ^RO
PhysicalQueueID	String ^RO

LogicalQueue Properties

Property	Returns
LogicalQueueID	String ^RO
PhysicalQueueID	Array of PhysicalQueue objects ^RO

MCFFactory Property

Property	Returns
LogicalQueue	Array of LogicalQueue objects ^RO

PhysicalQueue Methods

Method	Returns
Refresh()	None
RefreshTaskList(TaskList)	None.

PhysicalQueue Properties

Property	Returns
AcceptedTaskList	Task list object ^RO
AssignedTaskList	Task list object ^RO
Agent	Array of agent objects ^RO
BrowserURL	String ^RO
EnqueuedTaskList	Task list object ^RO
EscalatedTaskList	Task list object ^RO
InternalURL	String ^RO
IsActive	Boolean ^RO
LogicalQueueID	String ^RO
OverflowedTaskList	Task list object ^RO
PhysicalQueueID	String ^RO
RENURLID	String ^RO
TotalAgents	Number ^RO

Task Methods

Method	Returns
Close(Comment)	None
Enqueue(LogicalQueueID,AgentID, Timeout, ResponseTime, Cost, Priority, MinSkill)	None.
Refresh()	None
RefreshStatus()	None

Task Properties

Property	Returns
AgentID	String ^RO
ApplicationData	String ^RO
Comments	String
EnqueueTime	Datetime ^RO
EscalationTime	Datetime ^RO
Language	String ^RO
OriginalTime	Datetime ^RO
OverflowTime	Datetime ^RO
PhysicalQueueID	String ^RO
TiedAgentID	String ^RO

TaskList Method

Method	Returns
Refresh()	None

TaskList Properties

Property	Returns
AgentID	String ^RO
PhysicalQueueID	String ^RO
Task	Array of tasks ^RO
TaskType	String ^RO
Total	Number ^RO

XmlDoc Classes

This section lists the functions, methods, and properties, as well as returns (if applicable) for the XmlDoc class and the XmlNode class.

XmlDoc Classes Functions

Function	Returns
CreateXmlDoc(XmlString)	XmlDoc object
GetNRXmlDoc(NRID, NodeName)	XmlDoc object
RevalidateNRXmlDoc(NRID, EntityName	Boolean
Transform(Input, AE_Program_Name, Initial_Node_Name, Initial_Message__Name, Initial_Message_Version, Result_Node_Name, Result_Message_Name, Result_Message_Version)	XmlDoc object
TransformEx(XmlString, XsltString)	String

XmlDoc Class Methods

Method	Returns
CopyRowset(&InRowset[, MessageName ] [, MessageVersion])	Boolean
CopyToPSFTMessage(targetDoc, srcPath, targetPath)	Number
CopyToRowset(&InRowset[, Message_Name][, Message_Version])	Boolean
CreateDocumentElement(TagName [, NamespaceURI ] [, &DocType])	XmlNode object
CreateDocumentType(Name, PublicID, SystemID)	String
GenFormattedXmlString()	String
GenXmlFile(path)	Boolean
GenXmlString()	String
GetElementsByTagName(TagName)	Array of XmlNode objects
LoadIBContent(Content[, RootTagName])	Boolean
ParseXmlFromURL(path)	Boolean
ParseXmlString(XmlString)	Boolean

XmlDoc Class Properties

Property	Returns
DocumentElement	XmlNode object ^RO
IsNull	Boolean ^RO

XmlNode Class Methods

Method	Returns
AddAttribute(Name, Value)	None
AddAttributeNS(NamespaceURI, AttributeName, Value)	None
AddCDataSection(Data)	XmlNode object
AddComment(Text)	XmlNode object
AddElement(TagName)	XmlNode object
AddElementNS(NameSpaceURI, TagName)	XmlNode object
AddEntityReference(Name)	XmlNode object
AddNode(XmlNode)	XmlNode object
AddProcessInstruction(Target, Data)	XmlNode object
AddText(Data)	XmlNode object
CopyNode(Node)	None
FindNode(Path)	XmlNode object
FindNodes(Path)	Array of XmlNode objects
GenXmlString()	String
GetAttributeName(index)	String
GetAttributeValue({Name \| Index})	String
GetCDataValue()	String
GetCDataValues()	Array of string
GetChildNode(index)	XmlNode object
GetElement()	XmlNode object
GetElements()	Array of XmlNode objects
GetElementsByTagName(TagName)	Array of XmlNode objects
GetElementsByTagNameNS(NamespaceURI, TagName)	Array of XmlNode objects
InsertCDataSection(Data, Position)	XmlNode object
InsertComment(Data, Position)	XmlNode object
InsertElement(TagName, Position)	XmlNode object
InsertElementNS(NameSpaceURI, TagName, Position)	XmlNode object
InsertEntityReference(Name, Position)	XmlNode object
InsertNode(&NewNode, {&RefNode \| Position})	XmlNode object
InsertProcessInstruction(Target, Data, Position)	XmlNode object
InsertText(Data, Position)	XmlNode object
RemoveAllChildNode()	None
RemoveChildNode({Position \| Node})	XmlNode object

XmlNode Class Properties

Property	Returns
AttributesCount	Number ^RO
ChildNodeCount	Number ^RO
Index	Number ^RO
IsNull	Boolean ^RO
LocalName	String ^RO
NamespaceURI	String ^RO
NextSibling	XmlNode object ^RO
NodeName	String
NodePath	String ^RO
NodeType	String ^RO
NodeValue	String
ParentNode	XmlNode object ^RO
Prefix	String ^RO
PreviousSibling	XmlNode object ^RO

XML Publisher

This section lists the constructors, methods, and properties, as well as returns (if applicable) for the XML Publisher classes.

Report manager definition classes
Report manager search classes
XML Publisher engine classes

Report Definition Manager Classes Constructors

Constructor	Returns
ReportDefn(ReportId)	ReportDefn object

ReportDefn Class Methods

Method	Returns
Close()	None
DisplayOutput()	None
Get()	ReportDefn object
GetOutDestFormatString(OutDestFormat)	String
GetPSQueryPromptRecord()	Record object
PrintOutput(DestPrinter)	None
ProcessReport(TemplateId, LanguageCD, AsOfDate, OutputFormat)	None
Publish(ServerName, ReportPath, FolderName, ProcessInstanceId)	None
SetPSQueryPromptRecord(&Record)	None
SetRuntimeDataXMLFile(FilePath)	None
SetRuntimeProperties(&NameArray, &ValueArray)	None

ReportDefn Class Properties

Property	Returns
Description	String ^RO
DestinationPrinter	String
FolderName	String
OutDestination	String ^WO
OutDestinationType	String ^RO
ProcessInstance	String
Status	String^RO
UseBurstValueAsOutputFileName	Boolean

Report Manager Search Classes Constructors

Constructor	Returns
Report(RptId, Prcsinstance, Contentid, Dbname, RptName, RptDescr, RptURL, RptCreateDttm, RptExpireDt, FldrName)	Report object
ReportManager()	ReportManager object
SearchAttribute(AttrName, AttrValue, CompareOperator)	SearchAttribute object

Report Class Properties

Property	Returns
contentId	Number^RO
CreatedDateTime	DateTime^RO
DatabaseName	String^RO
Description	String^RO
ExpireDate	Date^RO
FileURL	String^RO
FolderName	String^RO
ProcessInstanceID	String^RO
ReportInstanceID	String^RO
ReportName	String^RO
ReportURL	String^RO

ReportManager Class Methods

Method	Returns
AddSearchFieldCriteria(&SearchAttribute)	Boolean
GetReportList()	Array of ReportDefn objects
SetBurstFieldCriteria(BurstFld, BurstOp, BurstValue)	Boolean
SetCaseSensitive(IsCaseSensitive)	None
SetDateCriteria(createdDate, createdLastVal, createdUnit)	None
SetFolderCriteria(FolderName)	Boolean
SetProcessInstanceCriteria(FromPID, ToPID)	Boolean
SetReportIDCriteria(ReportId)	Boolean
SetUserIdCriteria(UserId)	Boolean

SearchAttribute Class Properties

Property	Returns
attrName	String^RO
attrValue	String^RO
compareOp	String^RO

XML Publisher Engine Classes Constructors

Constructor	Returns
PageNumber()	PageNumber object
PDFMerger()	PDFMerger object
Properties()	Properties object
Watermark()	Watermark object

PageNumber Class Properties

Property	Returns
BackgroundFile	String
FontName	String
FontSize	Number
PositionX	Number
PositionY	Number
StartFromPageNum	Number
StartNum	Number

PDFMerger Class Method

Method	Returns
MergePDFs(PDFFileArray, PDFOutputFile, Error)	Boolean

PDFMerger Class Properties

Property	Returns
ConfProp	Properties object
Locale	Sting
PageNumber	PageNumber object
Watermark	Watermark object

Properties Class Methods

Method	Returns
GetProperty(Name, OutValue)	Boolean
SetProperty(Name, Value)	Boolean

Watermark Class Properties

Property	Returns
ImageFile	String
ImageFileLowerLeftX	Number
ImageFileLowerLeftY	Number
ImageFileUpperRightX	Number
ImageFileUpperRightY	Number
PageIndex	Number
Text	String
TextAngle	Number
TextFontName	String
TextFontSize	Number
TextStartPosX	Number
TextStartPosY	Number

Session Classes

This section lists:

Session classes methods and properties
Component interface classes methods and properties
Verity search classes methods and properties
PortalRegistry classes methods and properties
Query classes methods and properties
Tree classes methods and properties

Session Classes Methods and Properties

A session object controls access to the PeopleSoft APIs as well as the environment in which they run. This section only lists the system variable, methods, and properties, as well as returns (if applicable) for the session class and the associated classes used for controlling the environment. The properties, methods, and so of the API objects (query classes, tree classes, and so on) are detailed in separate sections.

Session System Variable

System Variable	Returns
%Session	Session object

Session Methods

Method	Returns
AdvancedSearchQueries(GetFavorites, QueryName, QueryNameOp, Descr, DescrOp, FolderName, FolderNameOp, RecordName, RecordNameOp, FieldName, FieldNameOp, TreeName, TreeNameOp, QueryType, OwnerType, CaseSensitive)	Query collection
AdvancedSearchRecords(RecordName, RecordNameOp, Descr, DescrOp, FieldName, FieldNameOp, TreeName, TreeNameOp, CaseSensitive)	QueryDBRecord collection
FindCompIntfcs(partial_name)	Component Interface collection
FindPortalRegistries(partial_name)	PortalRegistry collection
FindQueryDBRecords()	QueryDBRecord collection
FindQueries()	Query collection
FindQueriesDateRange(StartDateString, EndDateString)	Query collection
GetActualRemoteNodes()	Remote node collection
GetCompIntfc([CompIntfc.]name)	Component Interface object
GetLocalNode()	Node object
GetNodes()	Node collection
GetPortalRegistry()	PortalRegistry object
GetQuery()	Query object
GetQuerySecurityProfile()	QuerySecurityProfile object
GetRemoteNodes()	Node collection
GetSearchIndexes()	SearchIndexes collection
GetSearchQuery()	SearchQuery object
GetTree()	Tree object
GetTreeStructure()	Tree structure
SearchQueryDBRecord(SearchType, Pattern, CaseSensitive)	QueryDBRecord collection
SearchPrivateQueries(QueryType, UserId, SearchType, Pattern, CaseSensitive)	Query collection
SearchPublicQueries(QueryType, SearchType, Pattern, CaseSensitive)	Query collection

Session Properties

Property	Returns
ErrorPending	Boolean ^RO
PSMessages	PSMessage collection object
PSMessageMode	Number
RegionalSettings	Regional settings object
Repository	API Repository object
SuspendFormating	Boolean
TraceSettings	Trace settings object
WarningPending	Boolean ^RO

PSMessage Collection

Method	Returns
DeleteAll()	Boolean
DeleteItem(number)	Boolean
First()	PSMessage object
Item(number)	PSMessage object
Next()	PSMessage object

PSMessage Collection Property

Property	Returns
Count	Number ^RO

PSMessage Properties

Property	Returns
ExplainText	String ^RO
MessageNumber	Number ^RO
MessageSetNumber	Number ^RO
Source	String ^RO
Text	String ^RO

RegionalSettings Properties

Property	Returns
ClientTimeZone	String
CurrencyFormat	Number
CurrencySymbol	String
DateFormat	Number
DateSeparator	String
DecimalSymbol	String
DigitGroupingSymbol	String
LanguageCD	String
UseLocalTime	Boolean
1159Separator	String
2359Separator	String

TraceSettings Properties

Property	Returns
API	Boolean
COBOLStmtTimings	Boolean
ConDisRollbackCommit	Boolean
DBSpecificCalls	Boolean
ManagerInfo	Boolean
NetworkServices	Boolean
NonSSBs	Boolean
OutputUNICODE	Boolean
PCExtFcnCalls	Boolean
PCFcnReturnValues	Boolean
PCFetchedValues	Boolean
PCIntFcnCalls	Boolean
PCListProgram	Boolean
PCParameterValues	Boolean
PCProgramStatements	Boolean
PCStack	Boolean
PCStartOfPrograms	Boolean
PCTraceProgram	Boolean
PCVariableAssignments	Boolean
RowFetch	Boolean
SQLStatement	Boolean
SQLStatementVariables	Boolean
SSBs	Boolean
SybBindInfo	Boolean
SybFetchInfo	Boolean
TraceFile	String

API Repository Classes Methods and Properties

This section lists the method, properties, as well as the returns (if applicable) for the API Repository classes.

Repository Properties

Property	Returns
Bindings	Bindings collection object ^RO
NameSpaces	Namespaces collection ^RO

Bindings Collection Property

Property	Returns
Count	Number ^RO

Bindings Collections Method

Method	Returns
Item(number)	Binding object

Bindings Property

Property	Returns
Name	String ^RO

Namespaces Collection Property

Property	Returns
Count	String ^RO

Namespaces Collection Methods

Method	Returns
Item(Number)	Namespaces object
ItemByName(Name)	Namespaces object

Namespaces Properties

Property	Returns
Classes	ClassInfo object ^RO
Name	String ^RO

ClassInfo Collection Property

Property	Returns
Count	Number ^RO

ClassInfo Collection Methods

Method	Returns
Item(Number)	ClassInfo object
ItemByName(Name)	ClassInfo object

ClassInfo Properties

Property	Returns
Documentation	String ^RO
Methods	MethodInfo collection object ^RO
Name	String ^RO
Properties	PropertyInfo collection object ^RO

MethodInfo Collection Property

Property	Returns
Count	String ^RO

MethodInfo Collection Methods

Method	Returns
Item(Number)	MethodInfo object
ItemByName(Name)	MethodInfo object

MethodInfo Properties

Property	Returns
Arguments	PropertyInfo collection object ^RO
Documentation	String ^RO
Name	String ^RO
Type	String ^RO

PropertyInfo Collection Properties

Property	Returns
Count	String ^RO

PropertyInfo Collection Methods

Method	Returns
Item(Number)	PropertyInfo object
ItemByName(Name)	PropertyInfo object

PropertyInfo Properties

Property	Returns
Documentation	String ^RO
Name	String ^RO
Type	String ^RO
Usage	Number ^RO

Component Interface Class Methods and Properties

This section lists the methods and properties, as well as returns (if applicable) for the component interface classes.

Component Interface Collection Methods

Method	Returns
First()	Component Interface structure (no data)
Item(number)	Component Interface structure (no data)
Next()	Component Interface structure (no data)

Component Interface Collection Property

Property	Retuns
Count	Number ^RO

Component Interface Methods

Method	Returns
Cancel()	Boolean
CopyRowset(&rowset [,IntialRow] [, record_list])	None
CopyRowsetDelta(&rowsetI, [,IntialRow] [, record_list])	None
CopySetupRowset(&rowset [,IntialRow] [, record_list])	None
CopySetupRowsetDelta(&rowsetI, [,IntialRow] [, record_list])	None
Create()	Component Interface with data
Find()	Component Interface collection
Get()	Component Interface with data
GetPropertyByName(string)	Depends on property
Save()	Boolean
SetPropertyByName(string, value)	None

Component Interface Properties

Property	Returns
ComponentName	String ^RO
CreateKeyInfoCollection	Component InterfacePropertyInfo collection object ^RO
FindKeyInfoCollection	Component InterfacePropertyInfo collection object ^RO
GetDummyRows	Boolean
GetHistoryItems	Boolean
GetKeyInfoCollection	Component InterfacePropertyInfo collection object ^RO
InteractiveMode	Boolean
PropertyInfoCollection	Component InterfacePropertyInfo collection object ^RO
StopOnFirstError	Boolean
Every user-defined property in a component interface definition can be used like a property on the instantiated object.	Depends on property

CompIntfPropInfo Collection Methods

Method	Returns
First()	Component InterfacePropertyInfo object
Item(number)	Component InterfacePropertyInfo object
Next()	Component InterfacePropertyInfo object

CompIntfPropInfo Collection Property

Property	Returns
Count	Number ^RO

CompIntfPropInfo Properties

Property	Returns
Format	String ^RO
IsCollection	Boolean ^RO
IsReadOnly	Boolean ^RO
Key	Boolean ^RO
LabelLong	String ^RO
LabelShort	String ^RO
Length	Number ^RO
Name	String ^RO
Prompt	Boolean ^RO
PropertyInfoCollection	Component InterfacePropertyInfo collection object
Required	Boolean ^RO
Type	String ^RO
Xlat	Boolean ^RO
YesNo	Boolean ^RO

Data Collection Methods

Method	Returns
CurrentItem()	Data collection item
DeleteItem(number)	None
GetEffectiveItem(DateString, SeqNo)	Data collection item
GetEffectiveItemNum(DateString, SeqNo)	Number
InsertItem(number)	Data collection item
Item(number)	Data collection item
ItemByKeys(key_values)	Data collection item

Data Collection Properties

Property	Returns
Count	Number ^RO
CurrentItemNumber	Number ^RO

Verity Search Classes Methods and Properties

This section lists the methods and properties, as well as returns (if applicable) for the Verity search classes.

Note. Search class objects are instantiated from both the Session and PortalRegisty objects.

SearchQuery Methods

Method	Returns
Execute(Start, Size)	SearchResult collection
Parse()	ParseResult collection

SearchQuery Properties

Property	Returns
HitCount	Number ^RO
Indexes	String
KnowledgeBase	String
Language	String
ProcessedCount	Number ^RO
QueryText	String
RequestedFields	String
ScorePrecision	String
SortSpecifications	String

ParseResult Collection Methods

Method	Returns
First()	ParseResult object
Next()	ParseResult object or Null

ParseResult Collection Properties

Property	Returns
ErrorCount	Number ^RO
WarningCount	Number ^RO

ParseResult Properties

Property	Returns
Message	String ^RO
Severity	String ^RO

SearchResult Collection Methods

Method	Returns
First()	SearchResult
Item(number)	SearchResult
Next()	SearchResult

SearchResult Collection Property

Property	Returns
Count	Number ^RO

SearchResult Properties

Property	Returns
Key	String ^RO
Score	String ^RO
ScoreAsNumber	Floating point number ^RO
SearchFields	SearchField collection ^RO

SearchField Collection Methods

Method	Returns
First()	SearchField
ItemByName(Name)	SearchField
Next()	SearchField

SearchField Collection Property

Property	Returns
Count	Number ^RO

SearchField Properties

Property	Returns
Name	String ^RO
Value	String ^RO

SearchIndexes Collection Methods

Method	Returns
First()	SearchIndex object
ItemByName(Name)	SearchIndex object
Next()	SearchIndex object

SearchIndexes Collection Property

Property	Returns
Count	Number ^RO

SearchIndex Method

Method	Returns
Save()	Boolean

SearchIndex Properties

Property	Returns
ExtraOptions	Any
FSOpts	Search FS Options object ^RO
HTTPOpts	Search HTTP Options object ^RO
Languages	Search Language collection ^RO
Location	String
Name	String ^RO
RecOpts	SearchRecord Options collection ^RO
Schedules	Search Schedule collection ^RO
Type	String

SearchRecord Options Properties

Property	Returns
Fields	SearchRecordField collection ^RO
Filter	String
IncrementalView	String
RecName	String ^RO
VeggieKey	String
ZoneOptions	String

SearchRecordField Collection Methods

Method	Returns
DeleteItem(Record, Field)	Boolean
First()	SearchRecordField object
InsertItem(Record, Field)	SearchRecordField object
ItemByName(Record, Field)	SearchRecordField object
Next()	SearchRecordField object

SearchRecordField Collection Property

Property	Returns
Count	Number ^RO

SearchRecordField Properties

Property	Returns
FieldName	String ^RO
IsAttachment	Boolean
IsVerityField	Boolean
IsWordIndex	Boolean
RecordName	String ^RO

SearchLanguage Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	Search Language object
InsertItem(LanguageCode, MapLanguageCode)	Search Language object
ItemByName(LanguageCode)	Search Language object
Next()	Search Language object

SearchLanguage Collection Property

Property	Returns
Count	Number ^RO

SearchLanguage Properties

Property	Returns
LanguageCd	String ^RO
MapLanguageCd	String ^RO

SearchSchedule Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	Search Schedule object
InsertItem(RunCntrlID)	Search Schedule object
ItemByName(RunCntrlID)	Search Schedule object
Next()	Search Schedule object

SearchSchedule Collection Property

Property	Returns
Count	Number ^RO

SearchSchedule Properties

Property	Returns
BuildType	String
RunCntrID	String ^RO
RunRecurrance	String
ServerName	String

SearchHTTPOptions Properties

Property	Returns
AllowHTTPS	Boolean
DomainLimit	String
GlobList	String
GlobListType	String
LinkDepth	Number
MIMEList	String
MIMEListType	String
ProxyHost	String
ProxyPort	Number
StartOpts	Search Start Options collection ^RO

SearchFSOptions Properties

Property	Returns
GlobList	String
GlobListType	String
MIMEList	String
MIMEListType	String
StartOpts	Search Start Options collection ^RO

SearchStartOptions Collection Methods

Method	Returns
DeleteItem(Value)	Boolean
First()	Search Start Options object
InsertItem(Value)	Search Start Options object
ItemByName(Value)	Search Start Options object
Next()	Search Start Options object

SearchStartOptions Collection Property

Property	Returns
Count	Number ^RO

SearchStartOptions Properties

Property	Returns
IsDomainRestricted	Boolean
IsHostRestricted	Boolean
Value	String ^RO

PortalRegistry Classes Methods and Properties

This section lists the methods, and properties, as well as returns (if applicable) for the PortalRegistry classes.

PortalRegistry Methods

Method	Returns
BuildSearchIndex(Language)	Boolean
Close()	Boolean
CopyObject(sourcePortalName, sourceRefType, sourceObjName, targetPortalName, targetPrntFldrName, copyChildren)	Boolean
Create(RegistryName)	Boolean
CreateContentRefLink(LinkName, LinkLabel, LinkParent, CRefPortalName, CRefObjectName)	ContentReference link object
CreateRemote(PortalName, RemoteNodeName)	Boolean
Delete(RegistryName)	Boolean
DeleteHomepage()	Boolean
FindCRefByName(Name)	ContentReference object
FindCRefByURL(URL)	ContentReference object
FindCrefForURL(URL)	ContentReference object
FindCRefLinkByName(LinkName)	ContentReference link object
FindFolderByName(Name)	Folder object
FindPgltByName(PageletName)	Pagelet object
GetAbsoluteContentURL(NodeName, URL)	ContentReference object
GetDefaultHPTabOID()	String
GetQualifiedURL(ContentProvider, RelativeURL)	URL string
GetSearchQuery()	SearchQuery object
GrantPermissionForComponent(MenuName, ComponentName, Market, PermListName, NodeName)	Boolean
GrantPermissionForScript(RecordName, FieldName, EventName, FuncName, PermListName, NodeName)	Boolean
Open(RegistryName)	Boolean
PermissionListDelete(PermListName)	Boolean
PermissionListSaveAs(PermListSourceName, PermListTargetName)	Boolean
RevokePermissionForComponent(MenuName, ComponentName, Market, PermListName, NodeName)	Boolean
RevokePermissionForScript(RecordName, FieldName, EventName, FuncName, PermListName, NodeName)	Boolean
Save()	Boolean

PortalRegistry Properties

Property	Returns
DefaultTemplate	String
Description	String
DisableFolderNavigation	Boolean
Favorites	Favorite Collection ^RO
FolderNavObject	String
Homepage	Homepage object ^RO
IsFolderNavigation	Booldan
Name	String ^RO
NodeTemplates	NodeTemplate Collection ^RO
OwnerId	String
PageletCategories	PageletCategories Collection ^RO
Portals	Portal collection ^RO
RootFolder	Folder object ^RO
TabDefinitions	TabDefinitions Collection ^RO
TemplateObject	ContentReference object ^RO

PortalRegistry Collection Methods

Method	Returns
First()	PortalRegistry object
Item(number)	PortalRegistry object
Next()	PortalRegistry object

PortalRegistry Property

Property	Returns
Count	Number ^RO

Node Properties

Property	Returns
ActiveNode	Boolean ^RO
AppRelease	String ^RO
ContentURI	String ^RO
DefaultPortalName	String ^RO
Description	String ^RO
Name	String ^RO
NodePassword	String ^RO
NodeType	String ^RO
PortalURI	String ^RO
ToolsRelease	String ^RO

Node Collection Methods

Method	Returns
First()	Node object
ItemByName(NodeName)	Node object
Next()	Node object

Node Collection Property

Property	Returns
Count	Number ^RO

Remote Node Collection Methods

Method	Returns
First()	Node object
ItemByName(NodeName)	Node object
Next()	Node object

Remote Node Collection Property

Property	Returns
Count	Number ^RO

Portal Method

Method	Returns
Save()	Boolean

Portal Properties

Property	Returns
HostNodeName	String
IsLocal	Boolean ^RO
Name	String ^RO

Portal Collection Methods

Method	Returns
First()	Portal object
ItemByName(PortalName)	Portal object
Next()	Portal object

Portal Collection Property

Property	Returns
Count	Number ^RO

Node Template Properties

Property	Returns
DefaultTemplate	String
Name	String
TemplateObject	Template object ^RO

Node Template Collection Methods

Method	Returns
DeleteItem(NodeName)	Boolean
First()	NodeTemplate object
InsertItem(NodeName)	NodeTemplate object
ItemByName(NodeName)	NodeTemplate object
Next()	NodeTemplate Object

Node Template Collection Property

Property	Returns
Count	Number ^RO

Folder Method

Method	Returns
Save()	Boolean

Folder Properties

Property	Returns
AbnContentProvider	String
AbnDataSource	String
AbnPeopleCode	String
Attributes	Attribute collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionValue collection ^RO
CascadedRolePermissions	RolePermissionValue collection ^RO
ContentRefs	ContentReference Collection ^RO
CreationDate	String ^RO
DefaultChartNavigation	Boolean
Description	String
Folders	Folder collection ^RO
IsVisible	Boolean ^RO
Label	String
Name	String ^RO
OwnerID	String
ParentName	String ^RO
Path	String ^RO
Permissions	PermissionValue collection ^RO
Product	String
PublicAccess	Boolean
RolePermissions	RolePermissionValue collection ^RO
SequenceNumber	Number
TreeEffectiveDate	String
TreeName	String
TreeSetId	String
TreeStructureName	String
TreeUserKeyValue	String
ValidFrom	String
ValidTo	String

Folder Collection Methods

Method	Returns
DeleteItem(FolderName)	Boolean
First()	Folder object
InsertItem(FolderName, Label)	Folder object
ItemByName(FolderName)	Folder object
Next()	Folder object

Folder Collection Property

Property	Returns
Count	Number ^RO

ContentReference Methods

Method	Returns
CreateLink(Name, Label)	ContentReference link object
Save()	Boolean

ContentReference Properties

Property	Returns
AbsoluteContentURL	String ^RO
AbsolutePortalURL	String ^RO
AssignedPagelets	AssignedPagelets collection ^RO
Attributes	Attribute collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionValue collection ^RO
CascadedRolePermissions	RolePermissionValue collection ^RO
ContentProvider	String
CreationDate	String ^RO
Data	String
Description	String
HtmlText	String ^RO
IsVisible	Boolean ^RO
Label	String
Links	Link collection ^RO
Name	String ^RO
OwnerId	String
ParentName	String ^RO
Path	String ^RO
Permissions	PermissionValue collection ^RO
Product	String
PublicAccess	Boolean
RelativeURL	String ^RO
RolePermissions	RolePermissionValue collection ^RO
SequenceNumber	Number
StorageType	String
Template	String
TemplateObject	ContentReference object ^RO
TemplateType	String
URL	String
URLType	String
UsageType	String
ValidFrom	String
ValidTo	String

ContentReference Collection Methods

Method	Returns
DeleteItem(ContentReferenceName)	Boolean
First()	ContentReference object
InsertItem(ContentReferenceName, ContentReferenceLabel, Node, URL)	ContentReference object
ItemByName(ContentReferenceName)	ContentReference object
Next()	ContentReference object

ContentReference Collection Property

Property	Returns
Count	Number ^RO

AttributeValue Properties

Property	Returns
Label	String
Name	String ^RO
Translatable	Boolean
Value	String

AttributeValue Collection Methods

Method	Returns
DeleteItem(AttributeValueName)	Boolean
First()	AttributeValue object
InsertItem(AttributeValueName)	AttributeValue object
ItemByName(AttributeValueName)	AttributeValue object
Next()	AttributeValue object

AttributeValue Collection Property

Property	Returns
Count	Number ^RO

PermissionValue Properties

Property	Returns
Cascade	Boolean
Name	String

PermissionValue Collection Methods

Method	Returns
DeleteItem(PermissionValueName)	Boolean
First()	PermissionValue object
InsertItem(PermissionValueName)	PermissionValue object
ItemByName(PermissionValueName)	PermissionValue object
Next()	PermissionValue object

PermissionValue Collection Property

Property	Returns
Count	Number ^RO

RolePermissionValue Collection Methods

Method	Returns
DeleteItem(PermissionValueName)	Boolean
First()	PermissionValue object
InsertItem(PermissionValueName)	PermissionValue object
ItemByName(PermissionValueName)	PermissionValue object
Next()	PermissionValue object

RolePermissionValue Collection Property

Property	Returns
Count	Number ^RO

ContentReference Link Methods

Method	Returns
Delete()	Boolean
Save()	Boolean

ContentReference Link Properties

Property	Returns
AbsoluteContentURL	String ^RO
AbsolutePortalURL	String ^RO
Attributes	Attribute Collection
Author	String ^RO
AuthorAccess	Boolean ^RO
Authorized	Boolean ^RO
CascadedPermissions	PermissionValue collection ^RO
ContentProvider	String ^RO
CreationDate	String ^RO
Data	String
Description	String
IsVisible	Boolean ^RO
Label	String
Name	String
OwnerId	String
ParentName	String
Path	String ^RO
Permissions	PermissionValue Collection ^RO
Product	String
PublicAccess	Boolean ^RO
RelativeURL	String ^RO
SequenceNumber	String
Template	String
TemplateObject	String ^RO
TemplateType	String
URL	String
URLType	String ^RO
ValidFrom	Date
ValidTo	Date

Link Collection Methods

Method	Returns
First	Link object
Next	Link object

Link Collection Property

Property	Returns
Count	Number ^RO

Link Class Properties

Property	Returns
LinksObjectName	String ^RO
LinksObjectType	String ^RO
LinksPortalName	String ^RO

TabDefinition Method

Method	Returns
Save()	Boolean

TabDefinition Properties

Property	Returns
AssignedPagelets	AssignedPagelets collection ^RO
AvailableCategories	AvailableCategories collection ^RO
AvailablePagelets	AvailablePagelets collection ^RO
Attributes	AttributeValue collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
ColumnLayout	String
CreationDate	String ^RO
Description	String
DynamicCategories	DynamicCategories collection ^RO
HelpID	String
HtmlText	String ^RO
IsHideActionBar	Boolean
IsLayoutLocked	Boolean
IsRenamable	Boolean
Label	String
LayoutBehavior	String
Name	String ^RO
OwnerId	String
Product	String
PublicAccess	Boolean
QualifiedURL	String ^RO
SequenceNumber	Number
StyleSheet	String
ValidFrom	String
ValidTo	String

TabDefinition Collection Methods

Method	Returns
DeleteItem(TabDefinitionName)	Boolean
First()	TabDefinition object
InsertItem(TabDefinitionName)	TabDefinition object
ItemByName(TabDefinitionName)	TabDefinition object
Next()	TabDefinition object

TabDefinition Collection Property

Property	Returns
Count	Number ^RO

AssignedPagelet Properties

Property	Returns
Column	Number
LayoutBehavior	String
PageletName	String ^RO
Row	Number

AssignedPagelet Collection Methods

Method	Returns
DeleteItem(PageletName)	Boolean
First()	Pagelet object
InsertItem(PageletName, Column, Row, LayoutBehavior)	Pagelet object
ItemByName(PageletName)	Pagelet object
Next()	Pagelet object

AssignedPagelet Collection Property

Property	Returns
Count	Number ^RO

AvailableCategory Properties

Property	Returns
AvailablePagelets	AvailablePagelets Collection ^RO
CategoryName	String ^RO

AvailableCategory Collection Methods

Method	Returns
First()	AvailableCategory object
ItemByName(Name)	AvailableCategory object
Next()	AvailableCategory object

AvailableCategory Collection Property

Property	Returns
Count	Number ^RO

AvailablePagelet Properties

Property	Returns
CategoryLabel	String ^RO
CategoryName	String ^RO
Column	Number ^RO
LayoutBehavior	String ^RO
PageletLabel	String ^RO
PageletName	String ^RO
Row	Number ^RO

AvailablePagelet Collection Methods

Method	Returns
First()	AvailablePagelet object
ItemByName(Name)	AvailablePagelet object
Next()	AvailablePagelet object

AvailablePagelet Collection Property

Property	Returns
Count	Number ^RO

DynamicCategory Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	String
InsertItem(Name)	String
ItemByName(Name)	String
Next()	String

DynamicCategory Collection Property

Property	Returns
Count	Number ^RO

PageletCategory Method

Method	Returns
Save()	Boolean

PageletCategory Properties

Property	Returns
Attributes	AttributeValues collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionList object ^RO
CreationDate	String ^RO
Description	String
Label	String
Name	String ^RO
OwnerId	String
Pagelets	Pagelets Collection ^RO
Permissions	PermissionList Collection ^RO
Product	String
PublicAccess	Boolean
SequenceNumber	Number

PageletCategory Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	String
InsertItem(Name, Label)	String
ItemByName(Name)	String
Next()	String

PageletCategory Collection Property

Property	Returns
Count	Number ^RO

Pagelet Method

Method	Returns
Save()	Boolean

Pagelet Properties

Property	Returns
Attributes	Attribute collection object ^RO
Author	String ^RO
AuthorAccess	Boolean
Authorized	Boolean
CascadedPermissions	PermissionList Collection ^RO
ContentProvider	Node object ^RO
CreationDate	String ^RO
DefaultColumn	Number
Description	String
HelpID	String
IsHideMinimize	Boolean
Label	String
Name	String ^RO
OwnerId	String
ParentName	String ^RO
Permissions	PermissionList Collection ^RO
Product	String
PublicAccess	Boolean
QualifiedURL	String ^RO
SequenceNumber	Number
URL	String
URLType	String

Pagelet Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	Pagelet object
InsertItem(Name, Label, NodeName, URL)	Pagelet object
ItemByName(Name)	Pagelet object
Next()	Pagelet object

Pagelet Collection Property

Property	Returns
Count	Number ^RO

UserHomepage Method

Method	Returns
Save()

UserHomepage Properties

Property	Returns
Greeting	String
UserId	String ^RO
UserTab	UserTab Collection^RO

UserTab Properties

Property	Returns
ColumnLayout	Number
Label	String
QualifiedURL	String ^RO
SelectedPagelets	SelectedPagelets collection^RO
SequenceNumber	Number
TabName	String ^RO

UserTab Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	UserTab object
InsertItem(Name)	UserTab object
ItemByName(Name)	UserTab object
Next()	UserTab object

UserTab Collection Property

Property	Returns
Count	Number ^RO

SelectedPagelet Properties

Property	Returns
CategoryName	String ^RO
Column	Number
IsMinimized	Boolean
PageletName	String ^RO
Row	Number

SelectedPagelet Collection Methods

Method	Returns
DeleteItem(Name)	Boolean
First()	SelectedPagelet object
InsertItem(Name)	SelectedPagelet object
ItemByName(Name)	SelectedPagelet object
Next()	SelectedPagelet object

SelectedPagelet Collection Property

Property	Returns
Count	Number ^RO

Favorites Properties

Property	Returns
CRefName	String ^RO
Label	String
QualifiedURL	String ^RO
SequenceNumber	Number
URL	String

Favorites Collection Methods

Method	Returns
DeleteItem(FavoriteLabel)	Boolean
First()	Favorite object
InsertItem(FavoriteLabel, FavoriteName)	Favorite object
ItemByLabel(FavoriteLabel)	Favorite object
Next()	Favorite object

Favorites Collection Property

Property	Returns
Count	Number ^RO

Query Classes Methods and Properties

This section lists the functions, methods, and properties, as well as returns (if applicable) for the query classes.

Query Collection Methods

Method	Returns
First()	Query object
Item(Number)	Query object
ItemByName(Name)	Query object
Next()	Query object

Query Collection Property

Property	Returns
Count	Number ^RO

Query Methods

Method	Returns
AddPrompt(PromptName)	Prompt object
AddQuerySelect()	QuerySelect object
AddTrackingURL(URLString)	None
Close()	None
CopyPrivateQuery(QueryName, QryType, TargetUserId)	Number
Create(QueryName, Pubic, Type, Description, LongDescription)	Query object
Delete()	Number
DeletePrompt(PromptName)	Number
FindExpression(Number)	Expression object
FormatBinaryResultString(&Rowset, Output_Format, StartRow, EndRow)	Binary object
FormatResultString(&Rowset, Output_Format, StartRow, EndRow)	String
GetTreePromptCount()	Number
Open(QueryName, Public, Update)	Number
Rename(NewQueryName)	Number
RunToFile(&PromptRecord, Destination, OutputFormat, MaxRows)	Number
RunToRowset(&PromptRecord, MaxRows)	Rowset object
RunToString (&PromptRecord, ChunkSize, OutputFormat, MaxRows)	String
Save()	Number
SetTrackingURL(ExpressionText, ExpressionNumber)	None

Query Properties

Property	Returns
Approved	String
ApprovedDtTm	String ^RO
ApprovedUserId	String
CreateDtTm	String ^RO
CreateUserId	String ^RO
Description	String
ExecAppName	String
ExecLogging	Boolean
LastSQLErrorCode	Number ^RO
LastUpdDttm	String ^RO
LastUpdOprId	String ^RO
LongDescription	String
Metadata	Metadata collection ^RO
MoreRowsAvailable	Boolean ^RO
Name	String ^RO
OutputUnicode	Boolean
PDFFont	String
Prompts	QueryPrompt collection ^RO
PromptRecord	Record object ^RO
PublicPrivate	String
QuerySelect	QuerySelect object ^RO
QueryStatistics	QueryStatistics object ^RO
RunTimePrompts	QueryPrompt Collection ^RO
SQL	String ^RO
Type	Number

QuerySelect Methods

Method	Returns
AddAllFields(QueryRecord)	Number
AddCriteria(Name)	QueryCriteria object
AddExpression(Name)	QueryExpression object
AddHavingCriteria(Name)	QueryCriteria object
AddQueryOutputField(QueryRecord, index)	QueryOutputField object
AddQueryRecord(QueryRecordName)	QueryRecord object
AddQuerySelectedField(QueryRecord, index)	QuerySelectedField object
DeleteCriteria(index)	Number
DeleteExpression(Index)	Number
DeleteField(Index)	Number
DeleteHavingCriteria(Index)	Number
DeleteRecord(Index)	Number

QuerySelect Properties

Property	Returns
Criteria	QueryCriteria collection ^RO
Distinct	Boolean
Expressions	QueryExpression collection ^RO
HavingCriteria	QueryCriteria collection ^RO
ParentSelectNum	Number ^RO
QueryOutputFields	QueryField collection ^RO
QueryRecords	QueryRecord collection ^RO
QuerySelectedFields	QueryField collection ^RO
QuerySelects	QuerySelect object ^RO
SelectNum	Number ^RO
SelectType	Number ^RO

QuerySelect Collection Methods

Method	Returns
AddUnion()	QuerySelect object
DeleteQuerySelect(SelNumber)	Number
First()	QuerySelect object
Item(Number)	QuerySelect object
ItemBySelNum(SelNumber)	QuerySelect object
Next()	QuerySelect object

QuerySelect Collection Properties

Property	Returns
Count	Number ^RO

QueryRecord Collection Methods

Method	Returns
First()	QueryRecord object
Item(Number)	QueryRecord object
ItemByAlias(Alias)	QueryRecord object
Next()	QueryRecord object

QueryRecord Collection Property

Property	Returns
Count	Number ^RO

QueryRecord Method

Method	Returns
GetField(Index)	QueryField object

QueryRecord Properties

Property	Returns
Description	String ^RO
JoinAlias	String
JoinFieldName	String
JoinType	Number
Name	String ^RO
QueryFields	QueryFields collection ^RO
RecordAlias	String

QueryField Collection Methods

Method	Returns
First()	QueryField object
Item(Number)	QueryField object
ItemByNameAndAlias(Name, RecordAlias)	QueryField object
ItemByExpNum(ExpNum)	QueryField object
Next()	QueryField object

QueryField Collection Property

Property	Returns
Count	Number ^RO

QueryField Methods

Method	Returns
AddTranslateExpression(ExpressionName)	QueryExpression object
AddTranslateField(FieldName)	QueryField object
GetImageFormat()	Number

QueryField Properties

Property	Returns
Aggregate	Number
ColumnNumber	Number
Description	String ^RO
Decimal	Number ^RO
ExpNum	Number
Flag	Number ^RO
Format	Number
HeadingText	String
HeadingType	String
HeadingUniqueFieldName	String
Length	Number ^RO
LongName	String ^RO
Name	String ^RO
OrderByDirection	Number
OrderByNumber	Number
QueryRecord	QueryRecord object ^RO
RecordAlias	String ^RO
ShortName	String ^RO
TranslateEffDtLogic	String
TranslateExpression	Expression object ^RO
TranslateField	QueryField ^RO
TranslateOption	String
Type	String

QueryCriteria Collection Methods

Method	Returns
First()	QueryCriteria object
Item(Number)	QueryCriteria object
ItemByName(CriteriaName)	QueryCriteria object
Next()	QueryCriteria object

QueryCriteria Collection Property

Property	Returns
Count	Number ^RO

QueryCriteria Methods

Method	Returns
AddExpr1Expression()	QueryExpression object
AddExpr1Field(QueryRecordAlias, FieldName)	QueryField object
AddExpr2Expression()	QueryExpression object
AddExpr2Field1(QueryRecordAlias, FieldName)	QueryField object
AddExpr2Field2(QueryRecordAlias, FieldName)	QueryField object
AddExpr2List()	QueryList object
AddExpr2Subquery()	QuerySelect object

QueryCriteria Properties

Property	Returns
Expr1Expression	QueryExpression object
Expr1Field	QueryField object ^RO
Expr1Type	Number
Expr2Constant1	String
Expr2Constant2	String
Expr2Expression1	QueryExpression object
Expr2Expression2	QueryExpression object
Expr2Field1	QueryField object ^RO
Expr2Field2	QueryField object ^RO
Expr2List	QueryList object ^RO
Expr2Subquery	QuerySelect object ^RO
Expr2Type	Number
Logical	Number
LParenLvl	Number
Name	String ^RO
Negation	Boolean
Operator	Number
R1ExprNum	Number
R2ExprNum	Number
R1ExprType	Number
R2ExprType	Number
RParenLvl	Number

QueryExpression Collection Methods

Method	Returns
First()	QueryExpression object
Item(Number)	QueryExpression object
ItemByName(ExpressionName)	QueryExpression object
Next()	QueryExpression object

QueryExpression Collection Property

Property	Returns
Count	Number ^RO

QueryExpression Properties

Property	Returns
Aggregate	Number
BindFlag	Number
Decimal	Number
ExpNum	Number
Length	Number
Name	String ^RO
OutputField	QueryField object
RightExprFlag	Number
SelectedField	QueryField object
Text	String
Type	Number

QueryList Methods

Method	Returns
AddListValue(Value, IsPrompt)	QueryListValue object
First()	QueryListValue object
Item(Number)	QueryListValue object
Next()	QueryListValue object

QueryList Property

Property	Returns
Count	Number ^RO

QueryListValue Properties

Property	Returns
IsPrompt	Boolean ^RO
Value	String ^RO

QueryRecordHierarchy Collection Methods

Method	Returns
First()	QueryRecordHierarchy object
Item(Number)	QueryRecordHierarchy object
ItemByName(Name)	QueryRecordHierarchy object
Next()	QueryRecordHierarchy object

QueryRecordHierarchy Collection Property

Property	Returns
Count	Number ^RO

QueryRecordHierarchy Properties

Property	Returns
Description	String ^RO
Level	Number ^RO
Name	String ^RO
ParentFlag	Number ^RO

Query Metadata Collection Methods

Method	Returns
First()	Query Metadata object
Item(Number)	Query Metadata object
ItemByName(Name)	Query Metadata object
Next()	Query Metadata object

Query Metadata Collection Property

Property	Returns
Count	Number ^RO

Query Metadata Properties

Property	Returns
Name	String ^RO
Value	String ^RO

QueryStatistics Properties

Property	Returns
AvgExecTime	Number ^RO
AvgFetchTime	Number ^RO
AvgNumRows	Number ^RO
ExecCount	Number ^RO
LastExecDtTm	String ^RO

QuerySecurityProfile Properties

Property	Returns
AllowAnyJoin	Boolean ^RO
AllowDistinct	Boolean ^RO
AllowExpressions	Boolean ^RO
AllowSubqueries	Boolean ^RO
AllowUnions	Boolean ^RO
ApprovePrivateQuery	Boolean ^RO
ApprovePublicQuery	Boolean ^RO
CanCreatePublic	Boolean ^RO
CanCreateWorkFlow	Boolean ^RO
CanModifyQuery	Boolean ^RO
CanRunQuery	Boolean ^RO
CanRunToCrystal	Boolean ^RO
CanRunToExcel	Boolean ^RO
LimitUnapproved	Boolean ^RO
MaxInTreeCriteria	Boolean ^RO
MaxJoins	Boolean ^RO
MaxRowsToFetch	Boolean ^RO
MaxUnapprovedRows	Boolean ^RO

QueryDBRecord Collection Methods

Method	Returns
First()	QueryDBRecord object
Item(Number)	QueryDBRecord object
ItemByName(Name)	QueryDBRecord object
Next()	QueryDBRecord object

QueryDBRecord Collection Property

Property	Returns
Count	Number ^RO

QueryDBRecord Methods

Method	Returns
QueryDBRecordFieldByIndex(Index)	QueryDBRecordField object
QueryDBRecordFieldByName(Name)	QueryDBRecordField object

QueryDBRecord Properties

Property	Returns
Description	String ^RO
Name	String ^RO
QueryDBRecordFields	QueryDBRecordFields collection
RecordHierarchy	QueryRecordHierarchy Collection ^RO

QueryDBRecordField Collection Methods

Method	Returns
First()	QueryDBRecordField object
Item(Number)	QueryDBRecordField object
ItemByName(Name)	QueryDBRecordField object
Next()	QueryDBRecordField object
Sort(SortCriteria)	0

QueryDBRecordField Collection Property

Property	Returns
Count	Number ^RO

QueryDBRecordField Method

Method	Returns
GetImageFormat()	Number

QueryDBRecordField Properties

Property	Returns
Decimal	Number ^RO
Description	String ^RO
Flag	Number ^RO
Format	Number ^RO
Length	Number ^RO
LongName	String ^RO
LookupTableName	String ^RO
LookupTableRecord	QueryDBRecord object ^RO
Name	String ^RO
ShortName	String ^RO
Type	Number ^RO

QueryPrompt Collection Methods

Method	Returns
First()	QueryPrompt object
Item(Number)	QueryPrompt object
ItemByName(Name)	QueryPrompt object
Next()	QueryPrompt object

QueryPrompt Collection Property

Property	Returns
Count	Number ^RO

QueryPrompt Properties

Property	Returns
EditType	Number
FieldDecimal	Number
FieldFormat	Number
FieldLength	Number
FieldName	String
FieldType	Number
HeadingText	String
HeadingType	Number
LangCount	Number ^RO
Name	String ^RO
PromptRecordFieldName	String ^RO
PromptTable	String
UniquePromptName	String
UseCount	Number ^RO

Tree Classes Methods and Properties

This section lists the methods and properties, as well as returns (if applicable) for the tree classes.

Branch Collection Properties

Property	Returns
Count	Number ^RO

Leaf Methods

Method	Returns
Cut()	Number
Delete()	Number
DeleteByRange(RangeFrom, RangeTo)	Number
GenABNMenuElement()	String
InsertDynSib()	Number
InsertSib(RangeFrom, RangeTo)	Leaf object
LoadABNChart(&chart_rowset, &relactions_rowset	None
LoadABNChartOrdered(&chart_rowset, &relactions_rowset, order	None
MoveAsChild(Node)	Number
MoveAsChildByName(NodeName)	Number
MoveAsSib(Leaf)	Number
MoveAsSibByRange(RangeFrom, RangeTo)	Number
PasteSib()	Number
RefreshDescription(expand_range)	Number
UpdateRanges(RangeFrom, RangeTo)	Number

Leaf Properties

Property	Returns
Description	String ^RO
DisplayLevelNumber	Number ^RO
Dynamic	Boolean
HasNextSib	Boolean ^RO
HasPrevSib	Boolean ^RO
ImageName	String
IsChanged	Boolean ^RO
IsCut	Boolean ^RO
IsDeleted	Boolean ^RO
IsInserted	Boolean ^RO
NextSib	Leaf object ^RO
Parent	Node object ^RO
PrevSib	Leaf object ^RO
RangeFrom	String
RangeTo	String
TreeBranchName	String ^RO
TreeEffDt	Date
TreeName	String ^RO
TreeSetID	String ^RO
TreeUserKeyValue	String ^RO

Level Collection Methods

Method	Returns
Add(LevelName)	Level object
Item(LevelName, LevelNumber)	Level object
Remove()	Number

Level Collection Properties

Property	Returns
Count	Number ^RO
First	Level object ^RO
Last	Level object ^RO
Next	Level object ^RO

Level Properties

Property	Returns
AllValuesAudit	Boolean
Description	String
Name	String
Number	Number
TreeBranchName	String ^RO
TreeEffDt	Date
TreeName	String ^RO
TreeSetID	String ^RO
TreeUserKeyValue	String ^RO

Node Methods

Method	Returns
Branch()	Number
Cut()	Number
Delete()	Number
DeleteByName(NodeName)	Number
Expand(ExpandType)	Number
GenABNMenuElement(initial_node)	String
GenBreadCrumbs(list)	String
GenRelatedActions()	String
InsertChildLeaf(RangeFrom, RangeTo)	Leaf object
InsertChildNode(NodeName)	Node object
InsertChildRecord(NodeName)	Node object
InsertDynChildLeaf()	Leaf object
InsertSib(NodeName)	Node object
InsertSibRecord(NodeName)	Node object
LoadABNChart(&chart_rowset, &relactions_rowset, requested_node, initial_node)	None
LoadABNChartOrdered(&chart_rowset, &relactions_rowset, requested_node, initial_node, order)	None
MoveAsChild(Node)	Number
MoveAsChildByName(NodeName)	Number
MoveAsSib(Node)	Number
MoveAsSibByName(NodeName)	Number
PasteChild()	Number
PasteSib()	Number
RefreshDescription()	Number
Rename(NodeName)	Number
SwitchLevel(NewLevelNumber)	Number
Unbranch()	Number

Node Properties

Property	Returns
AllChildCount	Number ^RO
AllChildNodeCount	Number ^RO
ChildLeafCount	Number ^RO
ChildNodeCount	Number ^RO
ColImageName	String
Description	String ^RO
DisplayLevelNumber	Number ^RO
ExpImageName	String
FirstChildLeaf	Leaf object ^RO
FirstChildNode	Node object ^RO
HasChildLeaves	Boolean ^RO
HasChildNodes	Boolean ^RO
HasChildren	Boolean ^RO
HasNextSib	Boolean ^RO
HasPrevSib	Boolean ^RO
IsBranched	Boolean ^RO
IsChanged	Boolean ^RO
IsCut	Boolean ^RO
IsDeleted	Boolean ^RO
IsInserted	Boolean ^RO
IsRoot	Boolean ^RO
LastChildLeaf	Leaf object ^RO
LastChildNode	Node object ^RO
LevelNumber	Number
Name	String
NextSib	Leaf object ^RO
Parent	Node object ^RO
PrevSib	Leaf object ^RO
State	Number ^RO
TreeBranchName	String ^RO
TreeEffDt	Date
TreeName	String ^RO
TreeSetID	String ^RO
TreeUserKeyValue	String ^RO
Type	String ^RO

Tree Methods

Method	Returns
Audit()	Number
AuditByName(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
Close()	Number
Copy(FromSetId, FromUserKeyValue, FromTreeName, FromEffDt, FromBranchName, ToSetId, ToUserKeyValue, ToTreeName, ToEffDt, ToBranchName)	Number
Create(SetID, UserKeyValue, TreeName, EffDt, StructureName)	Number
Delete(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
Exists(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
FindLeaf(RangeFrom, RangeTo)	Leaf object
FindNode(NodeName, Description)	Node object
FindRoot()	Node object
InsertRoot(NodeName)	Node object
LeafExists(RangeFrom, RangeTo)	Number
LockTree()	Number
Open(SetID, UserKeyValue, TreeName, EffDt, BranchName, Update)	Number
OpenAsOfDate(SetID, UserKeyValue, TreeName, AsOfDate, BranchName, Update)	Number
OpenForExport(SetID, UserKeyValue, TreeName EffDt)	Number.
OpenWholeTree(SetID, UserKeyValue, TreeName, EffDt)	Number
NodeExists(NodeName)	Number
Rename(FromSetId, FromUserKeyValue, FromTreeName, FromEffDt, FromBranchName, ToTreeName)	Number
Save()	Number
SaveAs(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
SaveAsDraft(SetID, UserKeyValue, TreeName, EffDt, BranchName)	Number
SaveDraft()	Number
SetImportMode(Nodes_Number, Leaves_Number)	Number
TreeLocksNumber(setID, UserKeyValue, TreeName, EffDt)	Number
UnlockTree()	Number
UpdateLock()	Number

Tree Properties

Property	Returns
AllValues	Boolean
AuditDetails	Boolean
Branches	Branch collection object ^RO
BranchImageName	String
BranchLevel	Number ^RO
BranchName	String ^RO
Category	String
Description	String
DuplicateLeaves	Boolean
EffDt	Date
HasDetailRanges	Boolean ^RO
HasLockedBranches	Boolean ^RO
IsBranched	Boolean ^RO
IsChanged	Boolean ^RO
IsOpen	Boolean ^RO
IsQueryTree	Boolean ^RO
IsValid	Boolean ^RO
IsVersionChanged	Boolean ^RO
IsWholeTree	Boolean ^RO
KeyBranchName	String ^RO
KeyEffDt	String ^RO
KeyName	String ^RO
KeySetID	String ^RO
KeyUserKeyValue	String ^RO
LeafCount	Number ^RO
LeafImageName	String
LeafOnClipboard	Boolean ^RO
LevelCount	Number ^RO
Levels	Level collection object ^RO
LevelUse	String
LockOwner	String, ^RO
Name	String
NodeColImage	String
NodeCount	Number ^RO
NodeExpImage	String
NodeOnClipboard	Boolean ^RO
ParentLevel	Number ^RO
ParentName	String ^RO
PerformanceMethod	String
PerformanceSelector	String
PerformanceSelectorOption	String
SetId	String
Status	String
Structure	Tree structure object ^RO
StructureName	String ^RO
TreeImageName	String
UserKeyValue	String
UseUpdateReservation	Boolean ^RO

Tree Structure Methods

Method	Returns
Close()	Number
Copy(FromStructId, ToStructId)	Number
Create(StructId, Type)	Number
Delete(StructId)	Number
Open(StructId, Update)	Number
Rename(FromStructId, ToStructId)	Number
Save()	Number

Tree Structure Properties

Property	Returns
Description	String
DetailComponent	String
DetailField	String
DetailMenu	String
DetailMenuBar	String
DetailMenuItem	String
DetailMultiNavigate	Boolean
DetailPage	String
DetailRecord	String
IndirectionMethod	String
KeyName	String ^RO
LevelComponent	String
LevellMenu	String
LevelMenuBar	String
LevelMenuItem	String
LevelPage	String
LevelRecord	String
Name	String
NodeComponent	String
NodeField	String
NodelMenu	String
NodeMenuBar	String
NodeMenuItem	String
NodeMultiNavigate	Boolean
NodePage	String
NodeRecord	String
NodeUserKeyField	String
SummarySetId	String
SummaryLevelNumber	String
SummaryTreeName	String
SummaryUserKeyValue	String
Type	String

Deprecated Items and PeopleCode No Longer Supported

This section discusses the following:

Mapping of old objects to new objects.
Deprecated products and classes.
Deprecated functions.
Deprecated methods and properties.
Deprecated XML Publisher items.
XML Publisher items no longer supported.
Deprecated messaging PeopleCode functions, methods and properties.
Functions no longer supported.

Mapping of Old Objects to New Objects

In PeopleTools 8.1, the names of some of the object definitions in Application Designer changed. The names of related built-in functions have changed accordingly.

The first table lists the old terms and new terms.

In the second table, the left column lists the old names of the functions, system variables, or reserved words. The right column lists the new names. The old functions, system variables, and reserved words in this table still work in PeopleTools; however, they have been deprecated and are being retained for backward compatibility only. New applications should be created using the new functions, system variables, and reserved words.

Old Term	New Term
Operator	User
Panel	Page
Panel Group	Component
Business Component	Component Interface

Deprecated Function, System Variable or Reserved Word	New Function, System Variable or Reserved Word
DoModalPanelGroup built-in function	DoModalComponent built-in function
GetNextNumberWithGaps	GetNextNumberWithGapsCommit built-in function
IsModalPanelGroup built-in function	IsModalComponent built-in function
IsOperatorInClass built-in function	IsUserInPermissionList built-in function
PanelGroupChanged built-in function	ComponentChanged built-in function
ScheduleProcess built-in function	CreateProcessRequest built-in function
SetNextPanel built-in function	SetNextPage built-in function
TransferPanel built-in function	TransferPage built-in function
%OperatorClass System Variable	%PrimaryPermissionList System Variable
%OperatorID System Variable	%UserId System Variable
%OperatorRowLevelSecurityClass System Variable	%RowSecurityPermissionList System Variable
%Panel System Variable	%Page System Variable
%PanelGroup System Variable	%Component System Variable
PANEL reserved word	PAGE reserved word
PANELGROUP reserved word	COMPONENT reserved word
PanelGroup variable declaration	Component variable declaration

Business Components are now named Component Interfaces. Therefore, for Component Interfaces, the old reserved word, methods, and system variables are no longer valid. You must use the new reserved word, methods, or system variables.

No Longer Valid	Use Instead
COMPONENT reserved word	COMPINTFC reserved word
GetComponent method	GetCompIntfc method
FindComponent method	FindCompIntfcs method
%Component system variable	%CompIntfc system variable

Deprecated Products and Classes

The following products and their supporting classes have been deprecated:

PeopleSoft Business Interlinks
- Business Interlinks class
- BIDocs class
PeopleSoft Mobile Agent
- Mobile class
- PropertyInfo collection
- CI collection
- Data collection
- ListViewAttrs class
- PropertyAttrs class
- PeerDefaultAttributes class
- SyncServer class

Deprecated Business Interlinks Class

PeopleSoft Business Interlinks is a deprecated product. The Business Interlinks class currently exists for backward compatibility only. For new integrations, use Integration Broker instead.

This section lists the deprecated functions, methods, and properties, as well as returns (if applicable) for the Business Interlinks and BIDocs classes.

Deprecated Business Interlink Functions

Deprecated Function	Returns
GetBIDoc([XMLString])	BIDoc object
GetInterlink(INTERLINK.name)	Business Interlink object

Deprecated Business Interlink Methods

Deprecated Method	Returns
AddInputRow(inputname, value)	Boolean
BulkExecute(RECORD.inputrec [, RECORD.outputrec] [, user_process_inst \| user_operid])	Number
Clear()	None
Execute()	Number
FetchIntoRecord(RECORD.recname, [, user_process_inst \| user_operid])	Number
FetchIntoRowset(&Rowset)	Number
FetchNextRow(outputname, value)	Output row object
GetFieldCount()	Number
GetFieldType(index)	Number
GetFieldValue(index)	String
InputRowset(&Rowset)	Number
MoveFirst()	Boolean
MoveNext()	Boolean

Deprecated Business Interlink Property

Deprecated Property	Returns
StopAtError	Boolean

Deprecated BIDoc Configuration Parameters

Deprecated Configuration Parameters	Returns
URL	String
All other configuration parameters can be accessed like read-write properties.	Depends on type of Interlink plug-in.

Deprecated BIDoc Methods

Deprecated Method	Returns
AddAttribute(attributename, attributevalue)	Number
AddComment(comment)	Number
AddProcessingInstruction(instruction)	Number
AddText(text)	Number
CreateElement(elementname)	BIDoc object
GenXMLString()	String
GetAttributeName(attributenumber)	String
GetAttributeValue({attributenumber \| attributename})	String
GetNode({nodenumber \| nodename})	BIDoc object

Other Business Interlinks Features That Have Been Deprecated

Other classes include functionality specifically added for the PeopleSoft Business Interlinks product. With the deprecation of PeopleSoft Business Interlinks, these features are deprecated as well.

Deprecated Item	Returns
Request class, GetContentBody() method	String

Deprecated Mobile Classes

PeopleSoft Mobile Agent is a deprecated product. These mobile classes currently exist for backward compatibility only.

This section lists the deprecated system variables, functions, methods, and properties, as well as returns (if applicable) for the mobile classes.

Deprecated Mobile Class System Variables

Deprecated System Variable	Returns
%DeviceType	The type of the mobile device
%MobilePage	The name of the current mobile page
%ThisMobileObject	Mobile object

Deprecated Mobile Class Functions

Deprecated Function	Returns
IsDisconnectedClient()	Boolean
GenerateMobileTree(CIObject [,CIObject_property])	None
MSFGetNextNumber(Key1, Key2, Key3)	Number
TransferMobilePage(MOBILEPAGE.PageName, Tab, CIObject)	None

Deprecated Mobile Class Methods

Deprecated Method	Returns
Create()	Boolean
Find()	Collection of empty mobile objects
Get()	Boolean
GetName()	String
GetParent()	Mobile object
GetPropertyAttrsByName(propertyname)	PropertyAttrs object
GetPropertyByName(propertyname)	Depends on property. Will return a collection if propertyname is a collection.
GetPropertyInfoByName(propertyname)	PropertyInfo object
GetTopParent()	Mobile object
IsNew()	Boolean
IsNewAndNeverSaved()	Boolean
IsSameAs(&MobileObject)	Boolean
ReadBlobFromFile(blobpropertyname, filename	Boolean
Save()	Boolean
SetModified(IsModified	Boolean
SetPropertyByName(propertyname)	None
ValidateEnum(propertyname)	Boolean
ValuesDifferFromLastSync()	Boolean
WasSaved()	Boolean
WriteBlobToFile(blobpropertyname, filename)	Boolean

Deprecated Mobile Property

Deprecated Property	Returns
PropertyInfoCollection	PropertyInfoCollection ^RO

Deprecated PropertyInfo Collection Method

Deprecated Method	Returns
Item(number)	PropertyInfo object

Deprecated PropertyInfo Collection Property

Deprecated Property	Returns
Count	Number

Deprecated PropertyInfo Properties

Deprecated Property	Returns
DefaultValue	Depends on the value ^RO
HasDefaultValue	Boolean ^RO
IsCollection	Boolean ^RO
IsRefToParent	Boolean ^RO
IsPeerReference	Boolean ^RO
IsSimpleApplicationProperty	Boolean ^RO
IsSystemProperty	Boolean ^RO
Name	String ^RO
PropertyInfoCollection	PropertyInfo Collection ^RO

Deprecated CI Collection Method

Deprecated Method	Returns
Item(index)	Mobile object

Deprecated CI Collection Property

Deprecated Property	Returns
Count	Number ^RO

Deprecated Data Collection Methods

Deprecated Method	Returns
DeleteItem(location)	Boolean
GetListAttrs(propertyname)	ListViewAttrs object
InsertItem(location)	Boolean
Item(Index)	Mobile object

Deprecated Data Collection Property

Deprecated Property	Returns
Count	Number ^RO

Deprecated ListViewAttrs Method

Deprecated Method	Returns
IsSet(attribute)	Boolean

Deprecated ListViewAttrs Properties

Deprecated Property	Returns
DetailViewLabel	String
Label	String
ListViewLabel	String
Visible	Boolean

Deprecated PropertyAttrs Method

Method	Returns
IsSet(attribute)	Boolean

Deprecated PropertyAttrs Properties

Deprecated Property	Returns
DisplayOnly	Boolean
InError	Boolean
Label	String
ShowRequiredCue	Boolean
Visible	Boolean

Deprecated PeerDefaultAttributes Method

Deprecated Method	Returns
IsSet(attribute)	Boolean

Deprecated PeerDefaultAttributes Properties

Deprecated Property	Returns
DisplayOnly	Boolean
Label	String
Visible	Boolean

Other Mobile Features That Have Been Deprecated

Other classes include functionality specifically added for the PeopleSoft Mobile Agent. With the deprecation of the PeopleSoft Mobile Agent, these features are deprecated as well.

Deprecated Item	Returns
Record class, SystemIDFieldName property	String ^RO
Record class, TimeStampFieldName property	String ^RO
Folder class, IsMobile property	Boolean
ContentReference class, IsMobile property	Boolean
ContentReference link, IsMobile property	Boolean

Deprecated SyncServer Class

PeopleSoft Mobile Agent is a deprecated product. This mobile class currently exists for backward compatibility only.

This section lists the deprecated functions, methods, and properties, as well as returns (if applicable) for the SyncServer class.

Deprecated System Variable

Deprecated System Variable	Returns
%SyncServer	SyncServer object

Deprecated Methods

Deprecated Method	Returns
AddReference(SyncID[, CIDefnName])	None
AddReferenceType(CIDefnName)	None
CheckForChanges(SyncDateTime, TotalRowCount[, HasRefList])	Boolean
SelectAll()	None

Deprecated Properties

Deprecated Property	Returns
ClientPlatform	String
ConflictAlgorithm	String
ConflictStatus	String
ExcludeProperty	String
ExportLocation	String
IsReferenceUnresolved	Boolean, ^RO
LasySyncDateTime	DateTime, ^RO
LastSyncRowCount	Number, ^RO
PropertyValue	String
SessionID	String ^RO
Synchronizing	String
SyncIDs	Array of number
TypeID	String
validateID	String
validateRowCount	Number ^RO
validateVersion	String

Deprecated Functions

The first column in the following table lists built-in PeopleCode functions that existed prior to PeopleTools 8.0. The second column lists the new method or property that should be used instead of the deprecated function. The existing functions still work in PeopleTools 8.0, however, they are being retained for backward compatibility only. New applications should be created using the new classes, methods, and properties.

Deprecated Function	Use Instead
ActiveRowCount	Rowset class, ActiveRowCount property
ClearSearchDefault	Field class, SearchDefault property
ClearSearchEdit	Field class, SearchEdit property
CompareLikeFields	Record class, CompareFields method
CopyFields	Record class, CopyFieldsTo method or CopyChangedFieldsTo method
CopyRow	Row class, CopyTo method
CurrEffDt	Rowset class, DeleteEnabled property
CurrEffRowNum	Row class, RowNumber property in combination with Rowset class, GetCurrEffRow method
CurrEffSeq	Rowset class, EffSeq property
CurrentRowNumber	Row class, RowNumber property
DeleteRecord	Record class, Delete method
DeleteRow	Rowset class, DeleteRow method
FetchValue	Field class, Value property
FieldChanged	Field class, IsChanged property
GetRelField	Field class, GetRelated method
GetStoredFormat	Field class, StoredFormat property
Gray	Field class, Enabled property
Hide	Field class, Visible property
HideRow	Row class, Visible property
HideScroll	Rowset class, HideAllRows method
InsertRow	Rowset class, InsertRow method
IsHidden	Row class, Visible property
NextEffDt	GetNextEffRow().REC.FIELD.Value
NextRelEffDt	GetNextEffRow.()REC.FIELD.GetRelated(rec.field).value
PriorEffDt	GetPriorEffRow().REC.Field.Value
PriorRelEffDt	GetPriorEffRow().REC.FIELD.GetRelated(rec.field).value
RecordChanged	Record class, IsChanged property
RecordDeleted	Record class, IsDeleted property
RecordNew	Row class, IsNew property
RemoteCall for Application Engine	CallAppEngine function
RowFlush	Rowset class, FlushRow method
RowScrollSelect	Rowset class, Select method
RowScrollSelectNew	Rowset class, SelectNew method
ScrollFlush	Rowset class, Flush method
ScrollSelect	Rowset class, Select method
ScrollSelectNew	Rowset class, SelectNew method
SetDefault	Field class, SearchDefault property
SetDefaultAll	Rowset class, SetDefault method
SetDefaultNext	GetNextEffRow().REC.FIELD.SetDefault()
SetDefaultNextRel	GetNextEffRow().REC.Field.GetRelated(REC.FIELD).SetDefault()
SetDefaultPrior	GetPriorEffRow().REC.FIELD.SetDefault()
SetDefaultPriorRel	GetPriorEffRow().REC.Field.GetRelated(REC.FIELD).SetDefault()
SetDisplayFormat	Field class, DisplayFormat property
SetLabel	Field class, Label property
SetSearchDefault	Field class SearchDefault property
SetSearchEdit	Field class, SearchEdit property
SetTracePC	If using API (Session object), use Trace Setting class properties.
SetTraceSQL	If using API (Session object), use Trace Setting class properties.
SortScroll	Rowset class, Sort method
TotalRowCount	Rowset class, RowCount property
Ungray	Field class, Enabled property
UnHide	Field class, Visible property
UnHideRow	Row class, Visible property
UnhideScroll	Rowset class, ShowAllRows method
UpdateValue	Field class, Value property

Deprecated Methods and Properties

The following are the methods and properties that have been deprecated.

Method or Property	Use Instead
Chart class, Refresh method	Chart class, SetData method Chart class, SetOLData method
Chart class, RotationAngle property	Chart class: XRotationAngle, YRotationAngle, and ZRotationAngle properties
Gantt class, Refresh method	Gantt class, SetTaskAppData method Gantt class, SetTaskData method
Query class, RunToTemplate method	No longer supported. This method remains in PeopleTools for PeopleSoft internal use only and should not be implemented in PeopleCode programs.
Session class, Connect method	%Session system variable
Session class FindTree, FindTreeStructure methods	GetTree, GetTreeStructure session class methods (respectively)
Tree collection	All tree collection methods and properties have been deprecated. Use GetTree to access a tree instead.
Tree structure collection	All tree structure collection methods and properties have been deprecated. Use GetTreeStructure to access a tree structure instead.
Item tree branch collection method, and the First, Last, and Next tree branch collection properties	NA
Tree class methods: FindNextDisplayObject FindPreviousDisplayObject	NA
Tree class properties: CheckLeafUserData DisplayLeaf DisplayNode IsReadOnly	NA

Deprecated XML Publisher Items

As of PeopleTools 8.50, a number of XML Publisher classes, methods and properties have been deprecated. These items remain in PeopleTools for backward compatibility only.

Deprecated XML Publisher Methods

Deprecated Method	Use Instead
ReportDefn class, SetRuntimeDataRowset method Note. The rowset data source has been deprecated.	Convert the rowset to an XML file—for example, using the file layout capabilities of the File class is one way to accomplish this. Then, use the SetRuntimeDataXMLFile method of the ReportDefn class to process the XML file as a data source.
ReportDefn class, SetRuntimeDataXMLDoc method Note. The XmlDoc data source has been deprecated.	Convert the XmlDoc object to an XML file—for example, using the genXmlFile method of the XmlDoc class is one way to accomplish. Then, use the SetRuntimeDataXMLFile method of the ReportDefn class to process the XML file as a data source.
Note. The rowset data source has been deprecated. RowsetDS class: AddXMLData method AddXSDSchema method GetXMLData method GetXSDSchema method RowsetDS method	Convert the rowset to an XML file—for example, using the file layout capabilities of the File class is one way to accomplish this. Then, use the SetRuntimeDataXMLFile method of the ReportDefn class to process the XML file as a data source.

Deprecated XML Publisher Properties

Deprecated Property	Use Instead
OutputEditable	Use the Report Definition-Definition page (PSXPRPTPROP) to set report properties to override global properties.

XML Publisher Items No Longer Supported

As of PeopleTools 8.50, a number of XML Publisher classes, methods and properties are no longer supported. These items remain in PeopleTools for PeopleSoft internal use only and should not be implemented in PeopleCode programs.

All methods and properties of the DataSourceDefn class.
Certain methods and properties of the ReportDefn class.
All methods and properties of the TemplateDefn class.
All methods and properties of the TemplateFile class.
All methods and properties of the TranslationFile class.
All methods of the XMLPManager class.
All methods of the QueryDS class.
All methods and properties of the EFTPRocessor class.
All methods and properties of the FOProcessor class.
All methods and properties of the FormProcessor class.
All methods and properties of the FOUtility class.
All methods and properties of the PDFMapTool class.
All methods and properties of the RTFProcessor class.

DataSourceDefn Class Methods

Method	Use Instead
DataSourceDefn(DataSourceID, DataSourceType, Public)	NA
Get()	NA
GetData(&PromptRecord)	NA
GetSampleData()	NA
GetSchema	NA

DataSourceDefn Class Properties

Property	Use Instead
ActiveFlag	NA
Description	NA
IsPublic	NA
LastUpdatedBy	NA
LastUpdateDTTM	NA
Name	NA
ObjectOwnerId	NA
RegisteredBy	NA
RegisteredDTTM	NA
Type	NA

ReportDefn Class Methods

Method	Use Instead
GetActiveTemplatesByDistributionChannel(DistributionChannel, AsOfDate)	NA
GetDataSource()	NA
GetDefaultTemplate()	NA
GetTemplate(TemplateID)	NA
GetTemplateList()	NA
ProcessEtextReport(TemplateID, LanguageCd, AsOfDate)	ReportDefn class, ProcessReport method

ReportDefn Class Properties

Property	Use Instead
AllowRecipientEntry	NA
AllowViewerEntry	NA
ArchiveAfter	NA
BurstFieldName	NA
CategoryId	NA
ID	NA
IsReadOnly	NA
LastUpdateDTTM	NA
LastUpdatedOprId	NA
ObjectOwnerId	NA
RegisteredBy	NA
RegisteredDTTM	NA
SecurityFieldName	NA
SecurityIdType	NA
SecurityJoinTable	NA
TemplateControlFieldName	NA

TemplateDefn Class Methods

Method	Use Instead
TemplateDefn(TemplateID)	NA
Get()	NA
GetActiveTemplateFile(AsOfDate)	NA
GetTemplateFile()	NA
GetTemplateFileList()	NA

TemplateDefn Class Properties

Property	Use Instead
Description	NA
DistributionChannel	NA
ID	NA
IsReadOnly	NA
IsSubTemplate	NA
LanguageCode	NA
LastUpdateDTTM	NA
LastUpdatedOprId	NA
ObjectOwnerId	NA
RegisteredBy	NA
RegisteredDTTM	NA
ReportCategoryId	NA
Type	NA

TemplateFile Class Methods

Method	Use Instead
TemplateFile(&TemplateDefn, EffDate)	NA
GetFile()	NA
GetMapFile()	NA
GetTranslationFile(LanguageCD)	NA
GetTranslationFileList()	NA

TemplateFile Class Properties

Property	Use Instead
EffectiveDate	NA
FileName	NA
MapFileName	NA
Status	NA

TranslationFile Class Method

Method	Use Instead
TranslationFile(&TemplateDefn, EffectiveDate, LanguageCode)	NA
GetFile()	NA

TranslationFile Class Properties

Property	Use Instead
Description	NA
FileName	NA
LanguageCode	NA
Status	NA

XMLPManager Class Methods

Method	Use Instead
GetDatasourceDefnList(DataSourceId, DataSourceIdOp, DataSourceType, Owner, Descr, DescrOp, ObjectOwnerId, Active, CaseSensitive)	NA
GetReportDefnList(ReportID, ReportIdOp, Descr, DescrOp , TemplateId, TemplateIdOp, TemplateDescr, TemplateDescrOp, DatasourceType, DataSourceId, DataSourceIdOp, DataSourceOwner, TemplateType, ReportCategoryId, ReportStatus, CaseSensitive)	NA
GetTemplateDefnList(TemplateId, TemplateIdOp, Descr, DescrOp, TemplateType, DistChannel, ReportCategoryId, IsSubtemplate, CaseSensitive)	NA

QueryDS Class Methods

Method	Use Instead
QueryDS()	NA
GetXMLData(&Query, &Rowset, XSDLocation)	NA
GetXMLSampleData(&Query, &Rowset, Rows, XSDLocation)	NA
GetXSDSchema(&Query)	NA

ETFProcessor Class Methods

Method	Use Instead
EFTProcessor()
GenerateOutput(EFTFile, XMLDataFile, OutputFile, Error)	ReportDefn class, ProcessReport method
GenerateXSL(RTFTemplateFile, XSLOutputFile, Error)	ReportDefn class, ProcessReport method

EFTProcessor Class Properties

Property	Use Instead
ConfFile	ReportDefn class, ProcessReport method
ConfProp	ReportDefn class, ProcessReport method

FOProcessor Class Methods

Method	Use Instead
FOProcessor()	ReportDefn class, ProcessReport method
GenerateMergedOutput(&XSLTemplateFileArray, &XMLDataFileArray, &XliffFileArray, OutputFileName, OutputFormat, Error)	ReportDefn class, ProcessReport method
GenerateMergedOutputFO(&FOFIleArray, OutputFile, OutputFormat, Error)	ReportDefn class, ProcessReport method
GenerateOutput(XSLTemplateFile, XMLDataFile, XLiffFile, OutputFile, OutputFormat, Error)	ReportDefn class, ProcessReport method
GenerateOutputFO(FOFileName, OutputFile, OutputFormat, Error)	ReportDefn class, ProcessReport method

FOProcessor Class Properties

Property	Use Instead
ConfFile	ReportDefn class, ProcessReport method
ConfProp	ReportDefn class, ProcessReport method
Locale	ReportDefn class, ProcessReport method

FormProcessor Class Methods

Method	Use Instead
FormProcessor()	ReportDefn class, ProcessReport method
ExtractFieldNames(PDFTemplateFileName, IncludeReservedNames, FieldNameArray, Error)	ReportDefn class, ProcessReport method
ExtractFieldValues(PDFTemplateFileName, IncludeReservedNames, FieldValueArray, Error)	ReportDefn class, ProcessReport method
FillForm(PDFTemplateFile, XMLDataFile, PDFOutputFile, Error)	ReportDefn class, ProcessReport method

FormProcessor Class Properties

Property	Use Instead
ConfFile	ReportDefn class, ProcessReport method
ConfProp	ReportDefn class, ProcessReport method
Locale	ReportDefn class, ProcessReport method

FOUtility Class Methods

Method	Use Instead
FOUtility()	ReportDefn class, ProcessReport method
GenerateFO(XSLFile, XMLDataFile, OutputFOFile, Error)	ReportDefn class, ProcessReport method
MergeFOs(&FOFileArray, OutputFOFile, Error)	ReportDefn class, ProcessReport method

FOUtility Class Property

Property	Use Instead
Prop	ReportDefn class, ProcessReport method

PDFMapTool Class Methods

Method	Use Instead
PDFMapTool()	ReportDefn class, ProcessReport method
EnableMap(XSDFile, PDFTemplateFile, XMLInputFile, PDFOutputFile)	ReportDefn class, ProcessReport method
extractMap(PDFFile, OutMapFile)	ReportDefn class, ProcessReport method
processForm(PDFTemplateFile, XMLDataFile, MapFile, OutputPDFFile)	ReportDefn class, ProcessReport method

PDFMapTool Class Property

Property	Use Instead
Locale	ReportDefn class, ProcessReport method

RTFProcessor Class Methods

Method	Use Instead
RTFProcessor()	ReportDefn class, ProcessReport method
GenerateXSL(RTFTemplateFile, XSLOutputFile, Error)	ReportDefn class, ProcessReport method
GenerateXSLXliff(RTFTemplateName, XSLOutputFile, XliffOutputFile, Error)	ReportDefn class, ProcessReport method

RTFProcessor Class Properties

Property	Use Instead
ConfFile	ReportDefn class, ProcessReport method
ConfProp	ReportDefn class, ProcessReport method
Locale	ReportDefn class, ProcessReport method

Deprecated Messaging PeopleCode Functions, Methods and Properties

In PeopleTools 8.48, messaging changed significantly. Many of the messaging PeopleCode functions, methods and properties are either deprecated or no longer supported, or their syntax changed.

See Message Classes.

See Understanding PeopleSoft Integration Broker.

Changed Messaging PeopleCode

The following are still valid, however, their syntax changed significantly.

CreateMessage built-in function
IntBroker class, GetMessageErrors method
IntBroker class, SetMessageError method

Deprecated Messaging PeopleCode Built-in Functions

The following table lists the deprecated messaging PeopleCode built-in functions, as well as the method that should be used instead.

Deprecated Function	Replacement Method
CancelPubHeaderXmlDoc	IntBroker class method Cancel, specifying a message type of %IntBroker_BRK
CancelPubXmlDoc	IntBroker class method Cancel, specifying a message type of %IntBroker_PUB
CancelSubXmlDoc	IntBroker class method Cancel, specifying a message type of %IntBroker_SUB
ConnectorRequest	IntBroker class method ConnectorRequest
ConnectorRequestURL	IntBroker class method ConnectorRequestURL
GetMessage	IntBroker class method GetMessage
GetMessageXmlDoc	Message class method GetXmlDoc
GetPubHeaderXmlDoc	IntBroker class method GetMessage specifying a message type of %IntBroker_BRK
GetPubXmlDoc	IntBroker class method GetMessage specifying a message type of %IntBroker_PUB
GetSubXmlDoc	IntBroker class method GetMessage specifying a message type of %IntBroker_SUB
GetSyncLogData	IntBroker class method GetSyncLogData
InBoundPublishXmlDoc	IntBroker class method InboundPublish
IsMessageActive	IntBroker class method IsOperationActive
PublishXmlDoc	IntBroker class method Publish
ReSubmitPubHeaderXmlDoc	IntBroker class method Resubmit specifying a message type of %IntBroker_BRK
ReSubmitPubXmlDoc	IntBroker class method Resubmit specifying a message type of %IntBroker_PUB
ReSubmitSubXmlDoc	IntBroker class method Resubmit specifying a message type of %IntBroker_SUB
SetChannelStatue	IntBroker class method SetQueueStatus
SyncRequestXmlDoc	IntBroker class method SyncRequest
UpdateXmlDoc	IntBroker class method UpdateXmlDoc

The following built-in functions are no longer supported. You will receive an error if you try to use them in a PeopleCode program.

CreateWSDLMessage
GetArchPubHeaderXmlDoc
GetArchPubXmlDoc
GetArchSubXmlDoc
GetArchSubXmlDoc
GetArchSyncLogData
GetSyncLogData

Note. ReturnToServer is a special case of a built-in function that's no longer supported. The deprecated handler for OnRequest subscriptions cannot be upgraded. ReturnToServer can only be used in an OnRequest event fired using the deprecated handler. This means that ReturnToServer no longer works and is not valid in any case other than when the code has already been written and used in a deprecated handler.

Deprecated Message Class Methods and Properties

The following are the Message class methods and properties that have been deprecated.

Deprecated Method	Replacement Method
GetQueryString	IBConnectorInfo collection GetQueryStringArgName method
InBoundPublish	IntBroker class InBoundPublish method
Publish	IntBroker class Publish method
SetQueryString	IBConnectorInfo collection AddQueryStringArg method
SetStatus	IntBroker class SetStatus method
SyncRequest	IntBroker class SyncRequest method
Update	IntBroker class Update method

The following are the Message class properties that have been deprecated.

Deprecated Property	Replacement Property
ChannelName	Message class QueueName property
Cookies	IBConnectorInfo collection Cookies property
DefaultMessageVersion	Message class OperationVersion property
GUID	Message class TransactionId property
IsActive	Message class IsOperationActive property
PubId	Message class QueueSeqId property
SubName	Message class ActionName property
SubscriptionProcessId	Message class TransactionId property
MessageChannel	IBInfo class MessageQueue property
MessageType	IBInfo class OperationType property

The following Message class properties are no longer supported. You will receive an error if you try to use them in your PeopleCode program.

MessageDetail
PublicationId

Additional Messaging Deprecated Methods and Properties

The following additional methods and properties are either deprecated or no longer supported:

The IBInfo class method LoadConnectorPropFromTrx is no longer supported.
The IBInfo class MessageChannel property has been deprecated. Use the IBInfo class MessageQueue property instead.
The IBInfo class PublicationID property is no longer supported.

Integration Broker Web Service Discovery Class No Longer Supported

The Integration Broker Web Service Discovery class is no longer supported. The following methods are empty and should not be used.

FindCIWebServices
FindMsgWebServices
FindWebServices
GetCIWebServiceWSDL
GetMsgWebServiceWSDL
GetWSDL

Functions No Longer Supported

The following functions no longer work in release 8.4 and beyond.

Function	Description
%MessageAgent	Used with Message Agent activities
ChDir	Used only on the client with DOS
ChDrive	Used only on the client with DOS
CheckMenuItem	Used with menu items
Codeb	Used before true Unicode integration
DBCSTrim	Used before true Unicode integration
Findb	Used before true Unicode integration
GetControl	Used with ActiveX controls
GetControlOccurence	Used with ActiveX controls
GetCwd	Used only on the client with DOS
GetMessageInstance	Used with messaging
GetPubContractInstance	Used with messaging
GetSelectedTreeNode	Used with dynamic trees
GetSubContractInstance	Used with messaging
GetTreeNodeParent	Used with dynamic trees
GetTreeNodeRecordName	Used with dynamic trees
Lenb	Used before true Unicode integration
RefreshTree	Used with dynamic trees
ScheduleProcess	Used with PeopleSoft Process Scheduler
Substringb	Used before true Unicode integration
UnCheckMenuItem	Used with menu items
WinEscape	Used only on client
WinExec	Used only on client