PeopleCode Functions

PeopleCode Functions

Transforming PeopleSoft Query PS Query Transformations

Using Functions in PeopleSoft Query PeopleSoft Query

PeopleSoft Users Companion PeopleSoft Users Companion Extras

List of PeopleCode Functions (including 8.57)

A, B, C

Command	Description	Usage
Abs	Returns absolute value of inNumber (without the + or - sign)	&number=Abs(&inNumber);
AccruableDays	Returns integer number of accrual days according to accounting conventions	&integer=AccruableDays(&BeginDate, &EndDate, &AccrualConvention);
AccrualFactor	Returns factor equal to number of years interest accrued between dates using acounting convention.	&number=AccrualFactor(&BeginDate, &EndDate, &AccrualConvention);
Acos	Returns angle in radians (0 to pi) with specified cosine value (-1.0 to 1.0)	&radians=Acos(&cosine);
ActiveRowCount	Returns number of non-deleted rows - use Rowset.ActiveRowCount	&integer=ActiveRowCount([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName);
AddAttachment	Adds file attachment from browser onto server	&errorCode=AddAttachment(&URLDestination, &DestinationAppendedPathFilename, &SuggestedFileExtension, &SourceFile, &MaximumKB [, &PreserveCaseBoolean]);
AddEmailAddress	Add email address of current user - 1 per type	AddEmailAddress(&EmailTypeName, &EmailAddress [,&PrimaryBoolean]);
AddJavaScript	Adds a defined JavaScript object to the component and page.	AddJavaScript(HTML.JS_OBJECT);
AddKeyListItem	Adds new key value to navigation list of keys for autocompletion of search dialogs	&isOK=AddKeyListItem(&FieldName, &Value);
AddMetaTag	FLUID ONLY: Adds an HTML header meta tag to the page and component	AddMetaTag(&MetaTagName, &MetaTagValue);
AddOnLoadScript	FLUID ONLY: Adds JavaScript string to be executed in HTML page's onload event	AddOnLoadScript(&strJavaScript);
AddStyleSheet	FLUID ONLY: Adds a stylesheet to the page and component	AddStyleSheet(STYLESHEET.STYLESHEET);
AddSystemPauseTimes	Adds weekly system pause time for messages to/from day (0-6) to from time in seconds from midnight (0-24x60x60 or 86,400)	&isOK=AddSystemPauseTimes(&BeginWeekDayNumber, &BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);
AddToDate	Returns date time after numOfYears, Months, Days, Hours, Minutes, Seconds after (-ve means before) inDate	&date=AddToDate(&inDate, &numOfYears, &numOfMonths, &numOfDays);
AddToDateTime	Returns date time after numOfYears, Months, Days, Hours, Minutes, Seconds after (-ve means before) inDateTime	&dateTime=AddToDateTime(&inDateTime, &numOfYears, &numOfMonths, &numOfDays, &numOfHours, &numOfMinutes, &numOfSeconds);
AddToTime	Returns time after numOfHours, Minutes, Seconds after (-ve means before) inDate	&time=AddToTime(&inTime, &numOfHours, &numOfMinutes, &numOfSeconds);
Alias	For C Shared libraries in Declare Function, optionally aliases the function name	Declare Function functionName Library libraryName Alias cFunctionName);
All	Checks if fields listed are all not blank strings / non-zero in numeric fields	&isNotBlank=All( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );
AllOrNone	Checks if fields listed are all blank strings / non-zero OR all are not	&isConsistent=AllOrNone( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );
AllowEmplIdChg	Allows/Denies user to update their own data on record with EMPLID key = PSOPERDEFN.EMPLID	[&isOK=] AllowEmplidChg(&isAllowed);
Amortize	Calculates parts of loan payment, inPayment, (payment number inPaymentNumber) - interest (outToInterest) and pays off principal (outToPrincipal) and the remaining balance (outBalance)	Amortize(&inInterest, &inPrincipalBalance, &inPaymentAmount, &inPaymentInteger, &outToInterest, &outToPrincipal, &outBalance);
And	Boolean and in conditions such as if statements.	if &isOk and &isReady then ... end-if;
As	Reference a class as a subclass	&objSubObject=&objSuperObject As subClass;
As	Part of external library declare function	Declare Function functionName library LibName [Alias aliasName] [externalParameter1 [{Ref|Value}] ,...] [Returns externalType [As internalType]];
Asin	Returns angle in radians (-pi/2 to pi/2) with specified sine value (-1.0 to 1.0)	&radians=Asin(&sine);
Atan	Returns angle in radians (-pi/2 to pi/2) with specified tangent number	&radians=Atan(&tangent);
BlackScholesCall	Returns the value of a call against an equity according to Black Scholes financial calculation.	&equityCall=BlackScholesCall(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);
BlackScholesPut	Returns the value of a put against an equity according to Black Scholes financial calculation.	&equityCall=BlackScholesPut(&AssetPrice, &StrikePrice, &NoRiskInterestRate, &YearsToExpire, &Volatility);
BootstrapYTMs	Returns bootstrap yield-to-maturity curve as an array.	&arrayOfNumberArrays=BootstrapYTMs(&TradingDate, &MarketInstrumentArrayOfNumberArrays, &AccrualConvention);
Break	Terminate loop or evaluate execution	Break;
BulkDeleteField	For PeopleSoft Adminstrator: Deletes FieldName from designed Pages and Records in ProjectName but not in ExcludeProjectName	&errorInteger=BulkDeleteField(&ProjectName, FieldName [, ExcludeProjectName] );
BulkInsertField	For PeopleSoft Adminstrator: Insert Field into all records and pages in ProjectName (but not in ExcludeProjectName) that contain ModelFieldName	&errorInteger=BulkInsertField(&ProjectName, FIELD.FieldName, &ModelName, &IsClonePCode, [, &ExcludeProjectName] );
BulkModifyPageFieldOrder	For PeopleSoft Adminstrator: Reorder Fields in all records and pages in ProjectName (or PageNameArray) into FieldNamesArray order	&errorInteger=BulkModifyPageFieldOrder(&ProjectName, &FieldNamesArray, &IsAllFieldsRequired, [&GridWidthsArray]);
BulkUpdateIndexes	For PeopleSoft Adminstrator: Updates index definitions for records that have the NotUsed setting changed.	&errorInteger=BulkUpdateIndexes( [&FieldNameArray] );
CallAppEngine	Calls Application Engine from online or App Engine PeopleCode. State records can be either objects or record names.	CallAppEngine(&AppEngineName [ , &StateRecord1... , &ProcessInstanceInteger ] );
CancelPubHeaderXmlDoc	Cancels a New, Error, Retry, Timeout, Edited message header/instance (before transformation)	&isOK=CancelPubHeaderXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName);
CancelPubXmlDoc	Cancels a New, Error, Retry, Timeout, Edited message publication contract (after transformation)	&isOK=CancelPubXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName, &MessageName, &SubscribeNodeName);
CancelSubXmlDoc	Cancels a New, Error, Retry, Timeout, Edited message subsription contract	&isOK=CancelSubXmlDoc(&PublishID, &PublishNodeName, &ChannelName, &VersionName, &MessageName, &SubscribeNodeName);
Catch	Creates a block where statements can error and these are handled.	Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;
ChangeEmailAddress	Changes email address of type &EmailTypeName for current user	ChangeEmailAddress(&EmailTypeName, &EmailAddress);
Char	Returns the UniCode character with the given number (0-65,535)	&UnicodeCharacter=char(&Integer);
CharType	Returns 1 (yes), 0 (no), -1 (unknown) whether 1st character of string in character group given by number &CharSetNumber	&returnInteger=CharType(&String, &CharSetNumber);
ChDir	DEPRECATED Changes current directory.	ChDir(&Path);
ChDrive	DEPRECATED Changes drive (MS-DOS). &drive is a letter followed by a colon.	ChDrive(&Drive);
CheckMenuItem	Puts a check by the menu name on Windows client. Deprecated for versions with no Windows client.	CheckMenuItem(BARNAME.menuBar, ITEMNAME.menuItem);
ChunkText	Splits &strText by &chrDelimiter or &numChunkSize or 14,000 whichever is lower.	&arrChunks=ChunkText(&strText, &chrDelimiter [, &numChunkSize]);
Clean	Returns &dodgyString without any non-printable characters	&cleanString=Clean(&DodgyString);
CleanAttachments	Deletes attachments in database tables not referenced elsewhere.	&numReturn=CleanAttachments(&numKeepCase);
ClearKeyList	Clears current key list for navigation	[&isOK=] ClearKeyList();
ClearSearchDefault	Removes default processing for specified field. SearchInit only. Use Field.SearchDefault now.	[&isOK=] ClearSearchDefault( [recordname.]fieldname);
ClearSearchEdit	Stops record field edit properties being used in search dialogue for field. Use Field.SearchEdit now	[&isOK=] ClearSearchEdit( [recordname.]fieldname);
Code	Returns Unicode UTF-16 value (0-65,535) of first character/high surrogate in &String	&number=Code(&String);
Codeb	No longer supported - Ptools 8.46	&number=Codeb(&String);
CollectGarbage	Cleans memory of unreferencable Application objects.	CollectGarbage();
CommitWork	Explicitly commits to the database. Available in FCh, SPr, Message Subscription and AE PC	[&isOK=] CommitWork();
CompareLikeFields	Returns true if all similarly named fields have the same value in both To and From, else false	&isLikeFieldsSame=CompareLikeFields(&FromLevel, &FromScrollPath, &FromRow, &ToLevel, &ToScrollPath, &ToRow);
CompareStrings	Returns &strXmlDifferences between &strOld and &strNew of type "Text" or "HTML"	&strXmlDifferences=CompareStrings(&strNew, &strOld [, &strType [, &arrDelimiters]] );
CompareTextDiff	Returns &arrArrDifferences between &strOld and &strNew of type "Text" or "HTML"	&arrArrDifferences=CompareTextDiff (&strNew, &strOld [, &strType [, &arrDelimiters]] );
Component	Declares variables with scope for the component lifetime	Component datatype &declaration;
ComponentChanged	Returns true if the component data has changed since the last save.	&isChanged=ComponentChanged();
ConfigureClassicPlusComponent	If &numEnable is 1, enables Classic Plus theme on Component, 0 disables.	&isChanged=ConfigureClassicPlusComponent(&strComponent, &strMarket, &numEnable);
ConfigureClassicPlusForWC	If &numEnable is 1, enables Classic Plus theme on Work Center, 0 disables.	&isChanged=ConfigureClassicPlusForWC(&strPortal, &strWorkCenterCREFName, &numEnable);
ConnectorRequest	Sends message to connector assigned by properties of the message	&unstructuredMessage=ConnectorRequest(&Message);
ConnectorRequestURL	Returns URL directly from the gateway	&URLString=ConnectorRequestURL(&ConnectorStringURL);
ContainsCharType	Returns 1 (yes), 0 (no), -1 (unknown) whether any character of string in character group given by number &CharSetNumber	&returnInteger=ContainsCharType(&String, &CharSetNumber);
ContainsOnlyCharType	Returns 1 (yes), 0 (no), -1 (unknown) whether all string only character groups given by numbers &CharSetNumber1	&returnInteger=ContainsOnlyCharType(&String, &CharSetNumber1 [, &CharSetNumber2 ...]);
Continue	In loops, skips processing to next iteration of loop	Continue;
ConvertChar	Returns 1 (success), 0 (no conversion), -1 (unknown), -2 (partial success) converts inString between (mainly) Asian/Japanese character sets outputs to outString	&returnInteger=ConvertChar(&inString, &inCharCategoryNumber, &outString, &TargetCharSetNumber);
ConvertCurrency	Converts currency, no exchange rate - uses 1 returns false, inErrorProcess (F/W/I) determines if user told	&isOK=ConvertCurrency(&inFromAmount, &inFromCurrencyCd, &inToCurrencyCd, &inRateType, &inEffdt, &outToAmount [, &inErrorProcess [, &isRounded] [, &inRateIndex);
ConvertDatetimeToBase	Converts to PSOPTIONS base time zone FromTimeZone or Local or Base	&dateTime=ConvertDatetimeToBase(&FromDateTimeString, &FromTimeZone);
ConvertRate	Returns rate converted by frequency 0 continuous, 1 daily, 2 monthly, 3 yearly	&toRate=ConvertRate(&fromRate, &fromFrequencyNumber, &toFrequencyNumber);
ConvertTimeToBase	Converts to PSOPTIONS base time zone FromTimeZone or Local or Base	&time=ConvertTimeToBase(&FromTimeString, &FromTimeZone);
CopyAttachments	Copies files from one system to another, returns 0 on success, non zero error.	&returnInteger=CopyAttachments(&fromURL, &toURL [, &RecordNamesArray [, &isCasePreserved);
CopyFields	Copies like named fields from FromRow to ToRow in the page buffer	[&isOK=] CopyFields(&FromLevel, &FromScrollPath, &FromRow, &ToLevel, &ToScrollPath, &ToRow);
CopyFromJavaArray	Copies Java array to a PeopleCode Array, optionally confined to elements numbered in final array parameter	CopyFromJavaArray(&JavaArrayName, &PeopleCodeArray [, &ElementNumberArray]);
CopyRow	Copies row, superceded by Row.CopyTo	CopyRow(&ToRowNumber, &FromRowNumber);
CopyToJavaArray	Copies PeopleCode array to a Java array, optionally confined to elements numbered in final array parameter	CopyToJavaArray(&PeopleCodeArray, &JavaArrayName [, &ElementNumberArray]);
Cos	Returns cosine (-1.0 to 1.0) of angle in radians (normally 0 to pi)	&cosine=Cos(&radians);
Cot	Returns cotangent of angle in radians (0 causes error)	&cotangent=Cot(&radians);
create	Returns a new instance of APP_PACKAGE:Class after running its constructor	import APP_PACKAGE:Class; local APP_PACKAGE:Class &objClass=APP_PACKAGE:Class();
CreateAnalyticInstance	Returns a new, unloaded analytic instance	&objAnalyticInstance=CreateAnalyticInstance (&strAnalyticType, &strId, &strDescription, &recParameters, &isForceDelete);
CreateArray	Returns reference to array created from elements - no elements, empty array of ANY created	&array=CreateArray([&element1 [, &element2 ]...]);
CreateArrayAny	Returns reference to array created from elements elements can be of ANY type	&anyArray=CreateArrayAny([&element1 [, &element2 ]...]);
CreateArrayRept	Returns reference to array (same type as Element) with Element repeated for NumberOfElements	&array=CreateArrayRept(&Element, &NumberOfElements);
CreateBreadcrumb	DEPRECATED: Classic only - creates a breadcrumb history record. Component is string Menu.Component.Market. Mode is A,U,L,C,E. Keys in format KEY_NAME:'value';...	[&strHtml=]CreateBreadcrumb (&strBackBtnLabel, &strId, %Portal, %Node, &strComponent, Page.PAGE_NAME, &strTitle, &chrMode [, &strKeys] [,&strAppendUrl]);
CreateDirectory	Creates directory specified by Path and PathType (%FilePath_Absolute/%FilePath_Relative)	CreateDirectory(&Path [, &PathTypeConst]);
CreateDocument	Creates a Document object	&objDoc=CreateDocument(&strDocKey, &strDocName, &strVersion);
CreateDocumentKey	Creates a DocumentKey object	&objDocKey=CreateDocumentKey(&strPackage, &strDocName, &strVersion);
CreateException	Returns reference to new exception created from message catalog substituting &Value1 for %1 etc.	&exception=CreateException(&MessageSetNumber, &MessageNumber, &DefaultString [, &Value1 [, &Value2 ]...] );
CreateJavaArray	Returns reference to Java array	&javaObjectArray=CreateJavaArray(&ElementClassName[], &NumberOfElements);
CreateJavaObject	Returns reference to Java object	&javaObject=CreateJavaObject(&ClassName [, &ConstructorParameter1 [, &ConstructorParameter2]... ]);
CreateMCFIMInfo	Returns reference to new MCFIMInfo class instance for Network (AOL/Yahoo)	&mcfimInfoObject=CreateMCFIMInfo(&OprID, &Provider);
CreateMessage	Returns reference to new instance of message MessageName	&message=CreateMessage(MESSAGE.MessageName);
CreateObject	Returns reference to new object (OLE Automation or Application Class)	&object=CreateObject(&ClassName);
CreateObjectArray	Returns reference to new object but parameters to create object not known at design time	&object=CreateObjectArray(&ClassName, &ArgumentArray);
CreateProcessRequest	Returns reference to new process request, blank or set up. Use &processRequest.Schedule(); after	&processRequest=CreateProcessRequest( [&ProcessTypeString, &ProcessName] );
CreateRecord	Returns reference to new standalone record object	&record=CreateRecord( {RECORD.RecordName | @ &RecordRecName });
CreateRowset	Returns reference to new standalone rowset. Can be populated by &rowset.Fill method.	&rowset=CreateRowset( {RECORD.RecordName | &inRowset1} [, {Field.FieldName, RECORD.RecordName | &inRowset2 } ] ... );
CreateRowsetCache	Returns reference to new RowSetCache object if one does not already exist with that name	&rowsetCache=CreateRowsetCache(&rowset, [ROWSET.]Name, Description);
CreateSearchRowset	FLUID: Returns RowSet object using search record and key values. PT8.56: parameter not supported	&rsSearch=CreateSearchRowset([numCount]);
CreateSOAPDoc	Returns reference to new SOAPDoc object	&soapDoc=CreateSOAPDoc();
CreateSQL	Returns reference to new SQL object	&sql=CreateSQL( [ {&SQLString | SQL.SQLName} [, &bindVar1] ... ] );
CreateWSDLMessage	Returns true if channel and unstructured message created, use GetMessage/GetMessageXmlDoc to see message	&isOK=CreateWDSLMessage(&MessageName, &ChannelName);
CreateXmlDoc	Returns reference to new XML Doc object. XML String can be blank.	&xmlDoc=CreateXmlDoc(&xmlString);
CreateXmlDocFactory	Returns reference to new XML Doc Factory object.	&objXmlDocFactory=CreateXmlDocFactory();
CropImage	Crops component buffer image in source field and places in destination field (both same type .bmp, .jpg, .gif). ThinkTime event	&isOK=CropImage(&rcfSourceImage, &rcfDestImage, [&numRatioWidth, &numRatioHeight]);
CubicSpline	Returns a cubic spline for set of at least 4 data points.	&ArrayOfArraysOf6Numbers=CubicSpline(&ArrayOfArraysOf6Numbers, &ControlNumber, &LeftPointConstraint, &RightPointConstraint);
CurrEffDt	Returns current effective Date value of scroll level specified (current if no parameter). Use &rowset.Effdt now.	&currentEffDt=CurrEffDt( [&LevelNumber] );
CurrEffRowNum	Returns current row number of scroll level specified (current if no parameter). Use &row.RowNumber now.	&rowNumber=CurrEffRowNum( [&LevelNumber] );
CurrEffSeq	Returns current effective sequence number of scroll level specified (current if no parameter). Use &rowset.EffSeq now.	&rowNumber=CurrEffSeq( [&LevelNumber] );
CurrentLevelNumber	Returns current scroll level number or zero if not in a scroll	&levelNumber=CurrentLevelNumber();
CurrentRowNumber	Returns current row number on this or higher level. Use &row.RowNumber now.	&rowNumber=CurrentRowNumber( [&LevelNumber] );

D, E, F

Command	Description	Usage
Date	Returns date object with value specified by number in YYYYMMDD format	&date=Date(&YYYYMMDDnumber);
Date3	Returns date object with value specified in years, months days.	&date=Date3(&YYYYnumber, &MMnumber, &DDnumber);
DatePart	Returns date part of a DateTime value	&date=DatePart(&dateTime);
DateTime6	Returns DateTime value with value derived from numbers.	&dateTime=DateTime6(&YYYYnumber, &MMnumber, &DDnumber, &HH24number, &MINnumber, &SSnumber);
DateTimeToHTTP	Returns string representing DateTime in HTTP format example Mon, 03 Sep 2007 09:00:00 GMT	&dateTimeString=DateTimeToHTTP(&DateTime);
DateTimeToISO	Returns a DateTime in 8601 format from string example 2007-09-03T09:00:00.000000+01:00	&dttmIso8601=DateTimeToISO(&strIsoDateTime);
DateTimeToLocalizedString	Returns string representing DateTime (or just date) in specified format string.	&dateTimeString=DateTimeToLocalizedString(&DateTime [, &format ] );
DateTimeToTimeZone	Returns fromDateTime converted by time zone specified by 3 character string e.g. EST or Local or Base	&dateTime=DateTimeToTimeZone(&fromDateTime, &fromTimeZone, &toTimeZone);
DateTimeToUserFormat	Returns date and time as string according to user preferences, converted to time zone specified by 3 character string e.g. EST or Local or Base	&strUserDateTime=DateTimeToUserFormat (&strDateTime, &strTimeZone);
DateTimeValue	Returns DateTime with value of string - in format - DD/MM/YY[YY] hh24:mi:ss.ssssss [{AM , PM}]	&dateTime=DateTimeValue(&dateTimeString);
DateValue	Returns Date with value of string - in format determined by personalised date settings	&date=DateValue(&dateString);
Day	Returns day number (1-31) of date	&dayNumber=Day(&date);
Days	Returns the Julian date as a number	&julianDayNumber=Days(&date);
Days360	Returns number of days between 2 dates if using the 360 day calendar (12 months x 30 days)	&numberOfDays=Days360(&fromDate,&toDate);
Days365	Returns number of days between 2 dates if using the 365 day calendar	&numberOfDays=Days365(&fromDate,&toDate);
DBCSTrim	Deprecated. Returns string without a lead byte at end of string	&string=DBCSTrim(&string);
DBPatternMatch	Determines if pattern found in string - using SQL wildcards % (any characters) _ (any single characters), \%, \_ escaped wildcards.	&isMatch=DBPatternMatch(&string, &pattern, &isCaseSensitive);
DeChunkText	Recreates string of text from database sliced up by ChunkText. Data Types - STR, CHAR (single char),LONGTEXT, DATE, TIME, DATETIME, INT, SHORT, LONG, DOUBLE	&strText=DeChunkText (&strRecordName, &strSeqFieldName, &strChunkFieldName, &arrKeyFieldNames, &arrKeyDataTypes, &arrKeyValues);
Declare Function	Declares PeopleCode or external function for use in the PeopleCode program	DECLARE FUNCTION functionName LIBRARY libName [ALIAS ModuleName ] [parameter1, [REF | VALUE] ]... [RETURNS ReturnType [AS PeopleCodeType
Decrypt	Decrypts encryptedString if used Encrypt	&plainText=Decrypt(&keyString, &encryptedString);
Degrees	Returns angle in degrees from radians	&degrees=Degrees(&radians);
DeleteAttachment	Deletes specified attachment, returns 0 if successful.	&errorCode=DeleteAttachment(&fromURL, &DestinationAppendedPathFilename [, &PreserveCaseBoolean]);
DeleteEmailAddress	Deletes email address of type (BB , BUS , HOME , OTH , WORK)	DeleteEmailAddress(&EmailTypeString);
DeleteImage	Deletes specified image	&isOK=DeleteImage( [SCROLL.RecordNameLevel1, RowNumberLevel1, ]... SCROLL.RecordName, &RowNumber, [RecordName.]FieldName);
DeleteRecord	Deletes level zero row from database and any dependent rows on the page. Use &record.delete now.	[&isOK=] DeleteRecord(RecordName.FieldName);
DeleteRow	Deletes a level 1+ row, causes RowDelete to fire, renumbers rows after delete done. Use &RowSet.DeleteRow now.	[&isOK=] DeleteRow([RECORD.RecordNameLevel1, &rowNumberLevel1 [,RECORD.RecordNameLevel2, &rowNumberLevel2, &rowNumber );
DeleteSQL	Deletes an Application Designer SQL definition. DBType is APPSRV, DB2ODBC, DB2UNIX, INFORMIX, MICROSFT, ORACLE, SYBASE - defaults to %DbName	&isOK=DeleteSQL([SQL.]SQLName [, &dbType [, &EffectiveDate);
DeleteSystemPauseTimes	Deletes specified system pause time	&isOK=DeleteSystemPauseTimes(&BeginWeekDayNumber, &BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);
DeQueue	Removes completed task from MCF queue, returns 0 if successful, else message number from set 162.	&errorCode=DeQueue(&PhysicalQueueID, &TaskType, &TaskNumber, &AgentID);
DetachAttachment	Copies file attachment from server to browsing system	&errorCode=DetachAttachment(&FromURL, &FromAppendedPathFilename, &SuggestedFileExtension, &ToFile [, &PreserveCaseBoolean]);
DisableMenuItem	Disables (pop up) menu item name. Ignored by Component Interface.	DisableMenuItem(BARNAME.MenuBarName, ITEMNAME.ItemName);
DiscardRow	Does not show the selected row on the page. Only called in RowSelect.	DiscardRow();
DoCancel	Cancels current page or menu. Does not stop SaveEdit, SavePreChange, SavePostChange	DoCancel();
DoesTableExist	Returns true if the database table with the string name specified exists in the database.	&isTableInDB=DoesTableExist(&strTableName);
DoModal	Displays secondary page, returns 1 (OK) or 0 (cancelled)	&OKCancel=DoModal(PAGE.PageName, &WindowTitle, &xPosition, &yPosition [, &LevelNumber, [RECORD.RecordNameLevel1, RowNumberLevel1]..., &RowNumber]);
DoModalComponent	Displays secondary component in action mode A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt), returns 1 (OK) or 0 (cancelled)	&OKCancel=DoModalComponent(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.LandingPageName, &Action, &RECORD.SharedRecordName [, RecordName.Field ]... );
DoModalComponentPopup	FLUID: Display secondary Fluid component in action mode A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt).	&isOK=DoModalComponentPopup (&strModalOption, &strCancelBtnId, &strTitle, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.LandingPageName, &Action, &RECORD.SharedRecordName [, RecordName.Field ]... );
DoModalPanelGroup	DEPRECATED: Displays secondary component in action mode A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt), returns 1 (OK) or 0 (cancelled). Use DoModalComponent now.	&OKCancel=DoModalPanelGoup(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PANEL.LandingPageName, &Action, &RECORD.SharedRecordName);
DoModalPopup	FLUID: Display secondary Fluid page popup next to parent control. Offset -1 is centred. Think time function.	&isOK=DoModalPopup (&strModalOption, &strCancelBtnId, &isDisplayOnly, &isCached, PAGE.PageName, &strTitle, &numXpos, &numYpos [,&numLevel, [RECORD.RecordName1, &numRowLevel1 , [ RECORD.RecordName2, &numRowLevel2, ]... RECORD.RecName, &numRow);
DoModalX	Displays secondary page replacing primary page (&isModal false) otherwise in a modal window, returns 1 (OK) or 0 (cancelled). Offset -1 is centred. Think time function.	&OKCancel=DoModalX (&isModal, "", PAGE.PageName, &strTitle, &numXpos, &numYpos [,&numLevel, [RECORD.RecordName1, &numRowLevel1 , [ RECORD.RecordName2, &numRowLevel2, ]... RECORD.RecName, &numRow);
DoModalXComponent	Displays secondary component replacing primary page (&isModal false) otherwise in a modal window, returns 1 (OK) or 0 (cancelled). Offset -1 is centred. Think time function.	&OKCancel=DoModalXComponent (&isModal, "", , MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.LandingPageName, &Action, &RECORD.SharedRecordName [, RecordName.Field ]...);
DoSave	Saves at end of current PeopleCode event, executes PeopleCode associated with save. Only usable in FEd, FCh, MenuItemSelected.	DoSave();
DoSaveNow	Saves immediately, executing the save PeopleCode. Useful if calling a remote call program that accesses the page data direct.	DoSaveNow();
DownloadToExcel	Downloads &rsData to Excel in format 1 XLSX, 2 HTML, 3 CSV - returns 0 if OK, 1 otherwise.	&numOk=DownloadToExcel(&rsData, &strFile, &numFormat [,&hasHeader]);
Else	Executes statements depending on condition	If conditions Then [statements] [Else [statements End-If;
EnableMenuItem	Enables a (PopUp) menu item for selection. For pop up menu place in PrePopUp of field.	EnableMenuItem(BARNAME.BarName, ITEMNAME.ItemName);
EncodeSearchCode	Returns a string encoded according to search tokenization (characters zZ and special characters). String ends in Z if encoded.	&encodedString=EncodeSearchCode(&strSearch);
EncodeURL	Returns a string encoded according to the W3C encoding rules. Does not encode !#$&()*+,-./:;=?_	&encodedString=EncodeURL(&URLString);
EncodeURLForQueryString	Returns a string encoded according to the W3C encoding rules. Does not encode ()*-._	&encodedString=EncodeURLForQuery(&URLString);
Encrypt	Returns an encrypted string	&encryptedString=Encrypt(&KeyString, &PlainText);
EncryptNodePswd	Returns an encrypted Integration Broker node password	&encryptedNodePassword=EncryptNodePswd(&PlainText);
End-Evaluate	Evaluate branches depending on conditions on Value	Evaluate &Value When ... End-evaluate
End-For	Ends for loop	End-For;
End-Function	Ends function definition	End-Function
End-If	Executes statements depending on condition	If conditions Then [statements] [Else [statements End-If;
End-Try	Creates a block where statements can error and these are handled.	Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;
End-While	Repeats Statements while Boolean is true.	While (&Boolean) Statements; End-While;
EndMessage	Shows a message and ends SPo PeopleCode at time of commit only in SPo. Use MessageBox now.	EndMessage(&Message, &MessageTitle);
EndModal	Closes current modal secondary page (not in CI), &OKNumber=0 - no values returned to main page, >1 - values returned	EndModal(&OKNumber):
EndModalComponent	Closes current modal secondary component (not in CI), &OKNumber=0 - no values returned to main page, >1 - values returned	EndModalComponent(&OKNumber):
EnQueue	Adds task to MCF queue, returns 0 if successful, else message number from set 162.	&errorCode=EnQueue(&PhysicalQueueID, &TaskType, &LaunchPageURL, &LanguageCode [, &Subject [, &AgentID [, &MinsToOverflow [, &MinsToEscalation [, &CostNumber [, &PriorityNumber [, &MinSkillNumber]--]);
Error	FEd, SEd, RDe: Displays error message and stops PeopleCode and save; RSe: Make current row the last to be added to buffer	Error &ErrorMessage;
EscapeHTML	Returns text with HTML characters escaped (e.g. < becomes <)	&escapedText=EscapeHTML(&Text);
EscapeJavascriptString	Returns text for use in JavaScript - changes ' " NL CR \\	&escapedText=EscapeJavascriptString(&Text);
EscapeWML	Returns text for use in WML - changes ' " <>$&	&escapedText=EscapeWML(&Text);
Evaluate	Evaluate branches depending on conditions on Value	Evaluate &Value When ... End-evaluate
Exact	Returns true if strings exactly match	&isSame=Exact(&String1, &String2);
Exec	Starts operating system command and returns process ID	&processNumber=Exec(&CommandString, &isSynchronous);
Exec(2)	Starts operating system command and waits to return the process exit code	&exitNumber=Exec(&CommandString, %Exec_Synchronous+%FilePath_Absolute);
ExecuteRolePeopleCode	Returns array of users currently in the Dynamic Role.	&userIDArray=ExecuteRolePeopleCode(&DynamicRoleName);
ExecuteRoleQuery	Returns array of users currently in the Query Role using the bind string parameters	&userIDArray=ExecuteRoleQuery(&QueryRoleName, &BindString1 [, BindString2]... );
ExecuteRoleWorkflowQuery	Returns array of users currently in the Workflow Query Role using the bind string parameters	&userIDArray=ExecuteRoleWorkflowQuery(&WorkflowQueryRoleName, &BindString1 [, BindString2]... );
ExecuteSearchSavePC	FLUID: Runs search page SearchSave PeopleCode	ExecuteSearchSavePC();
Exit	Immediately leave PeopleCode program, if &number is 1 then rollback.	Exit [ (&number) ] ;
Exp	Returns e (2.7182818?) to the power of Natural Logarithm	&number=Exp(&NaturalLogarithm);
ExpandBindVar	Returns string replacing :RecordName.FieldName with appropriate values	&expandedString=ExpandBindVar(&string);
ExpandEnvVar	Returns string replacing operating system environment variable names with their values	&expandedString=ExpandEnvVar(&string);
ExpandSqlBinds	Returns string replacing :1... with values from the BindValue list	&expandedString=ExpandSQLBinds(&string [, &bindValue1]... );
Fact	Returns factorial of truncated Number (1 x 2 x ... x Number)	&factorial=Fact(&Number);
FetchSQL	Returns Application Designer SQL string with name according to DBType is APPSRV, DB2ODBC, DB2UNIX, INFORMIX, MICROSFT, ORACLE, SYBASE - defaults to %DbName	&sql=FetchSQL( [SQL.]SQLName [, &DBType [, &EffectiveDate] ] );
FetchValue	Returns value from buffer fields (outside current context). Use &Field.Value now.	&value=FetchValue( [RECORD.RecordName1, &RowLevel1 , [ RECORD.RecordName2, &RowLevel2, ]... &TargetRowNumber, [RecordName.]FieldName);
FieldChanged	Returns if field has been changed from database by PeopleCode or user	&isChanged=FieldChange( RECORD.RecordName1, &RowLevel1 , [ RECORD.RecordName2, &RowLevel2, ]...&TargetRowNumber, [RecordName.]FieldName);
FileExists	Returns if file exists (on Server). File Path Type is either %FilePath_Relative or %FilePath_Absolute	&isThere=FileExists(&FileNameString, &FilePathType);
Find	Returns position of left most SubString in Text (0 if not found), starting at StartPosition	&positionNumber=Find(&SubString, &Text [, &StartPosition]);
Findb	DEPRECATED. Returns position of left most SubString (bytes) in Text (0 if not found), starting at StartPosition	&positionNumber=Findb(&SubString, &Text [, &StartPosition]);
FindCodeSetValues	Returns list of code set name-pair values as part of data value translations in Integration Broker	&nameValuePairArray=FindCodeSetValues(&CodeSetName, &inNameValuePairArray, &FromNodeName, &ToNodeName);
FindFiles	Returns list of files conforming to FileNamePattern (using * and ?). File Path Type is either %FilePath_Relative (searches PS_FILEDIR and PS_SERVDIR) or %FilePath_Absolute	&FileNameArray=FindFiles(&FileNamePattern [ , &PathType]);
FlushBulkInserts	Moves bulk inserted rows held in buffer to database, Inserts but does not Commit.	FlushBulkInserts();
For	For loop ended with end-for	for index = &number1 to number2 [step &increment];
FormatDateTime	Returns formatted DateTime converted to time zone specified by 3 character string e.g. EST or Local or Base	&dateString=FormatDateTime(&DateTime, &TimeZone, &isWithTimeZone);
Forward	Transfers MCF task from one queue/agent to another, returns 0 if successful, else message number from set 162.	&errorCode=Forward(&FromPhysicalQueueID, &FromAgentID, &TaskNumber, &TaskType, &ToLogicalQueueID [, &ToAgentID]);
Function	Starts function definition	Function FunctionName [ ( {&parameter1 [As DataType1]}...) ] [ Returns DataType ]

G, H, I

Command	Description	Usage
GenABNNodeUrl	DEPRECATED: Returns URL to SmartNavigation node	&URLString=GenABNNodeUrl(&Node, &StartNode, &isDisplayParent);
GetComponentTitle	FLUID: Gives component name	&strTitle=GetComponentTitle();
GenDynABNElement	DEPRECATED: Returns HTML list of dynamically created SmartNavigation element from tree or rowset	&strHtmlTree=GenDynABNElement("t", &strIsCref, &strFolder, &strFolderTitle, &strCompPageMkt, &strPackageClassMethod, &strTreeName, &strTreeSetId, &strSetControlValue, &dtTreeEffDt, &strBranch); &strHtmlRowset=GenDynABNElement("r", &strIsCref, &strFolder, &strFolderTitle, &strCompPageMkt, &strPackageClassMethod);
GenerateActGuideContentUrl	Returns Activity Guide content URL	&URLString=GenerateActGuideContentURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);
GenerateActGuidePortalUrl	Returns Activity Guide portal URL	&URLString=GenerateActGuidePortalURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);
GenerateActGuideRelativeUrl	Returns Activity Guide relative URL	&URLString=GenerateActGuideRelativeURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, &Market, COMPONENT.ComponentName, &ActivityGuide);
GenerateComponentContentRelURL	Returns Component Content relative URL	&URLString=GenerateComponentContentRelURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);
GenerateComponentContentURL	Returns Component Content absolute URL	&URLString=GenerateComponentContentURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);
GenerateComponentPortalRelURL	Returns Component Portal relative URL	&URLString=GenerateComponentPortalRelURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);
GenerateComponentPortalURL	Returns Component Portal absolute URL	&URLString=GenerateComponentPortalURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);
GenerateComponentRelativeURL	Returns Component relative URL	&URLString=GenerateComponentRelativeURL(PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, COMPONENT.ComponentName, PAGE.PageName, &Action [, &KeyRecord1 ]...);
GenerateExternalPortalURL	Returns URL of external content on the portal servlet	&URLString=GenerateExternalPortalURL(PORTAL.PortalName, NODE.NodeName, &URLString);
GenerateExternalRelativeURL	Returns relative URL of external content on the portal servlet	&URLString=GenerateExternalRelativeURL(PORTAL.PortalName, NODE.NodeName, &EncodedURLString);
GenerateHomepagePortalURL	Returns URL of specified Tab (or default if "") on the HomePage	&URLString=GenerateHomepagePortalURL(PORTAL.PortalName, NODE.NodeName, &TabName);
GenerateHomepageRelativeURL	Returns relative URL of specified Tab (or default if "") on the HomePage	&URLString=GenerateHomepageRelativeURL(PORTAL.PortalName, NODE.NodeName, &TabName);
GenerateMobileTree	DEPRECATED/REMOVED (PT8.55): Returns HTML of a tree representing a populated CI	&treeHTML=GenerateMobileTree(&CI [,&CIProperty ] );
GenerateQueryContentURL	Returns content URL of specified query	&URLString=GenerateQueryContentURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );
GenerateQueryPortalURL	Returns portal URL of specified query	&URLString=GenerateQueryPortalURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );
GenerateQueryRelativeURL	Returns relative URL of specified query	&URLString=GenerateQueryRelativeURL(PORTAL.PortalName, NODE.NodeName, &QueryName, &isPublicQuery [, &isInNewWindow] );
GenerateScriptContentRelURL	Returns relative URL to specified iScript.	&URLString=GenerateScriptContentRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );
GenerateScriptContentURL	Returns content URL to specified iScript.	&URLString=GenerateScriptContentURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );
GenerateScriptPortalRelURL	Returns relative portal URL to specified iScript.	&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );
GenerateScriptPortalURL	Returns portal URL to specified iScript.	&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );
GenerateScriptRelativeURL	Returns relative URL to specified iScript.	&URLString=GenerateScriptPortalRelURL(PORTAL.PortalName, NODE.NodeName, RECORD.RecordName, Field.FieldName, &iScriptEventName, &iScriptFunctionName [, &Field1]... );
GenerateTree	Returns HTML of a tree representing the specified rowset	&treeHTML=GenerateTree(&RowSet [,TreeEventFieldName ] );
GenerateWorklistPortalURL	Returns portal URL to specified worklist.	&URLString=GenerateWorklistPortalURL(PORTAL.PortalName, NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist, &Instance);
GenerateWorklistRelativeURL	Returns relative URL to specified worklist.	&URLString=GenerateWorklistRelativeURL(PORTAL.PortalName, NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist, &Instance);
GenHTMLMenu	DEPRECATED: Generates HTML from given list.	GenHTMLMenu(&strListHtml [, &strFolderStyleClass [, &arrNumMsgCatLabel ] ] );
GenToken	Returns the user's authentication token.	&strToken=GenToken();
GetABNChartRowSet	DEPRECATED: Returns SmartNavigation chart rowset.	&rsChart=GetABNChartRowSet();
GetABNInitialNode	DEPRECATED: Returns SmartNavigation initial chart node.	&strChartNode=GetABNInitialNode(&arrArrStrParamPairs);
GetABNNode	DEPRECATED: Returns SmartNavigation chart node.	&strChartNode=GetABNNode(&arrArrStrParamPairs);
GetABNRelActnRowSet	DEPRECATED: Returns SmartNavigation rowset of related actions.	&rsRelatedActions=GetABNRelActnRowSet();
GetABNReqParameters	DEPRECATED: Returns SmartNavigation array of an array of string name-value pairs.	&arrArrStrParamPairs=GetABNReqParameters([&strStartNode]);
GetABNTreeEffdt	DEPRECATED: Returns SmartNavigation tree effective date as a string.	&strEffdt=GetABNTreeEffdt(&arrArrStrParamPairs);
GetABNTreeName	DEPRECATED: Returns SmartNavigation tree name.	&strTreeName=GetABNTreeName(&arrArrStrParamPairs);
GetABNTreeSetid	DEPRECATED: Returns SmartNavigation tree set ID.	&strTreeSetId=GetABNTreeSetid(&arrArrStrParamPairs);
GetABNTreeUserKey	DEPRECATED: Returns SmartNavigation tree user key.	&strTreeKey=GetABNTreeUserKey(&arrArrStrParamPairs);
GetAddSearchRecName	FLUID: Returns component's "Add" search record name.	&strRecName=GetAddSearchRecName();
GetAESection	Returns AE section object with base section, if Section does not exist, then it is created.	&AESection=GetAESection(&ApplicationID, &SectionName [, &EffDt ] );
GetAnalyticGrid	Creates an AnalyticGrid and populates it with the grid named on the specified page.	&objAnalyticGrid=GetAnalyticGrid(PAGE.PageName, &strGridName);
GetAnalyticInstance	Returns reference to AnalyticInstance with the given ID.	&objAnalyticInstance=GetAnalyticInstance(&strId);
GetArchPubHeaderXmlDoc	Returns reference to archived message header from queue	&xmlDocument=GetArchPubHeaderXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);
GetArchPubXmlDoc	Returns reference to archived message from queue	&xmlDocument=GetArchPubXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);
GetArchSubXmlDoc	Returns reference to archived message from queue	&xmlDocument=GetArchSubXmlDoc(&MessagePubID, &PublishNode, &ChannelName, &VersionName);
GetAttachment	Copies file from FTP server to Application Server. Return 0 for success, 1 for failure.	&errorCode=GetAttachment(&FromURL, &FromAppendedPathFilename, &ToFile [, &ToDirEnvironmentVariable [, &isPreserveCase]] );
GetAttachmentURL	MAP: Downloads file from server, gives the temporary URL and returns 0 success, non zero values give error message.	&errorCode=GetAttachmentURL(&FromURL, &FromAppendedPathFilename, &strOutUrl [, &strAuthToken][, &strUrlPrefix][, &isPreserveCase]);
GetBiDoc	Creates a BiDocs structure populated with the XML String (this string can be empty)	&biDocObject=GetBiDoc(&XmlString);
GetBreadcrumbs	DEPRECATED: Gives array of Breadcrumbs (current first) in format chrElementType, strHistoryId, strPortal, strNode, strComponent, strPage, strBackLabel, strMode, strKeys, strUrl, strQueryParameters.	&arrArrayStrBreadcrumb=GetBreadcrumbs();
GetCalendarDate	Returns date from PS_PAY_CALENDAR.CalendarFieldName +/- Periods +/- PeriodEndAdjustment (if period end) from InDate.	&date=GetCalendarDate(&InDate, &NumOfPeriods, &PeriodEndAdjustmentNumber, &CalendarFieldName, &Company, &PayGroup);
GetChart	Returns a reference to the chart object associated with the Record.Field in PeopleSoft Application Designer	&chartObject=GetChart(RecordName.FieldName);
GetChartURL	Returns the URL String of the specified Chart object	&URLString=GetChartURL(&Chart);
GetComponentTitle	FLUID: Returns the title of the component.	&strComponentTitle=GetComponentTitle();
GetCwd	Returns a string of the current working directory (on the server)	&pathString=GetCwd();
GetDefinitionAccess	Returns *design* security 0 Full Access, 1 Read Only, 2 No Access to Type (eg DBFIELD, HTML, IMAGE, MENU, SQL)	&numAccess=GetDefinitionAccess(&strType,&Keys);
GetDialGauge	Returns DialGauge object reference.	&objDialGauge=GetDialGauge(RECORDNAME.FIELDNAME);
GetEnv	Returns value of the server environment variable (without $ or % signs)	&variableValue=GetEnv(&VariableName);
GetField	Returns reference to the field object specified (or current one if none specified)	&field=GetField([RecordName.FieldName]);
GetFile	Returns a File object associated with the file named (with %FilePath_Relative,%FilePath_Absolute as PathType) and opens it in the &OpenMode (R,W,U,E,N). Implicit commit.	&file=GetFile(&FileName, &OpenMode [, &CharacterSetName] [, &PathType]);
GetGanttChart	Returns a reference to a Gannt object	&objGannt=GetGanntChart(RECORDNAME.FIELDNAME);
GetGaugeThreshold	Returns a reference to a GaugeThreshold object	&objGaugeThreshold=GetGaugeThreshold();
GetGrid	Returns a reference to a grid object from page specified	&grid=GetGrid(Page.PageName, &GridName [, &OccursNumber]);
GetHTMLText	Returns a string containing the text of an HTML object with param1 etc. substituted for each of the %BIND(:1) variables.	&HTMLstring=GetHTMLText(HTML.HTMLName [, &param1...]);
GetImageExtents	Returns an array: arrayImageSize(1)=image height and arrayImageSize(2)=image width	&arrayImageSize=GetImageExtents(IMAGE.ImageName);
GetInterlink	Returns a BI object based on named App Designer BI object.	&businessInterlink=GetInterlink(Interlink.BIName);
GetJavaClass	Returns a reference to a Java class - used to get access to static methods on Java classes	&refJavaClass=GetJavaClass(&JavaClassName);
GetLEDGauge	Returns areference to an LEDGauge object.	&objLedGauge=GetLEDGauge(RECORDNAME.FIELDNAME);
GetLevel0	Returns the rowset at level 0 of the page/state record/message base rowset	&rowset=GetLevel0();
GetMessage	Returns a message from the current message queue being processed without data	&emptyMessage=GetMessage();
GetMessageInstance	DEPRECATED. Returns a message from the message queue	&message=GetMessageInstance(&PublishId, &PublishNodeName, &ChannelName);
GetMessageXmlDoc	Returns reference to XML doc from async message queue or sync from memory	&xmlDoc=GetMessageXmlDoc();
GetMethodNames	Returns array of method names for ObjectName of specified Type ("WebLib" , "CompIntfc")	&arrayMethodNames=GetMethodNames(&TypeString, &ObjectName);
GetNextNumber	Spo only: Returns 1 higher than the maximum value in named field or negative if error e.g. higher than MaxNumber (Highest possible: 2,147,483,647)	&number=GetNextNumber({Record.Field | &RecordName, &FieldName} , &MaxNumber);
GetNextNumberWithGaps	DEPRECATED. SPr, WFl only. Returns highest value in Field (subject to WhereClause) plus Step. Use GetNextNumberWithGapsCommit	&number=GetNextNumberWithGaps(Record.Field, &MaxNumber, &Step, [&WhereClause [, &Param1...] ]);
GetNextNumberWithGapsCommit	Returns highest value in Field (subject to WhereClause) plus Step or negative if error. Commits immediately via second database connection.	&number=GetNextNumberWithGapsCommit(Record.Field, &MaxNumber, &Step, [&WhereClause [, &Param1...] ]);
GetNextProcessInstance	Retreives next available process instance and commits, unless WillCommit is set to 0.	&returnNumber=GetNextProcessInstance([&WillCommit]);
GetNRXmlDoc	Returns XML message for NonRepudiationId for the signer EntityName (for PS this is NodeName)	&xmlDoc=GetNRXmlDoc(&NonRepudiationId, &EntityName);
GetOrgChart	Returns reference to an OrgChart object.	&objOrgChart=GetOrgChart(RECORDNAME.FIELDNAME);
GetPage	Returns reference to the specified page object. Page must have been loaded - PostBuild or Activate.	&page=GetPage(PAGE.PageName);
GetPageField	Returns reference to the Field object on the specified page.	&fldField=GetPageField(PAGE.PageName [[, RECORD.Record1Name, &num1Row...], RECORD.RecordName] , &strPageField);
GetPagePrefix	FLUID: Returns page prefix.	&strPagePrefix=GetPagePrefix(&numPageType);
GetPageTitle	FLUID: Returns page title.	&strPageTitle=GetPageTitle();
GetPageType	FLUID: Returns numeric page type.	&numPageType=GetPageType(PAGE.PAGENAME);
GetPanelControlStyle	FLUID: Returns style that controls the left/right panels as a string.	&strStyle=GetPanelControlStyle();
GetProgramFunctionInfo	Returns an array filled with info about the function. Function format either "RECORD.RECORDNAME.FIELD.FIELDNAME.METHOD.METHODNAME" or "COMPONENTINTERFACE.CINAME.METHODS.Methods".	&arrArrayAnyFunctionInfo=GetProgramFunctionInfo(&strFunction);
GetPubContractInstance	DEPRECATED. Use GetPubXmlDoc.	&contractInstance=GetPubContractInstance(&PublishId, &PublishNodeName, &ChannelName, &SubscribeNodeName);
GetPubHeaderXmlDoc	Returns XML message before transformation (the header) for specified message. Use in error processing.	&xmlDoc=GetPubHeaderXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName);
GetPubXmlDoc	Returns XML message after transformation for specified message. Use in error processing.	&xmlDoc=GetPubXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName);
GetRatingBoxChart	Returns reference to RatingBoxChart object.	&objRatingBoxChart=GetRatingBoxChart(RECORDNAME.FIELDNAME);
GetRatingGauge	Returns reference to RatingGauge object.	&objRatingGauge=GetRatingGauge(RECORDNAME.FIELDNAME);
GetRatingGaugeState	Returns reference to RatingGaugeState object.	&objRatingGaugeState=GetRatingGaugeState(RECORDNAME.FIELDNAME);
GetRecord	Returns reference to record in current buffer. Default record is the record PeopleCode is on.	&record=GetRecord( [{RECORD.RecordName | @ &RecordRecName }] );
GetReferenceArea	Returns reference to a ReferenceArea object for a Chart object.	&objReferenceArea=GetReferenceArea();
GetReferenceLine	Returns reference to a ReferenceLine object for a Chart object.	&objReferenceLine=GetReferenceLine();
GetRelField	DEPRECATED. Returns related value displayed. Use &Field.GetRelated.	&relatedValue=GetRelField(&ControlField, &RelatedField);
GetRow	Returns reference to current row.	&row=GetRow();
GetRowset	Returns reference to rowset in current context.	&rowset=GetRowset([SCROLL.ScrollName]);
GetRowsetCache	Returns a rowset cache object populated with the rowset cache indicated	&rowsetCache=GetRowsetCache(&rowset, [ROWSET.]Name);
GetSearchRecName	FLUID: Gives the Component's seartch record name.	&strRecordName=GetSearchRecName();
GetSelectedTreeNode	DEPRECATED. Use GenerateTree	GetSelectedTreeNode(RECORD.RecordName);
GetSeries	Returns reference to Series object for a Chart object.	&objSeries=GetSeries();
GetSession	Returns PeopleSoft Session object - you need to connect too. See %Session	&session=GetSession();
GetSetId	Returns set ID name for these parameters. Leave TreeName blank if not required.	&setid=GetSetId(&FieldName, &SetControlValue, &RecordName, &TreeName);
GetSparkChart	Returns reference to SparkChart object.	&objSparkChart=GetSparkChart(RECORDNAME.FIELDNAME);
GetSparkChartItem	Returns reference to SparkChartItem object.	&objSparkChartItem=GetSparkChartItem();
GetSQL	Returns new SQL object populated with Application Designer SQL Statement, replacing bind variables with parameters - which can either be a list or an array of any.	&sql=GetSQL(SQL.SqlName [, param1]...);
GetStatusMeterGauge	Returns reference to a StatusMeterGauge object.	&objStatusMeterGauge=GetStatusMeterGauge(RECORDNAME.FIELDNAME);
GetStoredFormat	Returns the stored custom format name for the specified field.	&storedFormatName=GetStoredFormat([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName);
GetSubContractInstance	DEPRECATED. Use GetSubXmlDoc	GetSubContractInstance(pub_id, pub_nodename, channelname, messagename, sub_name)
GetSubXmlDoc	Returns a reference to XML Doc messge from message queue. Use for error processing or debugging.	&xmlDoc=GetSubXmlDoc(&PublishId, &PublishNodeName, &ChannelName, &VersionName, &MessageName);
GetSyncLogData	Returns XML string of synchronised message log of Log Type (1 original request, 2 transformed request, 3 original response, 4 transformed response)	&xmlLogString=GetSyncLogData(&GUID, &PublishNodeName, &ChannelName, &MessageName, &LogTypeNumber, &VersionName);
GetTempFile	Returns a File object associated with the file named (with %FilePath_Relative,%FilePath_Absolute as PathType) and opens it in the &OpenMode (R,W,U,E,N). No implicit commit, file not displayed in Process Monitor.	&file=GetTempFile(&FileName, &OpenMode [, &CharacterSetName] [, &PathType]);
GetThreshold	Returns a Threshold object for use with gauges.	&objThreshold=GetThreshold();
GetToolTip	Returns a TooltipLabel object for use with charts.	&objToolTipLabel=GetToolTip();
GetTreeNodeParent	DEPRECATED. Use GenerateTree	GetTreeNodeParent(&Node);
GetTreeNodeRecordName	DEPRECATED. Use GenerateTree	GetTreeNodeRecordName(&Node);
GetTreeNodeValue	DEPRECATED. Use GenerateTree	GetTreeNodeValue(&Node [, RecordName.]FieldName);
GetURL	Returns the URL String of the specified URLName in the users language. Maintained under PeopleTools Utilities	&urlString=GetURL(URL.URLName);
GetUserOption	Returns the default value for the option and level.	&value=GetUserOption(&OptionCategoryLevelString,&OptionName);
GetWLFieldValue	Returns the value of the field in the application worklist. Check if called from worklist using %WLName system variable.	&value=GetWLFieldValue(&FieldName);
Global	Creates a global PeopleCode variable that is constant for that session	Global DataType &variable
Gray	Switches the field to not be changeable on the page.	[&isOK=]Gray(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);
GrayMenuItem	DEPRECATED. Use DisableMenuItem	[&isOK=]GrayMenuItem(BARNAME.BarName, ITEMNAME.ItemName);
GroupletRequestSource	FLUID: Determines the type of source page for the Grouplet - %GroupletSourceMain, %GroupletSourceHeader, %GroupletSourceSide1 or 2, %GroupletSourceFooter.	&intSource=GroupletRequestResource();
Hash	Returns 28 character hash of input, but some data is lost to make reversal difficult/impossible.	&hashedString=Hash(&PlainText);
HashSHA256	Returns 44 character hash of input, but some data is lost to make reversal difficult/impossible.	&hashedString=HashSHA256(&PlainText);
HashWithSalt	Returns Base64 encoded hash of input after applying a Salt, Hash Types SHA1 (Deprecated) and SHA256 (recommended).	&strHash=HashWithSalt(&strText [,&strSalt] [,&strHashType] [,&isEmptyBanned );
HermiteCubic	Calculates Hermitian Cubic to mimic hand drawn curve - number array element - (inX,inY,outX0Coefficient,outX1Coefficient,outX2Coefficient,outX3Coefficient)	HermiteCubic(&inOutArrayOfDataPointArray);
Hide	Makes specified field invisible - normally Row Init or FCh	[&isOK=]Hide(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);
HideMenuItem	Hides Menu Item - use PrePopup for pop up menus. Ignored by CI.	HideMenuItem(BARNAME.BarName, ITEMNAME.ItemName);
HideRow	Hides row and related rows in lower scroll levels. Use &Row.Visible	[&isOK=]HideRow([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName [, &TargetRowNumber] );
HideScroll	Hides entire scroll bar and data inside. Use &Rowset.HideAllRows	[&isOK=]HideScroll([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName);
HistVolatility	Returns the Historical Volatility of market traded instrument.	&historicalVolatilityNumber=HistVolatility(&ClosingPriceArray, &TradingDaysPerYear);
Hour	Returns the hour (0-23) of a Time or DateTime	&hour24=Hour(&TimeValue);
IBPurgeDomainStatus	Purges the Integration Broker domain status	&isPurged=IBPurgeDomainStatus();
IBPurgeNodesDown	Purges Integration Broker nodes that are down from the Service Operation Monitor.	&isPurged=IBPurgeNodesDown();
Idiv	Returns the Integer Division result of BigInteger divided by DivisorInteger	&integer=IDiv(&BigInteger, &DivisorInteger);
If	Executes statements depending on condition	If conditions Then [statements] [Else [statements End-If;
InboundPublishXmlDoc	Simulates receiving the message from another node, but is sent from this node	&isPublished=InboundPublishXmlDoc(&XmlDoc, MESSAGE.MessageName, NODE.PublishNodeName [, &IsEnqueued]);
InitChat	Starts MCF chat between customer and agent	&chatIDNumber=InitChat(&LogicalQueueID, &ApplicationURL, &CustomerUserName, [&ChatSubject][, &ChatQuestion][, &WizardURL][, &Priority][, &SkillLevelNumber][, &CostNumber]);
InsertImage	Returns 0 if JPEG/BMP/DIB image file user selects from dialogue is inserted into record field OK	&errorNum=InsertImage(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNum, [RecordName.]FieldName);
InsertRow	DEPRECATED Inserts row in scroll and executes RowInsert. If Is Turbo default processing only for this row. Use RowSet.InsertRow	[&isOK=]=InsertRow(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNum [, &IsTurbo]);
Int	Returns whole integer from truncated floating point Decimal	&integer=Int(&Decimal);
Integer	Returns whole integer from truncated 32 bit twos-complement Decimal (-2,147,483,648 to 2,147,483,647)	&integer=Integer(&Decimal);
IsAddEnabled	FLUID: Returns true if Component Add mode is enabled, false otherwise.	&isAddEnabled=IsAddEnabled();
IsAddMode	FLUID: Returns true if Component is being used in Add mode, false otherwise.	&isInAddMode=IsAddMode();
IsAGComponent	FLUID: Returns true if Component is set to be Activity Guide on Fluid tab, false otherwise.	&isActivityGuide=IsAGComponent();
IsAGRequest	FLUID: Returns true if this request is from an Activity Guide, false otherwise.	&isAgRequest=IsAGRequest();
IsAlpha	Returns true if only alphabetic, textual or numeric characters, false if any numbers or punctuation.	&isAlpha=IsAlpha(&string);
IsAlphaNumeric	Returns true if only alphabetic or textual characters, false if any punctuation.	&isAlphaNumeric=IsAlphaNumeric(&string);
IsBackEnabled	FLUID: Returns true if browser Back is enabled, false otherwise.	&isBackEnabled=IsBackEnabled();
IsClassicPlusMode	Returns true if system and component both have Classic Plus enabled, false otherwise.	&isClassicPlusMode=IsClassicPlusMode(COMPONENT, MARKET);
IsDate	Returns true if Value is string YYYY-MM-DD or number YYYYMMDD	&isDate=IsDate(&Value);
IsDateTime	Returns true if String is date time YYYY-MM-DD HH24:MI:SS.msmsms	&isDateTime=IsDateTime(&String);
IsDaylightSavings	Returns true if DateTime in daylight savings for time zone specified by 3 character string e.g. EST or Local or Base	&isDaylightSavings=IsDaylightSavings(&DateTime, &TimeZone);
IsDigits	Returns true if string only contains the numbers 0-9 (decimal point and signs not included)	&isDigits=IsDigits(&String);
IsFluidMode	FLUID: Returns true if Fluid is enabled on specified Component (current Component if none specified)	&isFluid=IsFluidMode([COMPONENT.COMPONENTNAME], [MARKET.MKT]);
IsFluidStartSearch	FLUID: Returns true if search already been done by user on this Component.	&isSearchStarted=IsFluidStartSearch();
IsGroupletInteractive	FLUID: Returns true if Component running as a interactive Grouplet tile.	&isInteractiveTile=IsGroupletInteractive();
IsGroupletRequest	FLUID: Returns true if Component request started by Grouplet tile.	&isTileRequest=IsGroupletRequest();
IsHidden	DEPRECATED Returns true if row specified is hidden. Use Row.Visible	&isHidden=IsHidden(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNum);
IsHomeEnabled	FLUID: Returns true if Home button is enabled on Component.	&isHomeOn=IsHomeEnabled();
IsIScriptAuthorized	FLUID: Returns true if user has can run specified iScript. Last parameter is Action and should be empty string currently.	&isIscriptAuth=IsIScriptAuthorized(RECORDNAME, FIELDNAME, EVENTNAME, FUNCTIONNAME [, ""]);
IsLogoutEnabled	FLUID: Returns true if LogOut button is enabled on the Component.	&isLogoutOn=IsLogoutEnabled();
IsMDAJAXTrf	FLUID: Returns true if transfers stay within Fluid Master Detail/Activity Guide wrapper, false otherwise.	&isTransferWithin=IsMDAJAXTrf();
IsMDComponent	FLUID: Returns true if Component type on Fluid tab is Master and Detail.	&isMasterDetail=IsMDComponent();
IsMDGuided	FLUID: Returns true if Master/Detail or Activity Component is guided with Previous and Next buttons.	&isMdGuided=IsMDGuided();
IsMDListPopup	FLUID: Returns true if Master/Detail or Activity Component has page navigation presented as a drop down list (same as IsMDNonOptimized).	&isMdPopup=IsMDListPopup();
IsMDListSlideout	FLUID: Returns true if Master/Detail or Activity Component has slide out panel on left.	&isMDListSlideout=IsMDListSlideout();
IsMDNonOptimized	FLUID: Returns true if Master/Detail or Activity Component has page navigation presented as a drop down list (same as IsMDListPopup)	&isNotOPtimized=IsMDNonOptimized();
IsMDRequest	FLUID: Returns true if request came from a Master/Detail Component.	&isMdRequest=IsMDRequest();
IsMDSearchEnabled	FLUID: Returns true if Component search type is Master and Detail.	&isSearchMd=IsMDSearchEnabled();
IsMenuItemAuthorized	Returns true if user is able to access menu item or page specified in action mode (e.g. %Action_Add) specified.	&isUserAuthorized=IsMenuItemAuthorized(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName [,&Action]);
IsMessageActive	Returns true if XmlDoc message is active in Application Designer	&isActive=IsMessageActive(MESSAGE.MessageName);
IsModal	Returns true if run from modal secondary page.	&isCurrentModal=IsModal();
IsModalComponent	Returns true if run from modal component. No effect in CI.	&isModalComponent=IsModalComponent();
IsModalPanelGroup	DEPRECATED: Returns true if run from modal component. Use IsModalComponent	&isModalComponent=IsModalPanelGroup();
IsModeless	FLUID: Returns true if target Display In for tile is not set to Modal.	&isModelessTarget=IsModeless();
IsNavBarEnabled	FLUID: Returns true if NavBar button enabled on Component.	&isNavBarOn=IsNavBarEnabled();
IsNextInListEnabled	FLUID: Returns true if Next in List button enabled on Component.	&isNextOn=IsNextInListEnabled();
IsNotificationEnabled	FLUID: Returns true if Notification button enabled on Component.	&isNotificationOn=IsNotificationEnabled();
IsNotifyEnabled	CLASSIC: Returns true if Notify button enabled on Component.	&isNotifyOn=IsNotifyEnabled();
IsNumber	Returns true if String is a valid numeric value (including signs and decimal points or commas)	&isNumber=IsNumber(&String);
IsOperatorInClass	DEPRECATED Returns true if operator in any of the classes. Use IsUserInPermissionList	&isInClass=IsOperatorInClass(&OpClassName1 [, &OpClassName2]...);
ISOToDate	Returns provided ISO 8601 date time string (YYYY-MM-DDThh:mm:ss[.s{1-6}]+/-hh[:]mm) into PSOPTIONS base time zone date string taking into account Daylight Savings.	&strDate=ISOToDate(&strIsoDateTime);
ISOToDateTime	Returns provided ISO 8601 date time string (YYYY-MM-DDThh:mm:ss[.s{1-6}]+/-hh[:]mm) into PSOPTIONS base time zone date time string taking into account Daylight Savings.	&strDateTime=ISOToDateTime(&strIsoDateTime);
IsPinEnabled	FLUID: Returns true if Add To (Pin) button enabled on Component.	&isNotifyOn=IsNotifyEnabled();
IsPrevInListEnabled	FLUID: Returns true if Previous in List button enabled on Component.	&isPrevOn=IsPrevInListEnabled();
IsSaveEnabled	FLUID: Returns true if Save button enabled on Component.	&isSaveOn=IsSaveEnabled();
IsSearchDialog	Returns true if executed from a search, add or data entry dialogue box	&isSearchDialog=IsSearchDialog();
IsSearchEnabled	FLUID: PT8.54 - Returns true if Search enabled on Component. PT8.55+ Use IsMDSearchEnabled or IsStandardSearchEnabled.	&isSearchEnabled=IsSearchEnabled();
IsSingleComponentAG	FLUID: Returns true if single component Activity Guide.	&isSingleActivity=IsSingleComponentAG();
IsSingleUnitOfWork	FLUID: Returns true if single unit of work Activity Guide.	&isSingleUnitOfWorkActivity=IsSingleUnitOfWork();
IsSmallFFOptimized	FLUID: Returns true if Display on Small Form Factor Homepage selected on Fluid tab.	&isSmallFormed=IsSmallFFOptimized();
IsStandardSearchEnabled	FLUID: Returns true if search type is Standard on Component.	&isStandardSearch=IsStandardSearchEnabled();
IsTime	Returns true if Value is valid time string or number. Format?	&isTime=IsTime(&Value);
IsUserInPermissionList	Returns true if current user is in one or more of the permission lists	&isUserInPL=IsUserInPermissionList(&PermissionList1 [, &PermissionList2]...);
IsUserInRole	Returns true if current user is in one or more of the roles	&isUserInRole=IsUserInRole(&RoleName1 [, &RoleName2]...);
IsUserNumber	Returns true if value supplied is a number in the user's regional settings (with thousands separators for example).	&isNumber=IsUserNumber(&strNumber);

J, K, L

Command	Description	Usage
Left	Returns leftmost Number of Characters from String. Unicode surrogate pairs treated as pairs of characters	&start=Left(&String, &NumCharacters);
Len	Returns length of string. Unicode surrogate pairs treated as two characters	&length=Len(&String);
Lenb	DEPRECATED. No longer supported	&length=Lenb(&String);
LinearInterp	Calculates Linear Interpolation of a set of 2+ points - number array element - (inX,inY,outX0Coefficient,outX1Coefficient,outX2Coefficient,outX3Coefficient)	LinearInterp(&inOutArrayOfDataPointArray);
Ln	Returns the natural logarithm of Number (based on e - approximately 2.71828182845904?)	&naturalLog=Ln(&Number);
LoadABN	DEPRECATED: Load SmartNavigation chart data.	LoadABN(&rsDataSource, &rsChart, &rsRelatedActions, &objNode, &objStartNode, &isdisplayActions, &strFolderClassId, &strCrefClassId);
Local	Declaration of local variable only having scope in this PeopleCode program	Local DataType &Variable [= expression];
Log10	Returns the base 10 logarithm of Number	&log=Log10(&Number);
LogObjectUse	Writes list of all PeopleCode objects with current count to the system log	LogObjectUse([&HeadingString]);
Lower	Returns MixedCaseString in lower case	&lowerCaseString=Lower(&MixedCaseString);
LTrim	Returns String with RemoveCharacters removed from the beginning (or blanks if not specified)	&trimmedString=Ltrim(&String [, &RemoveCharacters]);

M, N, O

Command	Description	Usage
MAddAttachment	Uploads 1+ files from user location to specified storage location. Multiple file version of AddAttachement. Returns %Attachment_Success or various errors.	&intErrCode=MAddAttachment(&strUrlDestination, &strDestinationAppendedPathFilename, &numFiles, &arrStrSourceFiles, &arrNumSizesKB, &arrNumReturnCode [, &numMaximumKB [, &isPreserveCase [, &strDialogTitle [, &isUseLargeChunks [, &isStopOError ]]]] );
MarkPrimaryEmailAddress	Marks the specified email address type (BB,BUS,HOME,OTH,WORK) as the primary email address for the current user	MarkPrimaryEmailAddress(&EmailType);
MarkWLItemWorked	Marks the current worklist item as worked.(WFl only).	&isOK=MarkWLItemWorked();
Max	Returns the highest value - string or number (converted to type of Value1)	&highest=Max(&Value1, &Value2 [, &Value3]...);
MCFBroadcast	Broadcasts a Multichannel Framework message to agents, a queue or system wide.	MCFBroadcast(&strRenCluster, &strQueue, &strChannel, &strAgentState, &strAgentPresence, &strMessageText, &numMessageSet, &numMessageNum, &strDefMessageText, &strSecurityLevel, &strImportanceLevel, &strSenderId, &strNameValuePairs);
MessageBox	Returns pressed key constant after displaying MessageBox with Catalogued Message or Alternative Text	[&responseCode=MessageBox(&Style, &Title, &MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);
Min	Returns the lowest value - string or number (converted to type of Value1)	&lowest=Min(&Value1, &Value2 [, &Value3]...);
Minute	Returns the minute (0-59) from the Time value.	&minute=Minute(&Time);
Mod	Returns the remainder after the division of Number by Divisor	&remainder=Mod(&Number, &Divisor);
Month	Returns the month (1-12) of Date (or DateTime)	&month=Month(&Date);
MsgGet	Returns the message text from MessageSet, MessageNumber after Param substitution, AltText if no message found.	&messageText=MsgGet(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);
MsgGetExplainText	Returns the message explain text from MessageSet, MessageNumber after Param substitution, AltText if no message found.	&messageExplainText=MsgGetExplainText(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);
MsgGetText	Returns the message text from MessageSet, MessageNumber after Param substitution, AltText if no message found.	&messageText=MsgGetText(&MessageSet, &MessageNumber, &AltText [, &Param1 [,&Param2]...]);
NextEffDt	Returns the value of the Field in the next effective dated row in this record, if no more recent record exists will "continue" if in loop.	&fieldValue=NextEffDt(Field);
NextRelEffDt	Returns the value of the Return Field(s) in the next related effective dated row in this record, if no more recent record exists will "continue" if in loop.	&arrAnyFieldValues=NextRelEffDt(SearchField, ReturnField,...);
NodeDelete	Deletes Integration Broker node. Best in SPr.	&isOK=NodeDelete(&NodeName);
NodeRename	Renames Integration Broker node. Best in SPr.	&isOK=NodeRename(&OldNodeName, &NewNodeName);
NodeSaveAs	Creates a copy of Integration Broker node. Best in SPr.	&isOK=NodeSaveAs(&OldNodeName, &NewNodeName);
NodeTranDelete	Deletes an Integration Broker node transaction and any transaction modifier using the transaction. Date format is YYYY-MM-DD	&isOK=NodeTranDelete(&NodeName, &EffectiveDateString, &TransactionType, &RequestMessageName, &RequestMessageVersion);
None	Returns true if no fields/variables in list contain a value. Ie are all null, blank strings or 0 in numeric fields	&isNoValue=None([RecordName1.]FieldName1 [, [RecordName2.]FieldName2]...);
Not	Boolean "not" operator.	if Not &isCondition then ... end-if;
NotifyQ	After EnQueue, NotifyQ gets queue server to recognise new (non voice/chat) tasks of Type (email , generic), returns 0 if successful, else message number from set 162.	&errorCode=NotifyQ(&LogicalQueueID, &TaskType);
NumberToDisplayString	Returns Number formatted as a string - Format of the form %[flags][width][.precision][R , T] [type]	&numberString=NumberToDisplayString(&FormatString, &Number [, &Width [, &Precision );
NumberToString	Returns Number formatted as a string - Format of the form %[flags][width][.precision][R , T] [type]	&numberString=NumberToString(&FormatString, &Number [, &Width [, &Precision );
ObjectDoMethod	Executes ObjectReference.MethodName for Component Interfaces, Application Classes, OLE Automation Objects	ObjectDoMethod(&ObjectReference, &MethodName [, &Param1]... );
ObjectDoMethodArray	Executes ObjectReference.MethodName for Component Interfaces, Application Classes, OLE Automation Objects using Array as list of Parameters (so number and type of parameters does not have to be defined at design time)	[&returnValue=]ObjectDoMethodArray(&ObjectReference, &MethodName, &ParameterArray);
ObjectGetProperty	Returns ObjectReference.PropertyName value	[&returnValue=]ObjectGetProperty(&ObjectReference, &PropertyName [, &OleIndexList] );
ObjectSetProperty	Sets ObjectReference.PropertyName to Value	ObjectSetProperty(&ObjectReference, &PropertyName, &Value [, &OleIndexList] );
OnlyOne	Returns true if only one of the fields listed are not blank strings / non-zero in numeric fields	&isOneSet=OnlyOne( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );
OnlyOneOrNone	Checks if only one or none of the fields listed are not blank strings / non-zero in numeric fields	&isNoMoreThanOneSet=OnlyOneOrNone( [RecordName.]FieldName [, [RecordName2.]FieldName2] ... );
Or	Boolean "or" operator.	if &isCondition1 or &isCondition2 then ... end-if;
OverrideCNAVDisplayMode	DEPRECATED: Disables or reenables Conditional Navigation. Use OverrideConditionalNav.	[&isOK=]OverrideCNAVDisplayMode([&isToDisable]);
OverrideConditionalNav	Changes Conditional Navigation to specified mode to %CNAV_SkipAll, %CNAV_RestoreAll or combination of %CNAV_SkipDisplayMode, %CNAV_SkipToolsRel, %CNAV_SkipGeneric or %CNAV_SkipNavGroup. Returns 1 success, 0 fail.	[&intReturn=]OverrideConditionalNav([&numMode]);

P, Q, R

Command	Description	Usage
PanelGroupChanged	DEPRECATED Returns true if the component (panel group) data has changed since the last save. Use ComponentChanged	&isChanged=PanelGroupChanged();
PingNode	Returns an XML Doc with a node "status" with info about Node Name pinged.	&statusXmlDoc=PingNode(&NodeName);
PriorEffDt	Returns the value of the Field in the previous effective dated row in this record, if no more recent record exists will "continue" if in loop.	&fieldValue=PriorEffDt(Field);
PriorRelEffDt	Returns the value of the Return Field in the previous related effective dated row in this record, if no more recent record exists will "continue" if in loop.	&anyValue=PriorRelEffDt(SearchField, ReturnField,.........);
PriorValue	FCh, Fed of Field ONLY: Returns value in field before field was changed by user. If used in other PeopleCode programs, returns current value.	&value=PriorValue(Field);
Product	Returns product of numbers multiplied together. Equivalent to &product=&Number1*&Number2; etc.	&product=Product(&Number1 [, &Number2]...);
Prompt	Prompts the user for vales that either populate the record or a group of variables. Often used for Query prompt values.	[&isOKClicked=]Prompt(&Title, &Heading {, &Record | , Field1 [, &Label1 [, &ResponseVar1...);
Proper	Returns String with first letter of each word capitalised. Similar to Oracle SQL InitCap	&initialCapitals=Proper(&String);
PublishXmlDoc	Returns true if XML Doc is published as MessageName to NodeName successfully.	&isOK=PublishXmlDoc(&XmlDoc, MESSAGE.MessageName [, NODE.NodeName] );
PutAttachment	Puts file attachment from Application Server to File Server (specified in URL Destination)	&errorCode=AddAttachment(&URLDestination, &DestinationAppendedPathFilename [, &SourceFile [, &PreserveCaseBoolean );
Quote	Returns String as a quoted SQL string - single quotes replaced with two single quotes, surrounded by single quotes	&quotedString=Quote(&String);
Radians	Returns angle in radians from degrees	&radians=Radians(&degrees);
Rand	Returns a random number 0 <= Random Number < 1	&randomNumber=Rand();
RecordChanged	DEPRECATED Returns true if any data in the specified row has changed. Use &Row.IsChanged	&isChanged=RecordChanged({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber} );
RecordDeleted	DEPRECATED Returns true if the specified row has been deleted. Use &Row.IsDeleted	&isDeleted=RecordDeleted({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber} );
RecordNew	DEPRECATED Returns true if the specified row has been inserted. Use &Row.IsNew	&isNew=RecordNew({RECORD.RecordName | RecordName.FieldName | [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber} );
RefreshTree	DEPRECATED Updates a dynamic tree. Use GenerateTree or Tree Viewer	RefreshTree(RECORD.RecordName);
RelNodeTranDelete	Returns true if transaction modifier deleted OK.	&isOK=RelNodeTranDelete(&RelationshipId , &SourceTransactionType, &SourceNode, &SourceRequestMessageName, &SourceRequestMessageVersion, &TargetNode, &TargetRequestMessageName, &TargetRequestMessageName, &TargetRequestMessageVersion);
RemoteCall	Calls Tuxedo service normally for COBOL. COBOL DispatcherName is PSRCCBL.Parameter PSCOBOLPROG gives name of COBOL program.	RemoteCall(&DispatcherName [, &ServiceVariable1, &ServiceValue1]... [, &UserVariable1, &UserValue1]... );
RemoveDirectory	Removes directory. PathType (%FilePath_Relative , %FilePath_Absolute) add on %Remove_Subtree or %Remove_Directory	RemoveDirectory(&Path [, &PathType [+ &SubtreeRemoval);
RenameDBField	Returns %MDA_Success if renames field OK (as per App Designer rename). Note view SQL and SQLExec will need to be fixed. If References Only, then field is not renamed, but references are changed (useful for customisations that are patched)	&errorCode=RenameDBField(FIELD.NewFieldName, FIELD.OldFieldName [, &isReferencesOnly] );
RenamePage	Returns %MDA_Success if renames page OK (as per App Designer rename).	&errorCode=RenamePage(PAGE.NewPageName, PAGE.OldPageName);
RenameRecord	Returns %MDA_Success if renames page OK (as per App Designer rename).	&errorCode=RenameRecord(RECORD.NewRecordName, RECORD.OldRecordName);
Repeat	Statements are executed at least once. BooleanExpression is evaluated and if false, statements are executed until the expression gives true	Repeat statements; until &BooleanExpression;
Replace	Returns replaced characters in String from Start Position for Number Characters with New Text	&changedString=Replace(&String, &StartPosition, &NumberCharacters, &NewString);
Rept	Returns String repeated Repeat Number of times.	&repeatedString=Rept(&String, &RepeatNumber);
ResizeImage	Returns unique ID for the resizing(s) of the image (<0 is error), style is %Resize_ByDimensions or %Resize_ByPercentage, size array is zero terminated.	&numId=ResizeImage(URL.SOURCE_URL, URL.TARGET_URL, &arrNumSizes [, &numStyle] [, &isMaintainAspect] );
ReSubmitPubHeaderXmlDoc	Returns true if the untransformed message is resubmitted OK	&intId=ReSubmitPubHeaderXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName);
ReSubmitPubXmlDoc	Returns true if the transformed message is resubmitted OK	&isOK=ReSubmitPubXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName, &MessageName, &SubscriptionNode);
ReSubmitSubXmlDoc	Returns true if the subscribed message is resubmitted OK. Subscription PeopleCode is rerun.	&isOK=ReSubmitSubXmlDoc(&PublisherID, &PublishNode, &ChannelName, &VersionName, &MessageName, &SubscriptionName);
Return	This returns from a function. Value is returned value of function.	Return [&Value];
Returns	In function definition, specifies the returned value type.	Returns String;
ReturnToServer	Returns value from a PeopleCode messaging program to all subscription and publication nodes or none, or nodes in array as either a message or XML document.	ReturnToServer({&isAllNodes | &arrNodes}, {&objMessage | &XmlDoc} )
ReValidateNRXmlDoc	Revalidates a non-repudiation message signed by EntityName (in PS this is NodeName), returns true if validation successful	&isOK=ReValidateNRXmlDoc(&MessageID, &EntityName);
RevalidatePassword	Returns 0 if password is entered in window is user's correct password. Think Time Function	&errorCode=RevalidatePassword();
Right	Returns the last Number Of Characters (or the last character if number omitted) of String. Unicode surrogate pairs treated as pairs of characters	&endString=(&String [, &NumberOfCharacters] );
Round	Returns Number rounded to Decimal Places	&roundedNumber=Round(&Number, &DecimalPlaces);
RoundCurrency	Returns Amount rounded as per PS_CURRENCY_CD_TBL on that Effective Date	&roundedAmount=RoundCurrency(&Amount, &CurrencyCd, &Effdt);
RowFlush	DEPRECATED Removes a specific row from a page scroll and component buffer not database. Use RowSet.FlushRow	RowFlush([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber);
RowScrollSelect	DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. Use RowSet.Select	[&numberRows=]RowScrollSelect(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);
RowScrollSelectNew	DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. The rows are marked as New so they will be inserted into the database. Use RowSet.Select	[&numberRows=]RowScrollSelectNew(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);
RTrim	Returns String with RemoveCharacters removed from the end (or blanks if not specified)	&trimmedString=Rtrim(&String [, &RemoveCharacters]);

S, T, U

Command	Description	Usage
ScheduleProcess	DESUPPORTED Schedules process	ScheduleProcess(&ProcessType, &ProcessName [, &RunLocation] [, &RunCntlID] [, &ProcessInstance] [, &RunDateTime] [, &RecurName] [, &ProcessServerName]);
ScrollFlush	DEPRECATED Removes all rows from a page scroll and component buffer not database. Use RowSet.Flush	ScrollFlush([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName);
ScrollSelect	DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. Use RowSet.Select	[&numberRows=]ScrollSelect(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);
ScrollSelectNew	DEPRECATED Loads specified scroll from database applying where clause and ordering under single parent row. The rows are marked as New so they will be inserted into the database. Use RowSet.Select	[&numberRows=]ScrollSelectNew(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, RECORD.RecordName [, &WhereOrderString [, &BindVariable1 ]... ] [, &isTurbo]);
Second	Returns seconds (0-59) part of time value	&seconds=Second(&Time);
SecureRandomGen	Returns 1+ CSPRNG random generated string(s) for use in password salts. Default is 1 value of 16 bytes.	&arrStrRandom=SecureRandomGen([&numValues] [, &numBytes]);
SendMail	Returns 0 if email successfully sent	&errorCode=SendMail(&PlatformFlags, &To, &Cc, &Bcc, &Subject, &Text[, &AttachmentFilenames][, &AttachmentTitles][, &From][, &ToSeparator][, &ContentType][, &ReplyTo][, &Sender]);
SetAddMode	FLUID: Sets the Component to Add mode (or not).	SetAddMode(&isAddMode);
SetAuthenticationResult	In Sign On PeopleCode, sets if logon successful and if password warning/expiry messages should be shown to user	&isOK=SetAuthenticationResult(&AuthenticationResult [, &OperatorId] [,&ResultDocument] [,&isPasswordExpired] [&DaysBeforeExpiryWarn]);
SetChannelStatus	Sets an integration broker channel status (1=Run, 2=Pause)	&isOK=SetChannelStatus(&ChannelName, &StatusNumber);
SetComponentChanged	Sets the component changed flag, so Save processing is triggered. This is automatically set if a field is changed.	SetComponentChanged();
SetControlValue	Puts specified value into the GUI control instead of value from buffer. Used for specialised validation. Does not run in CI.	SetControlValue(&Value, &PageName, &PageFieldName [, &RowNumber][, &FieldObject]);
SetCursorPos	Puts cursor in specified field	SetCursorPos({PAGE.PageName | %Page}, RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName], [&RecordName.]&FieldName, &TargetRowNumber);
SetDBFieldAuxFlag	Returns %MDA_Success if AuxMaskFlagNumber (1-32) on Field is changed successfully to True or False accordingly.	&errorCode=SetDBFieldAuxFlag(FIELD.FieldName, &AuxMaskFlagNumber, &setToTrue);
SetDBFieldCharDefn	Returns %MDA_Success if field format is changed. FormatFamilyNumber example: %FormatFamilyType_SSN	&errorCode=SetDBFieldCharDefn(FIELD.FieldName, &LengthNumber [,&FormatFamilyNumber]);
SetDBFieldFormat	Returns %MDA_Success if character field with LengthNumber characters. FormatFamilyNumber example: %FormatFamilyType_MixedCase	&errorCode=SetDBFieldFormat(FIELD.FieldName ,&FormatFamilyNumber [,&FamilyName, &DisplayName]);
SetDBFieldFormatLength	Returns %MDA_Success if character field format length is changed to LengthNumber characters. Does not require rebuild.	&errorCode=SetDBFieldFormatLength(FIELD.FieldName, &LengthNumber);
SetDBFieldLabel	Returns %MDA_Success if character field label is changed or inserted.	&errorCode=SetDBFieldLabel(FIELD.FieldName, &LabelId, &LongLabel, &ShortLabel, &Default [, &LanguageCode]);
SetDBFieldLength	Returns %MDA_Success if character length is changed to LengthNumber characters. Requires table rebuild.	&errorCode=SetDBFieldLength(FIELD.FieldName, &LengthNumber);
SetDBFieldNotUsed	Returns %MDA_Success if field is changed to not used - not put in indexes, nVision or Query	&errorCode=SetDBFieldNotUsed(FIELD.FieldName, &isNotUsed);
SetDefault	Returns true if sets field to null value which will cause default processing, when next checked.	[&isOK=]SetDefault([RecordName.]FieldName);
SetDefaultAll	Returns true if sets all instances of the field in the scroll to null value which will cause default processing, when next checked.	[&isOK=]SetDefaultAll([RecordName.]FieldName);
SetDefaultNext	Sets next effective dated field to null value which will cause default processing, when next checked.	SetDefaultNext([RecordName.]FieldName);
SetDefaultNextRel	Sets related, defaulted field on the next effective dated control field to null value which will cause default processing, when next checked.	SetDefaultNextRel(ControlFieldName,DefaultedFieldName);
SetDefaultPrior	Sets previous effective dated field to null value which will cause default processing, when next checked.	SetDefaultPrior([RecordName.]FieldName);
SetDefaultPriorRel	Sets related, defaulted field on the previous effective dated control field to null value which will cause default processing, when next checked.	SetDefaultPriorRel(ControlFieldName,DefaultedFieldName);
SetDisplayFormat	DEPRECATED Changes the custom defined display field format. Use Field.DisplayFormat	&isOK=SetDisplayFormat([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName, &DisplayFormatName);
SetLabel	DEPRECATED Changes the label for the field. Use Field.Label	[&isOK=]SetLabel([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName, &LabelText);
SetLanguage	Sets user interface and data language code for this session. Language Code must be a translate value of LANGUAGE_CD. Not in Sign on PeopleCode	[&isOK=]SetLanguage(&LanguageCd);
SetMDAJAXTrf	FLUID: From Wrapper, Sets transfers to be internal within wrapper (or not).	[&isOK=]SetMDAJAXTrf(&isInTransfer);
SetMDGuided	FLUID: Sets Master/Detail and Activity Guide wrapper Component to Guided mode (or not).	[&isOK=]SetMDGuided(&isGuided);
SetMDListPopup	FLUID: Sets Master/Detail and Activity Guide Components to switch navigation to pages as a drop down list (or back to a left hand panel).	[&isOK=]SetMDListPopup(&isPopup);
SetMDListSlideout	FLUID: Sets collision handling on (or off) for left hand panel.	SetMDListSlideout(&isCollisionHandling);
SetMessageStatus	Sets message status to %IB_Status_Active or %IB_Status_InActive	&isOK=SetMessageStatus(MESSAGE.MessageName, &StatusNumber);
SetNextPage	Returns true if next page (F6/TransferPage) is set to Page	[&isOK=]SetNextPage(&PageName);
SetNextPanel	DEPRECATED Returns true if next page (F6/TransferPage) is set to Page. Use SetNextPage	[&isOK=]SetNextPanel(&PageName);
SetPageFieldPageFieldName	Returns %MDA_Success if PageFieldName is set successfully.	&errorCode=SetPageFieldPageFieldName(PAGE.PageName, RECORD.RecordName, FIELD.FieldName, &PageFieldName);
SetPanelControlStyle	FLUID: Specifies CSS style string to update the styles of left and right panels.	[&isOK=]SetPanelControlStyle(&strStyles);
SetPasswordExpired	Returns old value of password expired and sets to new Is Password Expired boolean value	&isOK=SetPasswordExpired(&isPasswordExpired);
SetPostReport	Returns a reference to a PostReport object for posting files to the Report Repository using postReport.Put	&postReport=SetPostReport();
SetRecFieldEditTable	Returns %MDA_Success if Record Field edits are changed to EditTable and EditType (e.g. %EditTableType_Prompt) successfully.	&errorCode=SetRecFieldEditTable(RECORD.RecordName, FIELD.FieldName, &EditTableName [, &EditTypeNumber]);
SetRecFieldKey	Returns %MDA_Success if Record Field is changed to being a key successfully.	&errorCode=SetRecFieldKey(RECORD.RecordName, FIELD.FieldName, &isKey);
SetReEdit	Sets re-edit mode on/off to run Fed, check translate and prompt table edits on all fields on component as though the entries were all new.	SetReEdit(&isReEdit);
SetSaveWarningFilter	Suppresses (or not) the warning when fields are changed.	SetSaveWarningFilter(&isWarningSuppressed);
SetSearchDefault	Populates search dialog box field with Application Designer default, but does not run FDe	SetSearchDefault([RecordName.]FieldName);
SetSearchDialogBehavior	SIn: Makes search dialog either skip if possible (Force Number=0) or force dialog display (1)	SetSearchDialogBehavior(&ForceNumber);
SetSearchEdit	DEPRECATED Sets edits on for a search dialog field. Use Field.SearchEdit	&isOK=SetSearchEdit([RecordName.]FieldName);
SetTempTableInstance	Sets the temporary table default instance number and returns the previous one (for resetting later). Used by %Table and SQL functions on Temporary Tables.	&oldTableInstanceNumber=SetTempTableInstance(&NewTableInstanceNumber);
SetThemeId	FLUID: Sets the theme for the Page or Component.	SetThemeId(&strThemeId);
SetTracePC	Sets PeopleCode trace to number specifed e.g. %TracePC_EachStmt (2048)	SetTracePC(&TraceSettingNumber);
SetTraceSQL	Sets SQL trace to number specified e.g. %TraceSQL_Statements + %TraceSQL_Variables	SetTraceSQL(&TraceSettingNumber);
SetTransferAttributes	Sets specific behaviour when transferring to a Page or Component. These can be set prior to transfer or immediately on activating the Page. Transfer Parameters are in the form Field1@Value1;Field2@Value2... returntolastpage@1 returns to last viewed Page of Component.	SetTransferAttributes(&isAnimated, &isAddedToHistory, &strBackBtnLabel, &strTransferParameters, &arrArrStrUrlQueryParameters);
SetupScheduleDefnItem	Returns a new process request object for a Scheduled JobSet	&processRequest=SetupScheduleDefnItem(&ProcessTypeName, &JobName);
SetUserOption	Returns true if specified user option default is set to new value	&isOK=SetUserOption(&OptionCategoryLevel, &OptionName, &DefaultValue);
ShareAttachment	Shares files in the Oracle Content and Experience Cloud. Mode %ShareMode_Member/PublicRegisteredUsers/PublicAnyone. Role %ShareRole_Viewer/Downloader/Contributor.	&numZero=ShareAttachment(&urlCloud, &strFile2Share, &urlShare[, &numMode, &numRole, &dtmExpire, &strKey, &arrUsers]);
ShouldSuppressCREF	Returns whether URL should be suppressed given the current context.	&isSuppressed=ShouldSuppressCREF(&objCref.AbsoluteContentURL);
Sign	Returns 1 if number positive, -1 if negative and zero if number is zero	&signNumber=Sign(&Number);
Sin	Returns the sine (-1 to +1) of the angle Radians	&sine=Sin(&Radians);
SinglePaymentPV	Returns future value of monetary unit after Number Of Periods at Interest Rate	&unitValue=SinglePaymentPV(&InterestRate, &NumberOfPeriods);
SortScroll	DEPECATED Sorts the scroll by list of fields in order (A , D) provided. Use RowSet.Sort	[&isOK=]SortScroll(&LevelNumber, [RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, [SortRecordName.]SortFieldName1, &Order1 [, [SortRecordName.]SortFieldName2, &Order2]...);
Split	Returns an array of strings found in Big String cut up by (not including) Separator (or space). If Big String ends in Separator, no empty string added to array at end	&stringArray=Split(&BigString [, &Separator]);
SQLExec	Executes SQL statement, if select returns only 1 row, bind variables marked :1, :2 etc. in SQL Statement. SPr, WFl, Spo, FCh Only	[&isOK=]SQLExec({&SQLStatement | SQL.SqlName} [, &BindVariable1]... [, SelectedValue1]...);
Sqrt	Returns the square root of Number. If Number negative, displays error.	&squareRoot=sqrt(&Number);
StartWork	Starts a transaction in which no updates are saved until a CommitWork	StartWork();
Step	The amount to increment in a for loop.	for &index = &numInitial to &numStop step &numIncrement;
StopFetching	RSe only. Makes this the last row to be added to the database buffer and stops any further fetches from DB	StopFetching();
StoreSQL	Stores SQL (like App Designer) with DB Type (AppServer , DB2 , DB2Unix , Informix , Microsoft , Oracle , Sybase) and EffDt (Date type) and 4 char Owner	StoreSQL(&SqlStatement, SQL.SqlName [,&DBType [,&EffDt [,&Owner [,&Description);
String	Converts number to string. Numbers maybe represented differently across platforms. If you want to be fussy, use NumberToString	&string=String(&Value);
StripOffHTMLTags	Returns the HTML string without the HTML tags (such as )	&strText=StripOffHTMLTags(&strHtml);
Subrecords		.........
Substitute	Replaces every occurrence of OldSubString with NewSubString. Tilde (~) means one or more spaces.	&resultString=Substitute(&String, &OldSubString, &NewSubString);
Substring	Returns Partial String by taking Number Of Characters from Start Position of String. Unicode character pairs could get split.	&partialString=Substring(&String, &StartPosition, &NumberOfCharacters);
Substringb	DEPRECATED Use SubString	&partialString=Substringb(&String, &StartPosition, &NumberOfCharacters);
SwitchUser	Switches user by User/Pass or by Authentication Token. Calls SignOn PeopleCode.	&isOK=SwitchUser(&User, &Password, &AuthenticationToken, &Base64ExternalAuthentication);
SyncRequestXmlDoc	Returns Response when command sends unstructured XmlDocument synchronously	&ResponseXmlDocument=SyncRequestXmlDoc(&XmlDocument, MESSAGE.MessageName[, NODE.NodeName]);
Tan	Returns the tangent value (0-lots) of the angle in Radians	&tangent=Tan(&Radians);
Then	Executes statements depending on condition	If conditions Then [statements] [Else [statements End-If;
Throw	Throws an exception using the specified Exception object	Throw &ExceptionObject;
Time	Creates a Time value from Number in format HHMMSS[.SSSSSS]	&timeValue=Time(&Number);
Time3	Creates a Time value from Hour (0-23), Minutes (0-59), Seconds (0-59.999999)	&timeValue=Time3(&Hours, &Minutes, &Seconds);
TimePart	Returns the Time value from a DateTime	&timeValue=TimePart(&DateTimeValue);
TimeToTimeZone	Returns fromTime converted by time zone specified by 3 character string e.g. EST or Local or Base	&dateTime=TimeToTimeZone(&fromTime, &fromTimeZone, &toTimeZone);
TimeValue	Creates a Time value from String in format HH:MM:SS[:SSSSSS]	&timeValue=TimeValue(&String);
TimeZone		.........
TimeZoneOffset	Returns the offset (+/-hh:mm) of Date Time from GMT. TimeZone can be a TZ value or Local or Base	&offsetString=TimeZoneOffset(&DateTime [,&TimeZone] );
To	Separates the intial value from the ending value in a for loop.	for &index = &numInitial to &numStop step &numIncrement;
TotalRowCount	Returns the total number of rows in the scroll including deleted rows	&numberRows=TotalRowCount([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName);
Transfer	Transfers to component and page with action (A , U , L , C , E). Current keys are added to Key Fields and searched using LIKE. Search dialog shown if not a single row selected	Transfer(&IsNewWindow, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...] [, &IsAutoSearch] );
TransferExact	Transfers to page with action (A , U , L , C , E). Current keys are added to Key Fields and searched using equals. Search dialog shown if not a single row selected	TransferExact(&IsNewWindow, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...] [, &IsAutoSearch] );
TransferMobilePage	DEPRECATED/REMOVED: Transfers to the specified Mobile Page Detail View.	TransferMobilePage( [MOBILEPAGE.]PageName, &TabNumber, &CiObject);
TransferModeless	Transfers to component and page on top of the current page (without greying out current page) with action (A , U , L , C , E). Current keys are added to Key Fields and searched using LIKE. Search dialog shown if not a single row selected	TransferModeless(MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...] [, &IsAutoSearch] );
TransferNode	Transfers to a page in another node in the Portal with action (A , U , L , C , E). Current keys are added to Key Fields and searched using equals. Search dialog shown if not a single row selected	[&isOK=]TransferNode(&IsNewWindow, NODE.NodeName, MENU.MenuName, MARKET.MarketName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);
TransferPage	Terminates current PeopleCode and transfers to page within current component (if none specified uses one set by SetNextpage). Ignored in CI.	[&isOK=]TransferPage([PAGE.PageName]);
TransferPanel	DEPRECATED. Use TransferPage (the do the same thing).	[&isOK=]TransferPanel([PANEL.PageName]);
TransferPortal	Transfers to a page in another Portal with action (A , U , L , C , E). Current keys are added to Key Fields and searched using equals. Search dialog shown if not a single row selected	[&isOK=]TransferPortal(&IsNewWindow, PORTAL.PortalName, NODE.NodeName, MENU.MenuName, MARKET.MarketName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);
TransferTop	Replaces page with another page with action (A , U , L , C , E). Current keys are added to Key Fields and searched using equals. Search dialog shown if not a single row selected	[&isOK=]TransferPortal(&isIgnored, MENU.MenuName, BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName, &Action [, [RecordName1.]KeyFieldName1...]);
Transform	Returns XML Document transformed by AE program, never Null.	&resultXmlDoc=Transform({&XmlString | &XmlDoc}, AEProgram, &StartNodeName, &StartMessageName, &StartMessageVersion, &ResultNodeName, &ResultMessageName, &ResultMessageVersion);
TransformEx	Returns the well-formed XML String transformed by the XSLT String - null if unsuccessful	&resultXmlString=TransformEx(&XmlString, &XsltString);
TransformExCache	Returns the well-formed XML Doc transformed by the XSLT File (which is cached for speedy multiple calls) - never null	&resultXmlString=TransformExCache(&XmlDoc, &XsltFileName, &XsltCacheKey);
TreeDetailInNode	Not PIA. Client Tree Manager only: Checks if value in FieldName is under the HighLevelNodeName in the specified tree	&isDescendant=TreeDetailInNode(&TreeSetID, &TreeName, &TreeEffdt, RecordName.FieldName, &HighLevelNodeName);
TriggerBusinessEvent	Triggers workflow on the business event. If unsuccessful, will rollback errors up to trigger, but updates after will be commited if not stopped!	&isOK=TriggerBusinessEvent(BUSPROCESS.BusinessProcessName, BUSACTIVITY.ActivityName, BUSEVENT.BusinessEventName);
Truncate	Returns Number truncated to Number Of Digits after the decimal point	&truncatedNumber=Truncate(&Number, &NumberofDigits);
Try	Creates a block where statements can error and these are handled.	Try statementsSandbox; Catch exceptionSubClass &Exception errorHandlingStatements; End-Try;
UIDisplayMode	Returns number showing which user interface is being displayed - 1 Classic, 2 Fluid, 3 Small Form Factor, 0 Other/Error	&intDisplay=UIDisplayMode();
UnCheckMenuItem	DEPRECATED Unchecks the Windows client menu item	UnCheckMenuItem(BARNAME.MenuBarName, ITEMNAME.MenuItemName);
Unencode	Returns decoded URL String from encoded string according to W3C rules with HTTP %xx	&plainUrlString=Unencode(&EncodedUrlString);
Ungray	Switches the field to be changeable on the page.	[&isOK=]Ungray(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);
Unhide	Makes specified field visible - normally Row Init or FCh	[&isOK=]Unhide(RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.FieldName);
UnhideRow	Shows row and related rows in lower scroll levels. Use &Row.Visible	[&isOK=]UnhideRow([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName [, &TargetRowNumber] );
UnhideScroll	Shows entire scroll bar and data inside. Use &Rowset.Visible	[&isOK=]UnhideScroll([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, [RecordName.]FieldName);
UniformSeriesPV	Returns value of single unit after uniform series of payments at Interest Rate	&unitValue=UniformSeriesPV(&InterestRate, &NumberOfPeriods);
UnshareAttachment	Revokes sharing access on Oracle Cloud (via ShareAttachment).	&numZero=UnshareAttachment(&urlCloud, &strFile2Share, &numMode, &numRole[, &arrUsers]);
Until	Statements are executed at least once. BooleanExpression is evaluated and if false, statements are executed until the expression gives true	Repeat statements; until &BooleanExpression;
UpdateSysVersion	PeopleTools Only. Returns version number for co ordinating changes to system tables e.g. Message Catalogue	&versionNumber=UpdateSysVersion();
UpdateValue	Updates specified Field with Value. Use Field.Value	UpdateValue([RECORD.Level1RecordName, &Level1Row, [RECORD.Level2RecordName, &Level2Row, RECORD.TargetRecordName, &TargetRowNumber, &Value);
UpdateXmlDoc	Updates message in queue with specified version	&isOK=UpdateXmlDoc(&XmlDocument, &PublishId, &PublishNodeName, &ChannelName, &VersionName[, &MessageName[, &SubNode);
Upper	Returns the Mixed Case String in Upper Case	&uppercaseString=Upper(&MixedCaseString);

V, W, X

Command	Description	Usage
Value	Returns String converted to a number	&number=Value(&String);
ValueUser	Returns String converted to a number using conventions from the user's locale (such as thousands separator).	&number=ValueUser(&String);
VerifyHash	Check if plain text string plus supplied Salt equals the given hash string.	&isMatched=VerifyHash(&strPlain, &strSalt, &strHashed);
VerifyOprPassword	Verifies that plain text string matches password hashed and stored in PSOPRDEFN for the OPRID (O) or USERIDALIAS (U) equal to User ID.	&isMatched=VerifyOprPassword(&chrOpridOrUserAlias, &strUserId, &strPlain);
ViewAttachment	Returns 0 if attachment successfully shown	&errorCode=ViewAttachment({&fromURL | URL.UrlName}, &DestinationAppendedPathFilename, &ClientFile [, &IsNewWindow [, &PreserveCaseBoolean);
ViewContentURL	Creates new browser window showing URL specified	ViewContentURL({&UrlString | URL.UrlName});
ViewContentURLClassic	Transfers showing Classic URL specified in new window or in detail pane depending on context.	ViewContentURLClassic({&UrlString | URL.UrlName}[, &numIgnored]);
ViewContentURLFluid	Transfers showing Fluid URL specified in new window or in detail pane depending on context.	ViewContentURLFluid({&UrlString | URL.UrlName}[, &numIgnored]);
ViewContentURLModeless	FLUID: From a Fluid component, you can view a modal Classic or Fluid page on top of the current page. You can specify the modal options in the form of "bAutoClose@1;bHeader@0".	ViewContentURLModeless({&UrlString | URL.UrlName} [, &strOptions]);
ViewURL	Views (external) URL in current browser window or launches default browser to view	ViewURL({&UrlString | URL.UrlName} [, &IsNewWindow]);
ViewURLModeless	Views (external) URL in on top of current Page in a modal window. You can specify the modal options in the form of "bAutoCloseWarn@1;width@200".	ViewURL({&UrlString | URL.UrlName} [, &strOptions ]);
ViewURLTop	Replaces current page with URL specified.	ViewURLTop({&UrlString | URL.UrlName}[, &numIgnored]);
Warning	FEd, SEd: Displays warning message and continues PeopleCode and save; Rse: Skip current row. RDe: User clicks OK row is deleted, Cancel row not deleted	Warning &String;
Weekday	Returns number (1=Sunday, 7=Saturday) of the day of the week for Date	&dayNumber=Weekday(&date);
When	Evaluate branches depending on conditions on Value	Evaluate &Value When ... End-evaluate
When-Other	Evaluate branches depending on conditions on Value	Evaluate &Value When ... When-Other ... End-evaluate
While	Repeats Statements while Boolean is true.	While (&Boolean) Statements; End-While;
WinEscape	DEPRECATED/NOT SUPPORTED Cancels panel.	WinEscape();
WinExec	DEPRECATED/NOT SUPPORTED Executes command on Windows client machine	[&returnCode=]WinExec(&Command, &Option [, &IsSynchonised]);
WinMessage	DEPRECATED Displays message with buttons. Use MessageBox	[&buttonPressedNumber=]WinMessage(&Message [,&StyleNumber] [, &Title]);
WriteToLog	Writes message to the Application Server log file if Severity is less than Log Fence set	WriteToLog(&SeverityNumber, &Message);

Y, Z

Command	Description	Usage
Year	Returns the year (1900 - 2078) from the Date value	&yearNumber=Year(&Date);

Further Reading

PeopleSoft Users Companion Extras

Also take a quick look at our useful free data Tools page.