Sheet1

Command Description Usage

Abs Returns absolute value oI inNumber (without the or - sign) &numberAbs(&inNumber);
AccruableDays
Returns integer number oI accrual days according to
accounting conventions &integerAccruableDays(&BeginDate, &EndDate, &AccrualConvention);
AccrualFactor
Returns Iactor equal to number oI years interest accrued
between dates using acounting convention. &numberAccrualFactor(&BeginDate, &EndDate, &AccrualConvention);
Acos
Returns angle in radians (0 to pi) with speciIied cosine value
(-1.0 to 1.0) &radiansAcos(&cosine);
ActiveRowCount
Returns number oI non-deleted rows - use
Rowset.ActiveRowCount
&integerActiveRowCount(|RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName);
AddAttachment Adds Iile attachment Irom browser onto server
&errorCodeAddAttachment(&URLDestination,
&DestinationAppendedPathFilename, &SuggestedFileExtension,
&SourceFile, &MaximumKB |, &PreserveCaseBoolean|);
AddEmailAddress Add email address oI current user - 1 per type
AddEmailAddress(&EmailTypeName, &EmailAddress
|,&PrimaryBoolean|);
AddKeyListItem
Adds new key value to navigation list oI keys Ior
autocompletion oI search dialogs &isOKAddKeyListItem(&FieldName, &Value);
AddSystemPauseTimes
Adds weekly system pause time Ior messages to/Irom day (0-
6) to Irom time in seconds Irom midnight (0-24x60x60 or
86,400)
&isOKAddSystemPauseTimes(&BeginWeekDayNumber,
&BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);
AddToDateTime
Returns date time aIter numOIYears, Months, Days, Hours,
Minutes, Seconds aIter (-ve means beIore) inDateTime
&dateTimeAddToDateTime(&inDateTime, &numOIYears,
&numOIMonths, &numOIDays, &numOIHours, &numOIMinutes,
&numOISeconds);
AddToDate
Returns date time aIter numOIYears, Months, Days, Hours,
Minutes, Seconds aIter (-ve means beIore) inDate
&dateAddToDate(&inDate, &numOIYears, &numOIMonths,
&numOIDays);
AddToTime
Returns time aIter numOIHours, Minutes, Seconds aIter (-ve
means beIore) inDate
&timeAddToTime(&inTime, &numOIHours, &numOIMinutes,
&numOISeconds);
AllOrNone
Checks iI Iields listed are all blank strings / non-zero OR all
are not
&isConsistentAllOrNone( |RecordName.|FieldName |,
|RecordName2.|FieldName2| ... );
All
Checks iI Iields listed are all not blank strings / non-zero in
numeric Iields
&isNotBlankAll( |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 oI loan payment, inPayment, (payment
number inPaymentNumber) - interest (outToInterest) and
pays oII principal (outToPrincipal) and the remaining
balance (outBalance)
Amortize(&inInterest, &inPrincipalBalance, &inPaymentAmount,
&inPaymentInteger, &outToInterest, &outToPrincipal, &outBalance);
Asin
Returns angle in radians (-pi/2 to pi/2) with speciIied sine
value (-1.0 to 1.0) &radiansAsin(&sine);
Atan
Returns angle in radians (-pi/2 to pi/2) with speciIied
tangent number &radiansAtan(&tangent);
BlackScholesCall Returns a number vaguely based on the numbers supplied
&equityCallBlackScholesCall(&AssetPrice, &StrikePrice,
&NoRiskInterestRate, &YearsToExpire, &Volatility);
BlackScholesPut Black Scholes Iinancial calculation.
&equityCallBlackScholesPut(&AssetPrice, &StrikePrice,
&NoRiskInterestRate, &YearsToExpire, &Volatility);
BootstrapYTMs Does this make sense to anyone out there?
&arrayOINumberArraysBootstrapYTMs(&TradingDate,
&MarketInstrumentArrayOINumberArrays, &AccrualConvention);
Break Terminate loop or evaluate execution Break;
BulkDeleteField
For PeopleSoIt Adminstrator: Deletes FieldName Irom
designed Pages and Records in ProjectName but not in
ExcludeProjectName
&errorIntegerBulkDeleteField(&ProjectName, FieldName |,
ExcludeProjectName| );
BulkInsertField
For PeopleSoIt Adminstrator: Insert Field into all records
and pages in ProjectName (but not in ExcludeProjectName)
that contain ModelFieldName
&errorIntegerBulkInsertField(&ProjectName, FIELD.FieldName,
&ModelName, &IsClonePCode, |, &ExcludeProjectName| );
BulkModiIyPageFieldOr
der
For PeopleSoIt Adminstrator: Reorder Fields in all records
and pages in ProjectName (or PageNameArray) into
FieldNamesArray order
&errorIntegerBulkModiIyPageFieldOrder(&ProjectName,
&FieldNamesArray, &IsAllFieldsRequired, |&GridWidthsArray|);
BulkUpdateIndexes
For PeopleSoIt Adminstrator: Updates index deIinitions Ior
records that have the NotUsed setting changed. &errorIntegerBulkUpdateIndexes( |&FieldNameArray| );
CallAppEngine
Calls Application Engine Irom online or App Engine
PeopleCode. State records can be either objects or record
names.
CallAppEngine(&AppEngineName | , &StateRecord1... ,
&ProcessInstanceInteger | );
CancelPubHeaderXmlD
oc
Cancels a New, Error, Retry, Timeout, Edited message
header/instance (beIore transIormation)
&isOKCancelPubHeaderXmlDoc(&PublishID, &PublishNodeName,
&ChannelName, &VersionName);
CancelPubXmlDoc
Cancels a New, Error, Retry, Timeout, Edited message
publication contract (aIter transIormation)
&isOKCancelPubXmlDoc(&PublishID, &PublishNodeName,
&ChannelName, &VersionName, &MessageName,
&SubscribeNodeName);
CancelSubXmlDoc
Cancels a New, Error, Retry, Timeout, Edited message
subsription contract
&isOKCancelSubXmlDoc(&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;
ChDir Changes current directory. Deprecated as oI version 8. ChDir(&Path);
ChDrive
Changes drive (MS-DOS). &drive is a letter Iollowed by a
colon. Deprecated as oI version 8. ChDrive(&Drive);
Page 1
Sheet1
ChangeEmailAddress
Changes email address oI type &EmailTypeName Ior current
user ChangeEmailAddress(&EmailTypeName, &EmailAddress);
CharType
Returns 1 (yes), 0 (no), -1 (unknown) whether 1st character
oI string in character group given by number
&CharSetNumber &returnIntegerCharType(&String, &CharSetNumber);
Char
Returns the UniCode character with the given number (0-
65,535) &UnicodeCharacterchar(&Integer);
CheckMenuItem
Puts a check by the menu name on Windows client.
Deprecated Ior versions with no Windows client. CheckMenuItem(BARNAME.menuBar, ITEMNAME.menuItem);
Clean Returns &dodgyString without any non-printable characters &cleanStringClean(&DodgyString);
ClearKeyList Clears current key list Ior navigation |&isOK| ClearKeyList();
ClearSearchDeIault
Removes deIault processing Ior speciIied Iield. SearchInit
only. Use Field.SearchDeIault now. |&isOK| ClearSearchDeIault( |recordname.|Iieldname);
ClearSearchEdit
Stops record Iield edit properties being used in search
dialogue Ior Iield. Use Field.SearchEdit now |&isOK| ClearSearchEdit( |recordname.|Iieldname);
Code
Returns Unicode UTF-16 value (0-65,535) oI Iirst
character/high surrogate in &String &numberCode(&String);
Codeb No longer supported - Ptools 8.46 &numberCodeb(&String);
CollectGarbage Cleans memory oI unreIerencable Application objects. CollectGarbage();
CommitWork
Explicitly commits to the database. Available in FCh, SPr,
Message Subscription and AE PC |&isOK| CommitWork();
CompareLikeFields
Returns true iI all similarly named Iields have the same
value in both To and From, else Ialse
&isLikeFieldsSameCompareLikeFields(&FromLevel, &FromScrollPath,
&FromRow, &ToLevel, &ToScrollPath, &ToRow);
ComponentChanged
Returns true iI the component data has changed since the
last save. &isChangedComponentChanged();
Component Declares variables with scope Ior the component liIetime Component datatype &declaration;
ConnectorRequestURL Returns URL directly Irom the gateway &URLStringConnectorRequestURL(&ConnectorStringURL);
ConnectorRequest
Sends message to connector assigned by properties oI the
message &unstructuredMessageConnectorRequest(&Message);
ContainsCharType
Returns 1 (yes), 0 (no), -1 (unknown) whether any character
oI string in character group given by number
&CharSetNumber &returnIntegerContainsCharType(&String, &CharSetNumber);
ContainsOnlyCharType
Returns 1 (yes), 0 (no), -1 (unknown) whether all string only
character groups given by numbers &CharSetNumber1
&returnIntegerContainsOnlyCharType(&String, &CharSetNumber1 |,
&CharSetNumber2 ...|);
Continue In loops, skips processing to next iteration oI 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
&returnIntegerConvertChar(&inString, &inCharCategoryNumber,
&outString, &TargetCharSetNumber);
ConvertCurrency
Converts currency, no exchange rate - uses 1 returns Ialse,
inErrorProcess (F/W/I) determines iI user told
&isOKConvertCurrency(&inFromAmount, &inFromCurrencyCd,
&inToCurrencyCd, &inRateType, &inEIIdt, &outToAmount |,
&inErrorProcess |, &isRounded| |, &inRateIndex||);
ConvertDatetimeToBase
Converts to PSOPTIONS base time zone FromTimeZone or
Local or Base
&dateTimeConvertDatetimeToBase(&FromDateTimeString,
&FromTimeZone);
ConvertRate
Returns rate converted by Irequency 0 continuous, 1 daily, 2
monthly, 3 yearly
&toRateConvertRate(&IromRate, &IromFrequencyNumber,
&toFrequencyNumber);
ConvertTimeToBase
Converts to PSOPTIONS base time zone FromTimeZone or
Local or Base &timeConvertTimeToBase(&FromTimeString, &FromTimeZone);
CopyAttachments
Copies Iiles Irom one system to another, returns 0 on
success, non zero error.
&returnIntegerCopyAttachments(&IromURL, &toURL |,
&RecordNamesArray |, &isCasePreserved||);
CopyFields
Copies like named Iields Irom FromRow to ToRow in the
page buIIer
|&isOK| CopyFields(&FromLevel, &FromScrollPath, &FromRow,
&ToLevel, &ToScrollPath, &ToRow);
CopyFromJavaArray
Copies Java array to a PeopleCode Array, optionally
conIined to elements numbered in Iinal 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 conIined
to elements numbered in Iinal array parameter
CopyToJavaArray(&PeopleCodeArray, &JavaArrayName |,
&ElementNumberArray|);
Cos
Returns cosine (-1.0 to 1.0) oI angle in radians (normally 0
to pi) &cosineCos(&radians);
Cot Returns cotangent oI angle in radians (0 causes error) &cotangentCot(&radians);
CreateArrayAny
Returns reIerence to array created Irom elements elements
can be oI ANY type &anyArrayCreateArrayAny(|&element1 |, &element2 |...|);
CreateArrayRept
Returns reIerence to array (same type as Element) with
Element repeated Ior NumberOIElements &arrayCreateArrayRept(&Element, &NumberOIElements);
CreateArray
Returns reIerence to array created Irom elements - no
elements, empty array oI ANY created &arrayCreateArray(|&element1 |, &element2 |...|);
CreateDirectory
Creates directory speciIied by Path and PathType
(FilePathAbsolute/FilePathRelative) CreateDirectory(&Path |, &PathTypeConst|);
CreateException
Returns reIerence to new exception created Irom message
catalog substituting &Value1 Ior 1 etc.
&exceptionCreateException(&MessageSetNumber, &MessageNumber,
&DeIaultString |, &Value1 |, &Value2 |...| );
CreateJavaArray Returns reIerence to Java array
&javaObjectArrayCreateJavaArray(&ElementClassName||,
&NumberOIElements);
CreateJavaObject Returns reIerence to Java object
&javaObjectCreateJavaObject(&ClassName |, &ConstructorParameter1 |,
&ConstructorParameter2|... |);
CreateMCFIMInIo
Returns reIerence to new MCFIMInIo class instance Ior
Network (AOL/Yahoo) &mcIimInIoObjectCreateMCFIMInIo(&OprID, &Provider);
Page 2
Sheet1
CreateMessage Returns reIerence to new instance oI message MessageName &messageCreateMessage(MESSAGE.MessageName);
CreateObjectArray
Returns reIerence to new object but parameters to create
object not known at design time &objectCreateObjectArray(&ClassName, &ArgumentArray);
CreateObject
Returns reIerence to new object (OLE Automation or
Application Class) &objectCreateObject(&ClassName);
CreateProcessRequest
Returns reIerence to new process request, blank or set up.
Use &processRequest.Schedule(); aIter
&processRequestCreateProcessRequest( |&ProcessTypeString,
&ProcessName| );
CreateRecord Returns reIerence to new standalone record object &recordCreateRecord( RECORD.RecordName , &RecordRecName });
CreateRowsetCache
Returns reIerence to new RowSetCache object iI one does not
already exist with that name
&rowsetCacheCreateRowsetCache(&rowset, |ROWSET.|Name,
Description);
CreateRowset
Returns reIerence to new standalone rowset. Can be
populated by &rowset.Fill method.
&rowsetCreateRowset( RECORD.RecordName , &inRowset1} |,
Field.FieldName, RECORD.RecordName , &inRowset2 } | ... );
CreateSOAPDoc Returns reIerence to new SQL object &soapDocCreateSOAPDoc();
CreateSQL Returns reIerence to new SOAPDoc object &sqlCreateSQL( | &SQLString , SQL.SQLName} |, &bindVar1| ... | );
CreateWSDLMessage
Returns true iI channel and unstructured message created,
use GetMessage/GetMessageXmlDoc to see message &isOKCreateWDSLMessage(&MessageName, &ChannelName);
CreateXmlDoc
Returns reIerence to new XML Doc object. XML String can
be blank. &xmlDocCreateXmlDoc(&xmlString);
CubicSpline Returns a cubic spline Ior set oI at least 4 data points???
&numberArrayCubicSpline(&ArrayOIArraysOI6Numbers,
&ControlNumber, &LeItPointConstraint, &RightPointConstraint);
CurrEIIDt
Returns current eIIective Date value oI scroll level speciIied
(current iI no parameter). Use &rowset.EIIdt now. &currentEIIDtCurrEIIDt( |&LevelNumber| );
CurrEIIRowNum
Returns current row number oI scroll level speciIied (current
iI no parameter). Use &row.RowNumber now. &rowNumberCurrEIIRowNum( |&LevelNumber| );
CurrEIISeq
Returns current eIIective sequence number oI scroll level
speciIied (current iI no parameter). Use &rowset.EIISeq
now. &rowNumberCurrEIISeq( |&LevelNumber| );
CurrentLevelNumber Returns current scroll level number or zero iI not in a scroll &levelNumberCurrentLevelNumber();
CurrentRowNumber
Returns current row number on this or higher level. Use
&row.RowNumer now. &rowNumberCurrentRowNumber( |&LevelNumber| );
DBCSTrim
Deprecated. Returns string without a lead byte at end oI
string &stringDBCSTrim(&string);
DBPatternMatch
Determines iI pattern Iound in string - using SQL
wildcards (any characters) (any single characters), \,
\ escaped wildcards. &isMatchDBPatternMatch(&string, &pattern, &isCaseSensitive);
Date3
Returns date object with value speciIied in years, months
days. &dateDate3(&YYYYnumber, &MMnumber, &DDnumber);
DatePart Returns date part oI a DateTime value &dateDatePart(&dateTime);
DateTime6 Returns DateTime value with value derived Irom numbers.
&dateTimeDateTime6(&YYYYnumber, &MMnumber, &DDnumber,
&HH24number, &MINnumber, &SSnumber);
DateTimeToHTTP
Returns string representing DateTime in HTTP Iormat
example Mon, 03 Sep 2007 09:00:00 GMT &dateTimeStringDateTimeToHTTP(&DateTime);
DateTimeToLocalizedSt
ring
Returns string representing DateTime (or just date) in
speciIied Iormat string. &dateTimeStringDateTimeToLocalizedString(&DateTime |, &Iormat | );
DateTimeToTimeZone
Returns IromDateTime converted by time zone speciIied by
3 character string e.g. EST or Local or Base
&dateTimeDateTimeToTimeZone(&IromDateTime, &IromTimeZone,
&toTimeZone);
DateTimeValue
Returns DateTime with value oI string - in Iormat -
DD/MM/YY|YY| hh24:mi:ss.ssssss |AM , PM}| &dateTimeDateTimeValue(&dateTimeString);
DateValue
Returns Date with value oI string - in Iormat determined by
personalised date settings &dateDateValue(&dateString);
Date
Returns date object with value speciIied by number in
YYYYMMDD Iormat &dateDate(&YYYYMMDDnumber);
Day Returns day number (1-31) oI date &dayNumberDay(&date);
Days360
Returns number oI days between 2 dates iI using the 360 day
calendar (12 months x 30 days) &numberOIDaysDays360(&IromDate,&toDate);
Days365
Returns number oI days between 2 dates iI using the 365 day
calendar &numberOIDaysDays365(&IromDate,&toDate);
Days Returns the Julian date as a number &julianDayNumberDays(&date);
DeQueue
Removes completed task Irom MCF queue, returns 0 iI
successIul, else message number Irom set 162.
&errorCodeDeQueue(&PhysicalQueueID, &TaskType, &TaskNumber,
&AgentID);
Declare Function
Declares PeopleCode or external Iunction Ior use in the
PeopleCode program
DECLARE FUNCTION IunctionName LIBRARY libName |ALIAS
ModuleName | |parameter1, |REF , VALUE| |... |RETURNS ReturnType
|AS PeopleCodeType||
Decrypt Decrypts encryptedString iI used Encrypt &plainTextDecrypt(&keyString, &encryptedString);
Degrees Returns angle in degrees Irom radians &degreesDegrees(&radians);
DeleteAttachment Deletes speciIied attachment, returns 0 iI successIul.
&errorCodeDeleteAttachment(&IromURL,
&DestinationAppendedPathFilename |, &PreserveCaseBoolean|);
DeleteEmailAddress
Deletes email address oI type (BB , BUS , HOME , OTH ,
WORK) DeleteEmailAddress(&EmailTypeString);
DeleteImage Deletes speciIied image
&isOKDeleteImage( |SCROLL.RecordNameLevel1, RowNumberLevel1,
|... SCROLL.RecordName, &RowNumber, |RecordName.|FieldName);
Page 3
Sheet1
DeleteRecord
Deletes level zero row Irom 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 Iire, renumbers
rows aIter delete done. Use &RowSet.DeleteRow now.
|&isOK| DeleteRow(|RECORD.RecordNameLevel1, &rowNumberLevel1
|,RECORD.RecordNameLevel2, &rowNumberLevel2||, &rowNumber );
DeleteSQL
Deletes an Application Designer SQL deIinition. DBType is
APPSRV, DB2ODBC, DB2UNIX, INFORMIX,
MICROSFT, ORACLE, SYBASE - deIaults to DbName &isOKDeleteSQL(|SQL.|SQLName |, &dbType |, &EIIectiveDate||);
DeleteSystemPauseTime
s Deletes speciIied system pause time
&isOKDeleteSystemPauseTimes(&BeginWeekDayNumber,
&BeginTimeSeconds, &EndWeekDayNumber, &EndTimeSeconds);
DetachAttachment Copies Iile attachment Irom server to browsing system
&errorCodeDetachAttachment(&FromURL,
&FromAppendedPathFilename, &SuggestedFileExtension, &ToFile |,
&PreserveCaseBoolean|);
DisableMenuItem
Disables (pop up) menu item name. Ignored by Component
InterIace. 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();
DoModalComponent
Displays secondary component in action mode
A/U/L(Upddisp all)/C/E (Data Entry)/P (Prompt), returns 1
(OK) or 0 (cancelled)
&OKCancelDoModalComponent(MENU.MenuName,
BARNAME.BarName, ITEMNAME.ItemName,
PAGE.LandingPageName, &Action, &RECORD.SharedRecordName |,
RecordName.Field |... );
DoModalPanelGroup
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.
&OKCancelDoModalPanelGoup(MENU.MenuName,
BARNAME.BarName, ITEMNAME.ItemName,
PANEL.LandingPageName, &Action, &RECORD.SharedRecordName);
DoModal Displays secondary page, returns 1 (OK) or 0 (cancelled)
&OKCancelDoModal(PAGE.PageName, &WindowTitle, &xPosition,
&yPosition |, &LevelNumber, |RECORD.RecordNameLevel1,
RowNumberLevel1|..., &RowNumber|);
DoSaveNow
Saves immediately, executing the save PeopleCode. UseIul iI
calling a remote call program that accesses the page data
direct. DoSaveNow();
DoSave
Saves at end oI current PeopleCode event, executes
PeopleCode associated with save. Only usable in FEd, FCh,
MenuItemSelected. DoSave();
Else Executes statements depending on condition II conditions Then |statements| |Else |statements|| End-II;
EnQueue
Adds task to MCF queue, returns 0 iI successIul, else
message number Irom set 162.
&errorCodeEnQueue(&PhysicalQueueID, &TaskType,
&LaunchPageURL, &LanguageCode |, &Subject |, &AgentID |,
&MinsToOverIlow |, &MinsToEscalation |, &CostNumber |,
&PriorityNumber |, &MinSkillNumber|--|);
EnableMenuItem
Enables a (PopUp) menu item Ior selection. For pop up
menu place in PrePopUp oI Iield. EnableMenuItem(BARNAME.BarName, ITEMNAME.ItemName);
EncodeURLForQueryStr
ing
Returns a string encoded according to the W3C encoding
rules. Does not encode ()*-. &encodedStringEncodeURLForQuery(&URLString);
EncodeURL
Returns a string encoded according to the W3C encoding
rules. Does not encode !#$&()*,-./:;? &encodedStringEncodeURL(&URLString);
EncryptNodePswd Returns an encrypted Integration Broker node password &encryptedNodePasswordEncryptNodePswd(&PlainText);
Encrypt Returns an encrypted string &encryptedStringEncrypt(&KeyString, &PlainText);
End-Evaluate Evaluate branches depending on conditions on Value Evaluate &Value When ... End-evaluate
End-For Ends Ior loop End-For;
End-Function Ends Iunction deIinition End-Function
End-II Executes statements depending on condition II conditions Then |statements| |Else |statements|| End-II;
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 oI
commit only in SPo. Use MessageBox now. EndMessage(&Message, &MessageTitle);
EndModalComponent
Closes current modal secondary component (not in CI),
&OKNumber0 - no values returned to main page, ~1 -
values returned EndModalComponent(&OKNumber):
EndModal
Closes current modal secondary page (not in CI),
&OKNumber0 - no values returned to main page, ~1 -
values returned EndModal(&OKNumber):
Error
FEd, SEd, RDe: Displays error message and stops
PeopleCode and save; RSe: Make current row the last to be
added to buIIer Error &ErrorMessage;
EscapeHTML
Returns text with HTML characters escaped (e.g. becomes
) &escapedTextEscapeHTML(&Text);
EscapeJavascriptString Returns text Ior use in JavaScript - changes ' " NL CR \\ &escapedTextEscapeJavascriptString(&Text);
EscapeWML Returns text Ior use in WML - changes ' " ~$& &escapedTextEscapeWML(&Text);
Evaluate Evaluate branches depending on conditions on Value Evaluate &Value When ... End-evaluate
Exact Returns true iI strings exactly match &isSameExact(&String1, &String2);
Exec(2)
Starts operating system command and waits to return the
process exit code
&exitNumberExec(&CommandString,
ExecSynchronousFilePathAbsolute);
Exec Starts operating system command and returns process ID &processNumberExec(&CommandString, &isSynchronous);
ExecuteRolePeopleCode Returns array oI users currently in the Dynamic Role. &userIDArrayExecuteRolePeopleCode(&DynamicRoleName);
Page 4
Sheet1
ExecuteRoleQuery
Returns array oI users currently in the Query Role using the
bind string parameters
&userIDArrayExecuteRoleQuery(&QueryRoleName, &BindString1 |,
BindString2|... );
ExecuteRoleWorkIlowQ
uery
Returns array oI users currently in the WorkIlow Query Role
using the bind string parameters
&userIDArrayExecuteRoleWorkIlowQuery(&WorkIlowQueryRoleName,
&BindString1 |, BindString2|... );
Exit
Immediately leave PeopleCode program, iI &number is 1
then rollback. Exit | (&number) | ;
Exp Returns e (2.7182818?) to the power oI Natural Logarithm &numberExp(&NaturalLogarithm);
ExpandBindVar
Returns string replacing :RecordName.FieldName with
appropriate values &expandedStringExpandBindVar(&string);
ExpandEnvVar
Returns string replacing operating system environment
variable names with their values &expandedStringExpandEnvVar(&string);
ExpandSqlBinds
Returns string replacing :1... with values Irom the
BindValue list &expandedStringExpandSQLBinds(&string |, &bindValue1|... );
Fact Returns Iactorial oI truncated Number (1 x 2 x ? x Number) &IactorialFact(&Number);
FetchSQL
Returns Application Designer SQL string with name
according to DBType is APPSRV, DB2ODBC, DB2UNIX,
INFORMIX, MICROSFT, ORACLE, SYBASE - deIaults
to DbName &sqlFetchSQL( |SQL.|SQLName |, &DBType |, &EIIectiveDate| | );
FetchValue
Returns value Irom buIIer Iields (outside current context).
Use &Field.Value now.
&valueFetchValue( |RECORD.RecordName1, &RowLevel1 , |
RECORD.RecordName2, &RowLevel2, |... &TargetRowNumber,
|RecordName.|FieldName);
FieldChanged
Returns iI Iield has been changed Irom database by
PeopleCode or user
&isChangedFieldChange( ||RECORD.RecordName1, &RowLevel1 , |
RECORD.RecordName2, &RowLevel2, |...&TargetRowNumber,
|RecordName.|FieldName);
FileExists
Returns iI Iile exists (on Server). File Path Type is
either FilePathRelative or FilePathAbsolute &isThereFileExists(&FileNameString, &FilePathType);
FindCodeSetValues
Returns list oI code set name-pair values as part oI data
value translations in Integration Broker
&nameValuePairArrayFindCodeSetValues(&CodeSetName,
&inNameValuePairArray, &FromNodeName, &ToNodeName);
FindFiles
Returns list oI Iiles conIorming to FileNamePattern (using *
and ?). File Path Type is either FilePathRelative
(searches PSFILEDIR and PSSERVDIR)
or FilePathAbsolute &FileNameArrayFindFiles(&FileNamePattern | , &PathType|);
Find
Returns position oI leIt most SubString in Text (0 iI not
Iound), starting at StartPosition &positionNumberFind(&SubString, &Text |, &StartPosition|);
Findb
DEPRECATED. Returns position oI leIt most SubString
(bytes) in Text (0 iI not Iound), starting at StartPosition &positionNumberFindb(&SubString, &Text |, &StartPosition|);
FlushBulkInserts
Moves bulk inserted rows held in buIIer to database, Inserts
but does not Commit. FlushBulkInserts();
For For loop ended with end-Ior Ior index &number1 to number2 |step &increment|;
FormatDateTime
Returns Iormatted DateTime converted to time zone
speciIied by 3 character string e.g. EST or Local or Base
&dateStringFormatDateTime(&DateTime, &TimeZone,
&isWithTimeZone);
Forward
TransIers MCF task Irom one queue/agent to another,
returns 0 iI successIul, else message number Irom set 162.
&errorCodeForward(&FromPhysicalQueueID, &FromAgentID,
&TaskNumber, &TaskType, &ToLogicalQueueID |, &ToAgentID|);
Function Starts Iunction deIinition
Function FunctionName | ( &parameter1 |As DataType1|}...) | | Returns
DataType |
GenerateActGuideConte
ntUrl Returns Activity Guide content URL
&URLStringGenerateActGuideContentURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, &Market,
COMPONENT.ComponentName, &ActivityGuide);
GenerateActGuidePortal
Url Returns Activity Guide portal URL
&URLStringGenerateActGuidePortalURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, &Market,
COMPONENT.ComponentName, &ActivityGuide);
GenerateActGuideRelati
veUrl Returns Activity Guide relative URL
&URLStringGenerateActGuideRelativeURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, &Market,
COMPONENT.ComponentName, &ActivityGuide);
GenerateComponentCon
tentRelURL Returns Component Content relative URL
&URLStringGenerateComponentContentRelURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, MARKET.MarketName,
COMPONENT.ComponentName, PAGE.PageName, &Action |,
&KeyRecord1 |...);
GenerateComponentCon
tentURL Returns Component Content absolute URL
&URLStringGenerateComponentContentURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, MARKET.MarketName,
COMPONENT.ComponentName, PAGE.PageName, &Action |,
&KeyRecord1 |...);
GenerateComponentPort
alRelURL Returns Component Portal relative URL
&URLStringGenerateComponentPortalRelURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, MARKET.MarketName,
COMPONENT.ComponentName, PAGE.PageName, &Action |,
&KeyRecord1 |...);
GenerateComponentPort
alURL Returns Component Portal absolute URL
&URLStringGenerateComponentPortalURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, MARKET.MarketName,
COMPONENT.ComponentName, PAGE.PageName, &Action |,
&KeyRecord1 |...);
GenerateComponentRel
ativeURL Returns Component relative URL
&URLStringGenerateComponentRelativeURL(PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, MARKET.MarketName,
COMPONENT.ComponentName, PAGE.PageName, &Action |,
&KeyRecord1 |...);
GenerateExternalPortal
URL Returns URL oI external content on the portal servlet
&URLStringGenerateExternalPortalURL(PORTAL.PortalName,
NODE.NodeName, &URLString);
Page 5
Sheet1
GenerateExternalRelativ
eURL
Returns relative URL oI external content on the portal
servlet
&URLStringGenerateExternalRelativeURL(PORTAL.PortalName,
NODE.NodeName, &EncodedURLString);
GenerateHomepagePorta
lURL
Returns URL oI speciIied Tab (or deIault iI "") on the
HomePage
&URLStringGenerateHomepagePortalURL(PORTAL.PortalName,
NODE.NodeName, &TabName);
GenerateHomepageRelat
iveURL
Returns relative URL oI speciIied Tab (or deIault iI "") on
the HomePage
&URLStringGenerateHomepageRelativeURL(PORTAL.PortalName,
NODE.NodeName, &TabName);
GenerateMobileTree Returns HTML oI a tree representing a populated CI &treeHTMLGenerateMobileTree(&CI |,&CIProperty | );
GenerateQueryContentU
RL Returns content URL oI speciIied quey
&URLStringGenerateQueryContentURL(PORTAL.PortalName,
NODE.NodeName, &QueryName, &isPublicQuery |, &isInNewWindow| );
GenerateQueryPortalUR
L Returns portal URL oI speciIied quey
&URLStringGenerateQueryPortalURL(PORTAL.PortalName,
NODE.NodeName, &QueryName, &isPublicQuery |, &isInNewWindow| );
GenerateQueryRelativeU
RL Returns relative URL oI speciIied quey
&URLStringGenerateQueryRelativeURL(PORTAL.PortalName,
NODE.NodeName, &QueryName, &isPublicQuery |, &isInNewWindow| );
GenerateScriptContentR
elURL Returns relative URL to speciIied iScript.
&URLStringGenerateScriptContentRelURL(PORTAL.PortalName,
NODE.NodeName, RECORD.RecordName, Field.FieldName,
&iScriptEventName, &iScriptFunctionName |, &Field1|... );
GenerateScriptContentU
RL Returns content URL to speciIied iScript.
&URLStringGenerateScriptContentURL(PORTAL.PortalName,
NODE.NodeName, RECORD.RecordName, Field.FieldName,
&iScriptEventName, &iScriptFunctionName |, &Field1|... );
GenerateScriptPortalRel
URL Returns relative portal URL to speciIied iScript.
&URLStringGenerateScriptPortalRelURL(PORTAL.PortalName,
NODE.NodeName, RECORD.RecordName, Field.FieldName,
&iScriptEventName, &iScriptFunctionName |, &Field1|... );
GenerateScriptPortalUR
L Returns portal URL to speciIied iScript.
&URLStringGenerateScriptPortalRelURL(PORTAL.PortalName,
NODE.NodeName, RECORD.RecordName, Field.FieldName,
&iScriptEventName, &iScriptFunctionName |, &Field1|... );
GenerateScriptRelativeU
RL Returns relative URL to speciIied iScript.
&URLStringGenerateScriptPortalRelURL(PORTAL.PortalName,
NODE.NodeName, RECORD.RecordName, Field.FieldName,
&iScriptEventName, &iScriptFunctionName |, &Field1|... );
GenerateTree Returns HTML oI a tree representing the speciIied rowset &treeHTMLGenerateTree(&RowSet |,TreeEventFieldName | );
GenerateWorklistPortal
URL Returns portal URL to speciIied worklist.
&URLStringGenerateWorklistPortalURL(PORTAL.PortalName,
NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist,
&Instance);
GenerateWorklistRelativ
eURL Returns relative URL to speciIied worklist.
&URLStringGenerateWorklistRelativeURL(PORTAL.PortalName,
NODE.NodeName, &BusinessProcess, &Activity, &Event, &Worklist,
&Instance);
GetAESection
Returns AE section object with base section, iI Section does
not exist, then it is created. &AESectionGetAESection(&ApplicationID, &SectionName |, &EIIDt | );
GetArchPubHeaderXml
Doc Returns reIerence to archived message header Irom queue
&xmlDocumentGetArchPubHeaderXmlDoc(&MessagePubID,
&PublishNode, &ChannelName, &VersionName);
GetArchPubXmlDoc Returns reIerence to archived message Irom queue
&xmlDocumentGetArchPubXmlDoc(&MessagePubID, &PublishNode,
&ChannelName, &VersionName);
GetArchSubXmlDoc Returns reIerence to archived message Irom queue
&xmlDocumentGetArchSubXmlDoc(&MessagePubID, &PublishNode,
&ChannelName, &VersionName);
GetAttachment
Copies Iile Irom FTP server to Application Server. Return 0
Ior success, 1 Ior Iailure.
&errorCodeGetAttachment(&FromURL, &FromAppendedPathFilename,
&ToFile |, &ToDirEnvironmentVariable |, &PreserveCaseBoolean||);
GetBiDoc
Creates a BiDocs structure populated with the XML String
(this string can be empty) &biDocObjectGetBiDoc(&XmlString);
GetCalendarDate
Returns date Irom
PSPAYCALENDAR.CalendarFieldName /- Periods /-
PeriodEndAdjustment (iI period end) Irom InDate.
&dateGetCalendarDate(&InDate, &NumOIPeriods,
&PeriodEndAdjustmentNumber, &CalendarFieldName, &Company,
&PayGroup);
GetChartURL Returns the URL String oI the speciIied Chart object &URLStringGetChartURL(&Chart);
GetChart
Returns a reIerence to the chart object associated with the
Record.Field in PeopleSoIt Application Designer &chartObjectGetChart(RecordName.FieldName);
GetCwd
Returns a string oI the current working directory (on the
server) &pathStringGetCwd();
GetEnv
Returns value oI the server environment variable (without $
or signs) &variableValueGetEnv(&VariableName);
GetField
Returns reIerence to the Iield object speciIied (or current one
iI none speciIied) &IieldGetField(|RecordName.FieldName|);
GetFile
Returns a File object associated with the Iile named
(with FilePathRelative,FilePathAbsolute as PathType)
and opens it in the &OpenMode (R,W,U,E,N)
&IileGetFile(&FileName, &OpenMode |, &CharacterSetName| |,
&PathType|);
GetGrid Returns a reIerence to a grid object Irom page speciIied &gridGetGrid(Page.PageName, &GridName |, &OccursNumber|);
GetHTMLText
Returns a string containing the text oI an HTML object with
param1 etc. substituted Ior each oI the BIND(:1) variables. &HTMLstringGetHTMLText(HTML.HTMLName |, &param1...|);
GetImageExtents
Returns an array: arrayImageSize(1)image height and
arrayImageSize(2)image width &arrayImageSizeGetImageExtents(IMAGE.ImageName);
GetInterlink Returns a BI object based on named App Designer BI object. &businessInterlinkGetInterlink(Interlink.BIName);
GetJavaClass
Returns a reIerence to a Java class - used to get access to
static methods on Java classes &reIJavaClassGetJavaClass(&JavaClassName);
Page 6
Sheet1
GetLevel0
Returns the rowset at level 0 oI the page/state
record/message base rowset &rowsetGetLevel0();
GetMessageInstance DEPRECATED. Returns a message Irom the message queue
&messageGetMessageInstance(&PublishId, &PublishNodeName,
&ChannelName);
GetMessageXmlDoc
Returns reIerence to XML doc Irom async message queue or
sync Irom memory &xmlDocGetMessageXmlDoc();
GetMessage
Returns a message Irom the current message queue being
processed without data &emptyMessageGetMessage();
GetMethodNames
Returns array oI method names Ior ObjectName oI speciIied
Type ("WebLib" , "CompIntIc") &arrayMethodNamesGetMethodNames(&TypeString, &ObjectName);
GetNRXmlDoc
Returns XML message Ior NonRepudiationId Ior the signer
EntityName (Ior PS this is NodeName) &xmlDocGetNRXmlDoc(&NonRepudiationId, &EntityName);
GetNextNumberWithGa
psCommit
Returns highest value in Field (subject to WhereClause) plus
Step or negative iI error. Commits immediately via second
database connection.
&numberGetNextNumberWithGapsCommit(Record.Field, &MaxNumber,
&Step, |&WhereClause |, &Param1...| |);
GetNextNumberWithGa
ps
DEPRECATED. SPr, WFl only. Returns highest value in
Field (subject to WhereClause) plus Step. Use
GetNextNumberWithGapsCommit
&numberGetNextNumberWithGaps(Record.Field, &MaxNumber, &Step,
|&WhereClause |, &Param1...| |);
GetNextNumber
Spo only: Returns 1 higher than the maximum value in
named Iield or negative iI error e.g. higher than MaxNumber
(Highest possible: 2,147,483,647)
&numberGetNextNumber(Record.Field , &RecordName, &FieldName} ,
&MaxNumber);
GetNextProcessInstance
Retreives next available process instance and commits,
unless WillCommit is set to 0. &returnNumberGetNextProcessInstance(|&WillCommit|);
GetPage
Returns reIerence to the speciIied page object. Page must
have been loaded - PostBuild or Activate. &pageGetPage(PAGE.PageName);
GetPubContractInstance DEPRECATED. Use GetPubXmlDoc.
&contractInstanceGetPubContractInstance(&PublishId,
&PublishNodeName, &ChannelName, &SubscribeNodeName);
GetPubHeaderXmlDoc
Returns XML message beIore transIormation (the header)
Ior speciIied message. Use in error processing.
&xmlDocGetPubHeaderXmlDoc(&PublishId, &PublishNodeName,
&ChannelName, &VersionName);
GetPubXmlDoc
Returns XML message aIter transIormation Ior speciIied
message. Use in error processing.
&xmlDocGetPubXmlDoc(&PublishId, &PublishNodeName,
&ChannelName, &VersionName);
GetRecord
Returns reIerence to record in current buIIer. DeIault record
is the record PeopleCode is on. &recordGetRecord( |RECORD.RecordName , &RecordRecName }| );
GetRelField
DEPRECATED. Returns related value displayed. Use
&Field.GetRelated. &relatedValueGetRelField(&ControlField, &RelatedField);
GetRow Returns reIerence to current row. &rowGetRow();
GetRowsetCache
Returns a rowset cache object populated with the rowset
cache indicated &rowsetCacheGetRowsetCache(&rowset, |ROWSET.|Name);
GetRowset Returns reIerence to rowset in current context. &rowsetGetRowset(|SCROLL.ScrollName|);
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 oI any. &sqlGetSQL(SQL.SqlName |, param1|...);
GetSelectedTreeNode DEPRECATED. Use GenerateTree GetSelectedTreeNode(RECORD.RecordName);
GetSession
Returns PeopleSoIt Session object - you need to connect too.
See Session &sessionGetSession();
GetSetId
Returns set ID name Ior these parameters. Leave TreeName
blank iI not required.
&setidGetSetId(&FieldName, &SetControlValue, &RecordName,
&TreeName);
GetStoredFormat
Returns the stored custom Iormat name Ior the speciIied
Iield.
&storedFormatNameGetStoredFormat(|RECORD.Level1RecordName,
&Level1Row, |RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber,
|RecordName.|FieldName);
GetSubContractInstance DEPRECATED. Use GetSubXmlDoc
GetSubContractInstance(pubid, pubnodename, channelname,
messagename, subname)
GetSubXmlDoc
Returns a reIerence to XML Doc messge Irom message
queue. Use Ior error processing or debugging.
&xmlDocGetSubXmlDoc(&PublishId, &PublishNodeName,
&ChannelName, &VersionName, &MessageName);
GetSyncLogData
Returns XML string oI synchronised message log oI Log
Type (1 original request, 2 transIormed request, 3 original
response, 4 transIormed response)
&xmlLogStringGetSyncLogData(&GUID, &PublishNodeName,
&ChannelName, &MessageName, &LogTypeNumber, &VersionName);
GetTreeNodeParent DEPRECATED. Use GenerateTree GetTreeNodeParent(&Node);
GetTreeNodeRecordNa
me DEPRECATED. Use GenerateTree GetTreeNodeRecordName(&Node);
GetTreeNodeValue DEPRECATED. Use GenerateTree GetTreeNodeValue(&Node |, RecordName.|FieldName);
GetURL
Returns the URL String oI the speciIied URLName in the
users language. Maintained under PeopleTools Utilities &urlStringGetURL(URL.URLName);
GetUserOption Returns the deIault value Ior the option and level. &valueGetUserOption(&OptionCategoryLevelString,&OptionName);
GetWLFieldValue
Returns the value oI the Iield in the application worklist.
Check iI called Irom worklist using WLName system
variable. &valueGetWLFieldValue(&FieldName);
Global
Creates a global PeopleCode variable that is constant Ior that
session Global DataType &variable
GrayMenuItem DEPRECATED. Use DisableMenuItem |&isOK|GrayMenuItem(BARNAME.BarName, ITEMNAME.ItemName);
Gray Switches the Iield to not be changeable on the page.
|&isOK|Gray(||RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber,
|RecordName.||FieldName);
Hash
Returns 28 character hash oI input, but some data is lost to
make reversal diIIicult/impossible. &hashedStringHash(&PlainText);
Page 7
Sheet1
HermiteCubic
Calculates Hermitian Cubic to mimic hand drawn curve -
number array element -
(inX,inY,outX0CoeIIicient,outX1CoeIIicient,outX2CoeIIicie
nt,outX3CoeIIicient) HermiteCubic(&inOutArrayOIDataPointArray);
HideMenuItem
Hides Menu Item - use PrePopup Ior 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);
Hide Makes speciIied Iield invisible - normally Row Init or FCh
|&isOK|Hide(||RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber,
|RecordName.||FieldName);
HistVolatility
Returns the Historical Volatility oI market traded
instrument.
&historicalVolatilityNumberHistVolatility(&ClosingPriceArray,
&TradingDaysPerYear);
Hour Returns the hour (0-23) oI a Time or DateTime &hour24Hour(&TimeValue);
Idiv
Returns the Integer Division result oI BigInteger divided by
DivisorInteger &integerIDiv(&BigInteger, &DivisorInteger);
II Executes statements depending on condition II conditions Then |statements| |Else |statements|| End-II;
InboundPublishXmlDoc
Simulates receiving the message Irom another node, but is
sent Irom this node
&isPublishedInboundPublishXmlDoc(&XmlDoc,
MESSAGE.MessageName, NODE.PublishNodeName |, &IsEnqueued|);
InitChat Starts MCF chat between customer and agent
&chatIDNumberInitChat(&LogicalQueueID, &ApplicationURL,
&CustomerUserName, |&ChatSubject||, &ChatQuestion||, &WizardURL||,
&Priority||, &SkillLevelNumber||, &CostNumber|);
InsertImage
Returns 0 iI JPEG/BMP/DIB image Iile user selects Irom
dialogue is inserted into record Iield OK
&errorNumInsertImage(||RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNum,
|RecordName.|FieldName);
InsertRow
DEPRECATED Inserts row in scroll and executes
RowInsert. II Is Turbo deIault processing only Ior this row.
Use RowSet.InsertRow
|&isOK|InsertRow(||RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNum |, &IsTurbo|);
Int Returns whole integer Irom truncated Iloating point Decimal &integerInt(&Decimal);
Integer
Returns whole integer Irom truncated 32 bit twos-
complement Decimal (-2,147,483,648 to 2,147,483,647) &integerInteger(&Decimal);
IsAlphaNumeric
Returns true iI only alphabetic or textual characters, Ialse iI
any punctuation. &isAlphaNumericIsAlphaNumeric(&string);
IsAlpha
Returns true iI only alphabetic, textual or numeric
characters, Ialse iI any numbers or punctuation. &isAlphaIsAlpha(&string);
IsDateTime
Returns true iI String is date time YYYY-MM-DD
HH24:MI:SS.msmsms &isDateTimeIsDateTime(&String);
IsDate
Returns true iI Value is string YYYY-MM-DD or number
YYYYMMDD &isDateIsDate(&Value);
IsDaylightSavings
Returns true iI DateTime in daylight savings Ior time zone
speciIied by 3 character string e.g. EST or Local or Base &isDaylightSavingsIsDaylightSavings(&DateTime, &TimeZone);
IsDigits
Returns true iI string only contains the numbers 0-9 (decimal
point and signs not included) &isDigitsIsDigits(&String);
IsHidden
DEPRECATED Returns true iI row speciIied is hidden. Use
Row.Visible
&isHiddenIsHidden(||RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNum);
IsMenuItemAuthorized
Returns true iI user is able to access menu item or page
speciIied in action mode (e.g. ActionAdd) speciIied.
&isUserAuthorizedIsMenuItemAuthorized(MENU.MenuName,
BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName
|,&Action|);
IsMessageActive
Returns true iI XmlDoc message is active in Application
Designer &isActiveIsMessageActive(MESSAGE.MessageName);
IsModalComponent Returns true iI run Irom modal component. No eIIect in CI. &isModalComponentIsModalComponent();
IsModalPanelGroup
DEPRECATED Returns true iI run Irom modal component.
Use IsModalComponent &isModalComponentIsModalPanelGroup();
IsModal Returns true iI run Irom modal secondary page. &isCurrentModalIsModal();
IsNumber
Returns true iI String is a valid numeric value (including
signs and decimal points or commas) &isNumberIsNumber(&String);
IsOperatorInClass
DEPRECATED Returns true iI operator in any oI the
classes. Use IsUserInPermissionList &isInClassIsOperatorInClass(&OpClassName1 |, &OpClassName2|...);
IsSearchDialog
Returns true iI executed Irom a search, add or data entry
dialogue box &isSearchDialogIsSearchDialog();
IsTime Returns true iI Value is valid time string or number. Format? &isTimeIsTime(&Value);
IsUserInPermissionList
Returns true iI current user is in one or more oI the
permission lists
&isUserInPLIsUserInPermissionList(&PermissionList1 |,
&PermissionList2|...);
IsUserInRole Returns true iI current user is in one or more oI the roles &isUserInRoleIsUserInRole(&RoleName1 |, &RoleName2|...);
Page 8
Sheet1
LTrim
Returns String with RemoveCharacters removed Irom the
beginning (or blanks iI not speciIied) &trimmedStringLtrim(&String |, &RemoveCharacters|);
LeIt
Returns leItmost Number oI Characters Irom String. Unicode
surrogate pairs treated as pairs oI characters &startLeIt(&String, &NumCharacters);
Len
Returns length oI string. Unicode surrogate pairs treated as
two characters &lengthLen(&String);
Lenb DEPRECATED. No longer supported &lengthLenb(&String);
LinearInterp
Calculates Linear Interpolation oI a set oI 2 points -
number array element -
(inX,inY,outX0CoeIIicient,outX1CoeIIicient,outX2CoeIIicie
nt,outX3CoeIIicient) LinearInterp(&inOutArrayOIDataPointArray);
Ln
Returns the natural logarithm oI Number (based on e -
approximately 2.71828182845904?) &naturalLogLn(&Number);
Local
Declaration oI local variable only having scope in this
PeopleCode program Local DataType &Variable | expression|;
Log10 Returns the base 10 logarithm oI Number &logLog10(&Number);
LogObjectUse
Writes list oI all PeopleCode objects with current count to
the system log LogObjectUse(|&HeadingString|);
Lower Returns MixedCaseString in lower case &lowerCaseStringLower(&MixedCaseString);
MarkPrimaryEmailAddr
ess
Marks the speciIied email address type
(BB,BUS,HOME,OTH,WORK) as the primary email
address Ior the current user MarkPrimaryEmailAddress(&EmailType);
MarkWLItemWorked Marks the current worklist item as worked.(WFl only). &isOKMarkWLItemWorked();
Max
Returns the highest value - string or number (converted to
type oI Value1) &highestMax(&Value1, &Value2 |, &Value3|...);
MessageBox
Returns pressed key constant aIter displaying MessageBox
with Catalogued Message or Alternative Text
|&responseCodeMessageBox(&Style, &Title, &MessageSet,
&MessageNumber, &AltText |, &Param1 |,&Param2|...|);
Min
Returns the lowest value - string or number (converted to
type oI Value1) &lowestMin(&Value1, &Value2 |, &Value3|...);
Minute Returns the minute (0-59) Irom the Time value. &minuteMinute(&Time);
Mod
Returns the remainder aIter the division oI Number by
Divisor &remainderMod(&Number, &Divisor);
Month Returns the month (1-12) oI Date (or DateTime) &monthMonth(&Date);
MsgGetExplainText
Returns the message explain text Irom MessageSet,
MessageNumber aIter Param substitution, AltText iI no
message Iound.
&messageExplainTextMsgGetExplainText(&MessageSet,
&MessageNumber, &AltText |, &Param1 |,&Param2|...|);
MsgGetText
Returns the message text Irom MessageSet, MessageNumber
aIter Param substitution, AltText iI no message Iound.
&messageTextMsgGetText(&MessageSet, &MessageNumber, &AltText |,
&Param1 |,&Param2|...|);
MsgGet
Returns the message text Irom MessageSet, MessageNumber
aIter Param substitution, AltText iI no message Iound.
&messageTextMsgGet(&MessageSet, &MessageNumber, &AltText |,
&Param1 |,&Param2|...|);
NextEIIDt
Returns the value oI the Field in the next eIIective dated row
in this record, iI no more recent record exists will "continue"
iI in loop. &IieldValueNextEIIDt(Field);
NextRelEIIDt
??? Returns the value oI the Return Field in the next related
eIIective dated row in this record, iI no more recent record
exists will "continue" iI in loop. &IieldValueNextRelEIIDt(SearchField, ReturnField,.........);
NodeDelete Deletes Integration Broker node. Best in SPr. &isOKNodeDelete(&NodeName);
NodeRename Renames Integration Broker node. Best in SPr. &isOKNodeRename(&OldNodeName, &NewNodeName);
NodeSaveAs Creates a copy oI Integration Broker node. Best in SPr. &isOKNodeSaveAs(&OldNodeName, &NewNodeName);
NodeTranDelete
Deletes an Integration Broker node transaction and any
transaction modiIier using the transaction. Date Iormat is
YYYY-MM-DD
&isOKNodeTranDelete(&NodeName, &EIIectiveDateString,
&TransactionType, &RequestMessageName, &RequestMessageVersion);
None
Returns true iI no Iields/variables in list contain a value. Ie
are all null, blank strings or 0 in numeric Iields
&isNoValueNone(|RecordName1.|FieldName1 |,
|RecordName2.|FieldName2|...);
NotiIyQ
AIter EnQueue, NotiIyQ gets queue server to recognise new
(non voice/chat) tasks oI Type (email , generic), returns 0 iI
successIul, else message number Irom set 162. &errorCodeNotiIyQ(&LogicalQueueID, &TaskType);
NumberToDisplayString
Returns Number Iormatted as a string - Format oI the
Iorm |Ilags||width||.precision||R , T| |type|
&numberStringNumberToDisplayString(&FormatString, &Number |,
&Width |, &Precision|| );
NumberToString
Returns Number Iormatted as a string - Format oI the
Iorm |Ilags||width||.precision||R , T| |type|
&numberStringNumberToString(&FormatString, &Number |, &Width |,
&Precision|| );
ObjectDoMethodArray
Executes ObjectReIerence.MethodName Ior Component
InterIaces, Application Classes, OLE Automation Objects
using Array as list oI Parameters (so number and type oI
parameters does not have to be deIined at design time)
|&returnValue|ObjectDoMethodArray(&ObjectReIerence,
&MethodName, &ParameterArray);
ObjectDoMethod
Executes ObjectReIerence.MethodName Ior Component
InterIaces, Application Classes, OLE Automation Objects ObjectDoMethod(&ObjectReIerence, &MethodName |, &Param1|... );
ObjectGetProperty Returns ObjectReIerence.PropertyName value
|&returnValue|ObjectGetProperty(&ObjectReIerence, &PropertyName |,
&OleIndexList| );
ObjectSetProperty Sets ObjectReIerence.PropertyName to Value
ObjectSetProperty(&ObjectReIerence, &PropertyName, &Value |,
&OleIndexList| );
Page 9
Sheet1
OnlyOneOrNone
Checks iI only one or none oI the Iields listed are not blank
strings / non-zero in numeric Iields
&isNoMoreThanOneSetOnlyOneOrNone( |RecordName.|FieldName |,
|RecordName2.|FieldName2| ... );
OnlyOne
Returns true iI only one oI the Iields listed are not blank
strings / non-zero in numeric Iields
&isOneSetOnlyOne( |RecordName.|FieldName |,
|RecordName2.|FieldName2| ... );
PanelGroupChanged
DEPRECATED Returns true iI the component (panel group)
data has changed since the last save. Use
ComponentChanged &isChangedPanelGroupChanged();
PingNode
Returns an XML Doc with a node "status" with inIo about
Node Name pinged. &statusXmlDocPingNode(&NodeName);
PriorEIIDt
Returns the value oI the Field in the previous eIIective dated
row in this record, iI no more recent record exists will
"continue" iI in loop. &IieldValuePriorEIIDt(Field);
PriorRelEIIDt
??? Returns the value oI the Return Field in the previous
related eIIective dated row in this record, iI no more recent
record exists will "continue" iI in loop. &IieldValuePriorRelEIIDt(SearchField, ReturnField,.........);
PriorValue
FCh, Fed oI Field ONLY: Returns value in Iield beIore Iield
was changed by user. II used in other PeopleCode programs,
returns current value. &valuePriorValue(Field);
Product
Returns product oI numbers multiplied together. Equivalent
to &product&Number1*&Number2; etc. &productProduct(&Number1 |, &Number2|...);
Prompt
Prompts the user Ior vales that either populate the record or
a group oI variables. OIten used Ior Query prompt values.
|&isOKClicked|Prompt(&Title, &Heading , &Record , , Field1 |,
&Label1 |, &ResponseVar1||...);
Proper
Returns String with Iirst letter oI each word capitalised.
Similar to Oracle SQL InitCap &initialCapitalsProper(&String);
PublishXmlDoc
Returns true iI XML Doc is published as MessageName to
NodeName successIully.
&isOKPublishXmlDoc(&XmlDoc, MESSAGE.MessageName |,
NODE.NodeName| );
PutAttachment
Puts Iile attachment Irom Application Server to File Server
(speciIied in URL Destination)
&errorCodeAddAttachment(&URLDestination,
&DestinationAppendedPathFilename |, &SourceFile |,
&PreserveCaseBoolean|| );
Quote
Returns String as a quoted SQL string - single quotes
replaced with two single quotes, surrounded by single quotes &quotedStringQuote(&String);
RTrim
Returns String with RemoveCharacters removed Irom the
end (or blanks iI not speciIied) &trimmedStringRtrim(&String |, &RemoveCharacters|);
Radians Returns angle in radians Irom degrees &radiansRadians(&degrees);
Rand Returns a random number 0 Random Number 1 &randomNumberRand();
ReSubmitPubHeaderXm
lDoc
Returns true iI the untransIormed message is resubmitted
OK
&isOKReSubmitPubHeaderXmlDoc(&PublisherID, &PublishNode,
&ChannelName, &VersionName);
ReSubmitPubXmlDoc Returns true iI the transIormed message is resubmitted OK
&isOKReSubmitPubXmlDoc(&PublisherID, &PublishNode,
&ChannelName, &VersionName, &MessageName, &SubscriptionNode);
ReSubmitSubXmlDoc
Returns true iI the subscribed message is resubmitted OK.
Subscription PeopleCode is rerun.
&isOKReSubmitSubXmlDoc(&PublisherID, &PublishNode,
&ChannelName, &VersionName, &MessageName, &SubscriptionName);
ReValidateNRXmlDoc
Revalidates a non-repudiation message signed by
EntityName (in PS this is NodeName), returns true iI
validation successIul &isOKReValidateNRXmlDoc(&MessageID, &EntityName);
RecordChanged
DEPRECATED Returns true iI any data in the speciIied row
has changed. Use &Row.IsChanged
&isChangedRecordChanged(RECORD.RecordName ,
RecordName.FieldName , |RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber} );
RecordDeleted
DEPRECATED Returns true iI the speciIied row has been
deleted. Use &Row.IsDeleted
&isDeletedRecordDeleted(RECORD.RecordName ,
RecordName.FieldName , |RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber} );
RecordNew
DEPRECATED Returns true iI the speciIied row has been
inserted. Use &Row.IsNew
&isNewRecordNew(RECORD.RecordName , RecordName.FieldName ,
|RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber} );
ReIreshTree
DEPRECATED Updates a dynamic tree. Use GenerateTree
or Tree Viewer ReIreshTree(RECORD.RecordName);
RelNodeTranDelete Returns true iI transaction modiIier deleted OK.
&isOKRelNodeTranDelete(&RelationshipId , &SourceTransactionType,
&SourceNode, &SourceRequestMessageName,
&SourceRequestMessageVersion, &TargetNode,
&TargetRequestMessageName, &TargetRequestMessageName,
&TargetRequestMessageVersion);
RemoteCall
Calls Tuxedo service normally Ior COBOL. COBOL
DispatcherName is PSRCCBL.Parameter PSCOBOLPROG
gives name oI COBOL program.
RemoteCall(&DispatcherName |, &ServiceVariable1, &ServiceValue1|... |,
&UserVariable1, &UserValue1|... );
RemoveDirectory
Removes directory. PathType (FilePathRelative
, FilePathAbsolute) add on RemoveSubtree
or RemoveDirectory RemoveDirectory(&Path |, &PathType | &SubtreeRemoval||);
RenameDBField
Returns MDASuccess iI renames Iield OK (as per App
Designer rename). Note view SQL and SQLExec will need
to be Iixed. II ReIerences Only, then Iield is not renamed, but
reIerences are changed (useIul Ior customisations that are
patched)
&errorCodeRenameDBField(FIELD.NewFieldName,
FIELD.OldFieldName |, &isReIerencesOnly| );
Page 10
Sheet1
RenamePage
Returns MDASuccess iI renames page OK (as per App
Designer rename). &errorCodeRenamePage(PAGE.NewPageName, PAGE.OldPageName);
RenameRecord
Returns MDASuccess iI renames page OK (as per App
Designer rename).
&errorCodeRenameRecord(RECORD.NewRecordName,
RECORD.OldRecordName);
Repeat
Statements are executed at least once. BooleanExpression is
evaluated and iI Ialse, statements are executed until the
expression gives true Repeat statements; until &BooleanExpression;
Replace
Returns replaced characters in String Irom Start Position Ior
Number Characters with New Text
&changedStringReplace(&String, &StartPosition, &NumberCharacters,
&NewString);
Rept Returns String repeated Repeat Number oI times. &repeatedStringRept(&String, &RepeatNumber);
ReturnToServer
Responds to server all nodes published or subscribed, no
nodes, nodes in node array or XmlDoc/Message response
ReturnToServer( &isAllNodesReturned , &NodeArray , &XmlDoc ,
&Message} );
Return
This returns Irom a Iunction. Value is returned value oI
Iunction. Return |&Value|;
RevalidatePassword
Returns 0 iI password is entered in window is user's correct
password. Think Time Function &errorCodeRevalidatePassword();
Right
Returns the last Number Characters (or the last character iI
number omitted) oI String. Unicode surrogate pairs treated
as pairs oI characters &endString(&String |, &NumberCharacters| );
RoundCurrency
Returns Amount rounded as per PSCURRENCYCDTBL
on that EIIective Date &roundedAmountRoundCurrency(&Amount, &CurrencyCd, &EIIdt);
Round Returns Number rounded to Decimal Places &roundedNumberRound(&Number, &DecimalPlaces);
RowFlush
DEPRECATED Removes a speciIic row Irom a page scroll
and component buIIer not database. Use RowSet.FlushRow
RowFlush(|RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber);
RowScrollSelectNew
DEPRECATED Loads speciIied scroll Irom 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|);
RowScrollSelect
DEPRECATED Loads speciIied scroll Irom 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|);
SQLExec
Executes SQL statement, iI 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|...);
ScheduleProcess DESUPPORTED Schedules process
ScheduleProcess(&ProcessType, &ProcessName |, &RunLocation| |,
&RunCntlID| |, &ProcessInstance| |, &RunDateTime| |, &RecurName| |,
&ProcessServerName|);
ScrollFlush
DEPRECATED Removes all rows Irom a page scroll and
component buIIer not database. Use RowSet.Flush
ScrollFlush(|RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName);
ScrollSelectNew
DEPRECATED Loads speciIied scroll Irom 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|);
ScrollSelect
DEPRECATED Loads speciIied scroll Irom 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|);
Second Returns seconds (0-59) part oI time value &secondsSecond(&Time);
SendMail Returns 0 iI email successIully sent
&errorCodeSendMail(&PlatIormFlags, &To, &Cc, &Bcc, &Subject,
&Text|, &AttachmentFilenames||, &AttachmentTitles||, &From||,
&ToSeparator||, &ContentType||, &ReplyTo||, &Sender|);
SetAuthenticationResult
In Sign On PeopleCode, sets iI logon successIul and iI
password warning/expiry messages should be shown to user
&isOKSetAuthenticationResult(&AuthenticationResult |, &OperatorId|
|,&ResultDocument| |,&isPasswordExpired| |&DaysBeIoreExpiryWarn|);
SetChannelStatus Sets an integration broker channel status (1Run, 2Pause) &isOKSetChannelStatus(&ChannelName, &StatusNumber);
SetComponentChanged
Sets the component changed Ilag, so Save processing is
triggered. This is automatically set iI a Iield is changed. SetComponentChanged();
SetControlValue
Puts speciIied value into the GUI control instead oI value
Irom buIIer. Used Ior specialised validation. Does not run in
CI.
SetControlValue(&Value, &PageName, &PageFieldName |,
&RowNumber||, &FieldObject|);
SetCursorPos Puts cursor in speciIied Iield
SetCursorPos(PAGE.PageName , Page},
||RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName|, |&RecordName.|&FieldName,
&TargetRowNumber);
SetDBFieldAuxFlag
Returns MDASuccess iI AuxMaskFlagNumber (1-32) on
Field is changed successIully to True or False accordingly.
&errorCodeSetDBFieldAuxFlag(FIELD.FieldName,
&AuxMaskFlagNumber, &setToTrue);
Page 11
Sheet1
SetDBFieldCharDeIn
Returns MDASuccess iI Iield Iormat is changed.
FormatFamilyNumber example: FormatFamilyTypeSSN
&errorCodeSetDBFieldCharDeIn(FIELD.FieldName, &LengthNumber
|,&FormatFamilyNumber|);
SetDBFieldFormatLengt
h
Returns MDASuccess iI character Iield Iormat length is
changed to LengthNumber characters. Does not require
rebuild.
&errorCodeSetDBFieldFormatLength(FIELD.FieldName,
&LengthNumber);
SetDBFieldFormat
Returns MDASuccess iI character Iield with
LengthNumber characters. FormatFamilyNumber
example: FormatFamilyTypeMixedCase
&errorCodeSetDBFieldFormat(FIELD.FieldName
,&FormatFamilyNumber |,&FamilyName, &DisplayName|);
SetDBFieldLabel
Returns MDASuccess iI character Iield label is changed
or inserted.
&errorCodeSetDBFieldLabel(FIELD.FieldName, &LabelId, &LongLabel,
&ShortLabel, &DeIault |, &LanguageCode|);
SetDBFieldLength
Returns MDASuccess iI character length is changed to
LengthNumber characters. Requires table rebuild. &errorCodeSetDBFieldLength(FIELD.FieldName, &LengthNumber);
SetDBFieldNotUsed
Returns MDASuccess iI Iield is changed to not used - not
put in indexes, nVision or Query &errorCodeSetDBFieldNotUsed(FIELD.FieldName, &isNotUsed);
SetDeIaultAll
Returns true iI sets all instances oI the Iield in the scroll to
null value which will cause deIault processing, when next
checked. |&isOK|SetDeIaultAll(|RecordName.|FieldName);
SetDeIaultNextRel
Sets related, deIaulted Iield on the next eIIective dated
control Iield to null value which will cause deIault
processing, when next checked. SetDeIaultNextRel(ControlFieldName,DeIaultedFieldName);
SetDeIaultNext
Sets next eIIective dated Iield to null value which will cause
deIault processing, when next checked. SetDeIaultNext(|RecordName.|FieldName);
SetDeIaultPriorRel
Sets related, deIaulted Iield on the previous eIIective dated
control Iield to null value which will cause deIault
processing, when next checked. SetDeIaultPriorRel(ControlFieldName,DeIaultedFieldName);
SetDeIaultPrior
Sets previous eIIective dated Iield to null value which will
cause deIault processing, when next checked. SetDeIaultPrior(|RecordName.|FieldName);
SetDeIault
Returns true iI sets Iield to null value which will cause
deIault processing, when next checked. |&isOK|SetDeIault(|RecordName.|FieldName);
SetDisplayFormat
DEPRECATED Changes the custom deIined display Iield
Iormat. Use Field.DisplayFormat
&isOKSetDisplayFormat(|RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber,
|RecordName.|FieldName, &DisplayFormatName);
SetLabel
DEPRECATED Changes the label Ior the Iield. Use
Field.Label
|&isOK|SetLabel(|RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber,
|RecordName.|FieldName, &LabelText);
SetLanguage
Sets user interIace and data language code Ior this session.
Language Code must be a translate value oI
LANGUAGECD. Not in Sign on PeopleCode |&isOK|SetLanguage(&LanguageCd);
SetMessageStatus
Sets message status to IBStatusActive
or IBStatusInActive &isOKSetMessageStatus(MESSAGE.MessageName, &StatusNumber);
SetNextPage Returns true iI next page (F6/TransIerPage) is set to Page |&isOK|SetNextPage(&PageName);
SetNextPanel
DEPRECATED Returns true iI next page (F6/TransIerPage)
is set to Page. Use SetNextPage |&isOK|SetNextPanel(&PageName);
SetPageFieldPageFieldN
ame
Returns MDASuccess iI PageFieldName is set
successIully.
&errorCodeSetPageFieldPageFieldName(PAGE.PageName,
RECORD.RecordName, FIELD.FieldName, &PageFieldName);
SetPasswordExpired
Returns old value oI password expired and sets to new Is
Password Expired boolean value &isOKSetPasswordExpired(&isPasswordExpired);
SetPostReport
Returns a reIerence to a PostReport object Ior posting Iiles to
the Report Repository using postReport.Put &postReportSetPostReport();
SetReEdit
Sets re-edit mode on/oII to run Fed, check translate and
prompt table edits on all Iields on component as though the
entries were all new. SetReEdit(&isReEdit);
SetRecFieldEditTable
Returns MDASuccess iI Record Field edits are changed
to EditTable and EditType (e.g. EditTableTypePrompt)
successIully.
&errorCodeSetRecFieldEditTable(RECORD.RecordName,
FIELD.FieldName, &EditTableName |, &EditTypeNumber|);
SetRecFieldKey
Returns MDASuccess iI Record Field is changed to being
a key successIully.
&errorCodeSetRecFieldKey(RECORD.RecordName, FIELD.FieldName,
&isKey);
SetSearchDeIault
Populates search dialog box Iield with Application Designer
deIault, but does not run FDe SetSearchDeIault(|RecordName.|FieldName);
SetSearchDialogBehavio
r
SIn: Makes search dialog either skip iI possible (Force
Number0) or Iorce dialog display (1) SetSearchDialogBehavior(&ForceNumber);
SetSearchEdit
DEPRECATED Sets edits on Ior a search dialog Iield. Use
Field.SearchEdit &isOKSetSearchEdit(|RecordName.|FieldName);
SetTempTableInstance
Sets the temporary table deIault instance number and returns
the previous one (Ior resetting later). Used by Table and
SQL Iunctions on Temporary Tables.
&oldTableInstanceNumberSetTempTableInstance(&NewTableInstanceNu
mber);
SetTracePC
Sets PeopleCode trace to number speciIed
e.g. TracePCEachStmt (2048) SetTracePC(&TraceSettingNumber);
SetTraceSQL
Sets SQL trace to number speciIied
e.g. TraceSQLStatements TraceSQLVariables SetTraceSQL(&TraceSettingNumber);
SetUserOption
Returns true iI speciIied user option deIault is set to new
value
&isOKSetUserOption(&OptionCategoryLevel, &OptionName,
&DeIaultValue);
SetupScheduleDeInItem Returns a new process request object Ior a Scheduled JobSet
&processRequestSetupScheduleDeInItem(&ProcessTypeName,
&JobName);
Page 12
Sheet1
Sign
Returns 1 iI number positive, -1 iI negative and zero iI
number is zero &signNumberSign(&Number);
Sin Returns the sine (-1 to 1) oI the angle Radians &sineSin(&Radians);
SinglePaymentPV
Returns Iuture value oI monetary unit aIter Number OI
Periods at Interest Rate &unitValueSinglePaymentPV(&InterestRate, &NumberOIPeriods);
SortScroll
DEPECATED Sorts the scroll by list oI Iields 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 oI strings Iound in Big String cut up by
(not including) Separator (or space). II Big String ends in
Separator, no empty string added to array at end &stringArraySplit(&BigString |, &Separator|);
Sqrt
Returns the square root oI Number. II Number negative,
displays error. &squareRootsqrt(&Number);
StartWork
Starts a transaction in which no updates are saved until a
CommitWork StartWork();
StopFetching
RSe only. Makes this the last row to be added to the database
buIIer and stops any Iurther Ietches Irom DB StopFetching();
StoreSQL
Stores SQL (like App Designer) with DB Type (AppServer ,
DB2 , DB2Unix , InIormix , MicrosoIt , Oracle , Sybase) and
EIIDt (Date type) and 4 char Owner
StoreSQL(&SqlStatement, SQL.SqlName |,&DBType |,&EIIDt |,&Owner
|,&Description||||);
String
Converts number to string. Numbers maybe represented
diIIerently across platIorms. II you want to be Iussy, use
NumberToString &stringString(&Value);
Subrecords .........
Substitute
Replaces every occurrence oI OldSubString with
NewSubString. Tilde (~) means one or more spaces. &resultStringSubstitute(&String, &OldSubString, &NewSubString);
Substring
Returns Partial String by taking Number OI Characters Irom
Start Position oI String. Unicode character pairs could get
split.
&partialStringSubstring(&String, &StartPosition,
&NumberOICharacters);
Substringb DEPRECATED Use SubString
&partialStringSubstringb(&String, &StartPosition,
&NumberOICharacters);
SwitchUser
Switches user by User/Pass or by Authentication Token.
Calls SignOn PeopleCode.
&isOKSwitchUser(&User, &Password, &AuthenticationToken,
&Base64ExternalAuthentication);
SyncRequestXmlDoc
Returns Response when command sends unstructured
XmlDocument synchronously
&ResponseXmlDocumentSyncRequestXmlDoc(&XmlDocument,
MESSAGE.MessageName|, NODE.NodeName|);
Tan Returns the tangent value (0-lots) oI the angle in Radians &tangentTan(&Radians);
Then Executes statements depending on condition II conditions Then |statements| |Else |statements|| End-II;
Throw Throws an exception using the speciIied Exception object Throw &ExceptionObject;
Time3
Creates a Time value Irom Hour (0-23), Minutes (0-59),
Seconds (0-59.999999) &timeValueTime3(&Hours, &Minutes, &Seconds);
TimePart Returns the Time value Irom a DateTime &timeValueTimePart(&DateTimeValue);
TimeToTimeZone
Returns IromTime converted by time zone speciIied by 3
character string e.g. EST or Local or Base
&dateTimeTimeToTimeZone(&IromTime, &IromTimeZone,
&toTimeZone);
TimeValue
Creates a Time value Irom String in Iormat
HH:MM:SS|:SSSSSS| &timeValueTimeValue(&String);
TimeZoneOIIset
Returns the oIIset (/-hh:mm) oI Date Time Irom GMT.
TimeZone can be a TZ value or Local or Base &oIIsetStringTimeZoneOIIset(&DateTime |,&TimeZone| );
TimeZone .........
Time
Creates a Time value Irom Number in Iormat
HHMMSS|.SSSSSS| &timeValueTime(&Number);
TotalRowCount
Returns the total number oI rows in the scroll including
deleted rows
&numberRowsTotalRowCount(|RECORD.Level1RecordName,
&Level1Row, |RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName);
TransIerExact
TransIers to page with action (A , U , L , C , E). Current
keys are added to Key Fields and searched using equals.
Search dialog shown iI not a single row selected
TransIerExact(&IsNewWindow, MENU.MenuName,
BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName,
&Action |, |RecordName1.|KeyFieldName1...| |, &IsAutoSearch| );
TransIerMobilePage TransIers to the speciIied Mobile Page Detail View.
TransIerMobilePage( |MOBILEPAGE.|PageName, &TabNumber,
&CiObject);
TransIerNode
TransIers 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 iI not a single
row selected
|&isOK|TransIerNode(&IsNewWindow, NODE.NodeName,
MENU.MenuName, MARKET.MarketName, BARNAME.BarName,
ITEMNAME.ItemName, PAGE.PageName, &Action |,
|RecordName1.|KeyFieldName1...|);
TransIerPage
Terminates current PeopleCode and transIers to page within
current component (iI none speciIied uses one set by
SetNextpage). Ignored in CI. |&isOK|TransIerPage(|PAGE.PageName|);
TransIerPanel DEPRECATED. Use TransIerPage |&isOK|TransIerPanel(|PANEL.PageName|);
TransIerPortal
TransIers 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 iI not a single row
selected
|&isOK|TransIerPortal(&IsNewWindow, PORTAL.PortalName,
NODE.NodeName, MENU.MenuName, MARKET.MarketName,
BARNAME.BarName, ITEMNAME.ItemName, PAGE.PageName,
&Action |, |RecordName1.|KeyFieldName1...|);
TransIer
TransIers to page with action (A , U , L , C , E). Current
keys are added to Key Fields and searched using LIKE.
Search dialog shown iI not a single row selected
TransIer(&IsNewWindow, MENU.MenuName, BARNAME.BarName,
ITEMNAME.ItemName, PAGE.PageName, &Action |,
|RecordName1.|KeyFieldName1...| |, &IsAutoSearch| );
TransIormExCache
Returns the well-Iormed XML Doc transIormed by the
XSLT File (which is cached Ior speedy multiple calls) -
never null
&resultXmlStringTransIormExCache(&XmlDoc, &XsltFileName,
&XsltCacheKey);
Page 13
Sheet1
TransIormEx
Returns the well-Iormed XML String transIormed by the
XSLT String - null iI unsuccessIul &resultXmlStringTransIormEx(&XmlString, &XsltString);
TransIorm
Returns XML Document transIormed by AE program, never
Null.
&resultXmlDocTransIorm(&XmlString , &XmlDoc}, AEProgram,
&StartNodeName, &StartMessageName, &StartMessageVersion,
&ResultNodeName, &ResultMessageName, &ResultMessageVersion);
TreeDetailInNode
Not PIA??? Checks iI value in FieldName is under the
HighLevelNodeName in the speciIied tree
&isDescendantTreeDetailInNode(&TreeSetID, &TreeName, &TreeEIIdt,
RecordName.FieldName, &HighLevelNodeName);
TriggerBusinessEvent
Triggers workIlow on the business event. II unsuccessIul,
will rollback errors up to trigger, but updates aIter will be
commited iI not stopped!
&isOKTriggerBusinessEvent(BUSPROCESS.BusinessProcessName,
BUSACTIVITY.ActivityName, BUSEVENT.BusinessEventName);
Truncate
Returns Number truncated to Number OI Digits aIter the
decimal point &truncatedNumberTruncate(&Number, &NumberoIDigits);
Try
Creates a block where statements can error and these are
handled.
Try statementsSandbox; Catch exceptionSubClass &Exception
errorHandlingStatements; End-Try;
UnCheckMenuItem DEPRECATED Unchecks the Windows client menu item
UnCheckMenuItem(BARNAME.MenuBarName,
ITEMNAME.MenuItemName);
Unencode
Returns decoded URL String Irom encoded string according
to W3C rules with HTTP xx &plainUrlStringUnencode(&EncodedUrlString);
Ungray Switches the Iield to be changeable on the page.
|&isOK|Ungray(||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);
Unhide Makes speciIied Iield visible - normally Row Init or FCh
|&isOK|Unhide(||RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber,
|RecordName.||FieldName);
UniIormSeriesPV
Returns value oI single unit aIter uniIorm series oI payments
at Interest Rate &unitValueUniIormSeriesPV(&InterestRate, &NumberOIPeriods);
Until
Statements are executed at least once. BooleanExpression is
evaluated and iI Ialse, statements are executed until the
expression gives true Repeat statements; until &BooleanExpression;
UpdateSysVersion
PeopleTools Only. Returns version number Ior co ordinating
changes to system tables e.g. Message Catalogue &versionNumberUpdateSysVersion();
UpdateValue Updates speciIied Field with Value. Use Field.Value
UpdateValue(|RECORD.Level1RecordName, &Level1Row,
|RECORD.Level2RecordName, &Level2Row, ||
RECORD.TargetRecordName, &TargetRowNumber, &Value);
UpdateXmlDoc Updates message in queue with speciIied version
&isOKUpdateXmlDoc(&XmlDocument, &PublishId,
&PublishNodeName, &ChannelName, &VersionName|, &MessageName|,
&SubNode||);
Upper Returns the Mixed Case String in Upper Case &uppercaseStringUpper(&MixedCaseString);
Value Returns String converted to a number &numberValue(&String);
ViewAttachment Returns 0 iI attachment successIully shown
&errorCodeViewAttachment(&IromURL , URL.UrlName},
&DestinationAppendedPathFilename, &ClientFile |, &IsNewWindow |,
&PreserveCaseBoolean||);
ViewContentURL Creates new browser window showing URL speciIied ViewContentURL(&UrlString , URL.UrlName});
ViewURL
Views URL in current browser window or launches deIault
browser to view ViewURL(&UrlString , URL.UrlName} |, &IsNewWindow|);
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 (1Sunday, 7Saturday) oI the day oI the
week Ior Date &dayNumberWeekday(&date);
When-Others Evaluate branches depending on conditions on Value Evaluate &Value When ... End-evaluate
When Evaluate branches depending on conditions on Value Evaluate &Value When ... 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 Iile iI Severity
is less than Log Fence set WriteToLog(&SeverityNumber, &Message);
Year Returns the year (1900 - 2078) Irom the Date value &yearNumberYear(&Date);
Page 14